Halo Profile API

Name: Halo Profile API API
Brand: Halo Profile API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentMediaImage ProcessingapiKey3 EndpointsREST

For Agents

Fetch Halo 5 player imagery - emblem, appearance, and Spartan render - by gamertag for use in profile cards and match recaps.

Connect the Halo Profile API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Halo Profile API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Halo Profile API API.

Get the emblem image URL for a Halo 5 player by gamertag

Retrieve a player's appearance image

Fetch the rendered Spartan model image for a player

Request a specific image size via the size query parameter

GET STARTED

Start building with Halo Profile API API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for Halo Profile API, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for Halo Profile API, keeping it validated and agent-ready. The Halo Profile API serves a small set of player imagery endpoints for Halo 5: Guardians: a player's emblem, the appearance image, and a rendered Spartan model. Agents use it to display a player's identity in match recaps, leaderboards, profile cards, and community signatures. Image dimensions can be requested via query parameters.

★ Profile Card Generator

Build profile-card images for community signatures and tournament programmes by combining the player's emblem and Spartan render. The agent fetches /h5/profiles/{player}/emblem and /h5/profiles/{player}/spartan, composites them with gamertag and stats text, and emits a shareable PNG. Halo community sites used this for sigs and stream overlays.

GET /h5/profiles/Player1/emblem and /h5/profiles/Player1/spartan and return both image URLs for downstream compositing.

Leaderboard Avatar Hydration

Decorate a CSR leaderboard with each player's emblem thumbnail. The agent walks the leaderboard rows from the Halo stats API, calls /h5/profiles/{player}/emblem with size=64 for each, and emits an avatar URL beside each row. Useful for esports broadcast graphics.

For each gamertag in a leaderboard payload, GET /h5/profiles/{player}/emblem and emit the thumbnail URL alongside the row.

Match Recap Embed

Embed each match participant's appearance image in the recap renderer to produce a Halo Waypoint-style match summary. The agent calls /h5/profiles/{player}/appearance for each participant and inlines the URL into the recap markup. The result mirrors the official post-game UI.

GET /h5/profiles/Player1/appearance and embed the returned image URL in the match recap.

Agent Discovery Through Jentic

Halo community agents discover the profile imagery operations through Jentic by searching for intents like 'halo player emblem image'. Jentic returns the matching GET operation with its input schema. The Ocp-Apim-Subscription-Key stays in the Jentic vault.

Use Jentic search 'halo player emblem' to find GET /h5/profiles/{player}/emblem and execute it for gamertag 'Player1'.

Key Endpoints

3 endpoints — jentic publishes the only available openapi specification for halo profile api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/h5/profiles/{player}/emblem

Get the player's emblem image URL

GET

/h5/profiles/{player}/appearance

Get the player's appearance image URL

GET

/h5/profiles/{player}/spartan

Get the rendered Spartan model image URL

GET

/h5/profiles/{player}/emblem

Get the player's emblem image URL

GET

/h5/profiles/{player}/appearance

Get the player's appearance image URL

GET

/h5/profiles/{player}/spartan

Get the rendered Spartan model image URL

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

The Halo Profile Ocp-Apim-Subscription-Key is stored encrypted in the Jentic vault. Agents receive scoped access tokens at execution time and never see the raw subscription key.

Intent-based discovery

Agents search Jentic for 'halo player emblem' or 'halo spartan render' and receive the matching profile operation with its input schema. No URL building required.

Time to first call

Direct integration: under an hour because the surface is only three endpoints. Through Jentic: under five minutes - search, load, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

Halo API

Stats and match data that pair with profile imagery for full recaps.

Use the Halo API to fetch match details and service records, then call the Profile API to add player imagery.

Complementary

Halo Metadata API

In-game catalogue lookups for maps, weapons, medals, and cards.

Pair with Metadata when a profile card includes a 'recent matches' strip that needs map and medal labels.

Alternative

Riot Games API

Player profile and icon endpoints for Riot Games titles.

Pick Riot Games when building profile cards for League of Legends or Valorant rather than Halo.

FAQs

Specific to using Halo Profile API API through Jentic.

Why is there no official OpenAPI spec for Halo Profile API?

343 Industries does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Halo Profile API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Halo Profile API use?

The API uses an Azure API Management subscription key passed as the Ocp-Apim-Subscription-Key header or the subscription-key query parameter. Through Jentic, the key is encrypted in the vault and injected at execution time so the agent does not handle it directly.

Can I request a specific image size for the Halo emblem?

Yes. The /h5/profiles/{player}/emblem and /h5/profiles/{player}/spartan endpoints accept a size query parameter (in pixels) to scale the returned image. Useful for thumbnail strips on leaderboards and full-resolution sigs.

How do I fetch the Spartan render for a player?

GET /h5/profiles/{player}/spartan with the player's gamertag in the path. The response is the image URL (or a redirect to the asset). Pair with the emblem and appearance endpoints when building a complete profile card.

How do I batch-fetch emblems for a leaderboard through Jentic?

Run pip install jentic, then search 'halo player emblem' to find GET /h5/profiles/{player}/emblem. Iterate over the leaderboard gamertags, executing the operation for each, and respect 429 responses by backing off.

What rate limits apply to the Halo Profile API?

Rate limits are tied to the Azure subscription tier on the developer portal. Free keys are heavily limited; commercial tiers receive higher quotas. The endpoints return 429 with a Retry-After header when exceeded.