Halo API

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

✓ Official Vendor SpecMediaContent DeliveryapiKey22 EndpointsREST

For Agents

Pull Halo 5 player service records, match details, leaderboards, company stats, and player profile assets for community and esports tooling.

Connect the Halo API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Halo 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 API API.

Fetch the full match details for a Halo 5 match by match id

Retrieve a player's recent matches with map, mode, and outcome

Pull arena, warzone, and custom service records for one or more players

Read company stats and roster for a Halo 5 company by id

GET STARTED

Start building with Halo API API

Explore with Jentic

View OpenAPI Document

The Halo API (deprecated production endpoint) provided structured access to Halo 5: Guardians game data including match details, player service records for arena, warzone, and custom modes, leaderboards, company stats, and a curated set of metadata, profile, and stats endpoints. This consolidated spec exposes 22 operations across stats, metadata, and profile groups for fan sites, esports trackers, and Halo community tools. Note that 343 Industries has deprecated this title-specific API as Halo 5 services have wound down.

Use Cases

Patterns agents use Halo API API for, with concrete tasks.

★ Esports Match Recap Generator

Generate match recap pages from Halo 5 match details. The agent fetches /stats/h5/matches/{matchId} for each event, pulls per-player stats, and renders a Markdown recap with kill counts, medals earned, and map-specific outcomes. Fan sites and tournament organisers used this to publish recaps within minutes of a match finishing.

GET /stats/h5/matches/{matchId} for the match id and emit a Markdown recap listing each player's score, kills, deaths, and top three medals.

Player Stats Dashboard

Power a personal Halo 5 stats dashboard by combining service records and recent matches. The agent calls /stats/h5/players/{player}/matches for activity and the arena, warzone, and custom service-record endpoints for cumulative stats. The result is a single page showing K/D, win rate, and recent match history per player.

GET /stats/h5/servicerecords/arena and /stats/h5/players/Player1/matches and combine the result into a dashboard payload.

Leaderboard Tracker

Track CSR leaderboard movement across a season for a chosen playlist. The agent polls /stats/h5/player-leaderboards/csr/{seasonId}/{playlistId} on a schedule, diffs against the previous snapshot, and posts movement (rank up, rank down, new entries) to a Discord channel. Useful for competitive Halo communities and coaching groups.

GET /stats/h5/player-leaderboards/csr/{seasonId}/{playlistId} for the current season and emit the top 100 with delta versus the snapshot saved 24 hours ago.

Spartan Profile Card Generator

Build a profile-card image for a player using their Halo 5 emblem and Spartan render. The agent calls /profile/h5/profiles/{player}/emblem and /profile/h5/profiles/{player}/spartan to retrieve image assets, composites them with the player's gamertag, and returns a shareable PNG. Useful for community sigs and tournament programmes.

GET /profile/h5/profiles/Player1/emblem and /profile/h5/profiles/Player1/spartan and return the asset URLs for image composition.

Agent Discovery Through Jentic

Halo community agents search Jentic with intents like 'get halo player service record' and Jentic returns the matching operation with its input schema. The agent invokes the call without writing custom HTTP code. The Ocp-Apim-Subscription-Key stays in the Jentic vault.

Use Jentic search 'halo player service record' to find /stats/h5/servicerecords/arena and execute it for a list of three player gamertags.

Key Endpoints

22 endpoints — the halo api (deprecated production endpoint) provided structured access to halo 5: guardians game data including match details, player service records for arena, warzone, and custom modes, leaderboards, company stats, and a curated set of metadata, profile, and stats endpoints.

METHOD

PATH

DESCRIPTION

GET

/stats/h5/matches/{matchId}

Fetch full match details by match id

GET

/stats/h5/players/{player}/matches

List a player's recent matches

GET

/stats/h5/servicerecords/arena

Read arena service records for one or more players

GET

/stats/h5/servicerecords/warzone

Read warzone service records

GET

/stats/h5/player-leaderboards/csr/{seasonId}/{playlistId}

Read the CSR leaderboard for a playlist and season

GET

/metadata/h5/metadata/maps

List all Halo 5 maps

GET

/profile/h5/profiles/{player}/emblem

Get the player's emblem image URL

GET

/stats/h5/matches/{matchId}

Fetch full match details by match id

GET

/stats/h5/players/{player}/matches

List a player's recent matches

GET

/stats/h5/servicerecords/arena

Read arena service records for one or more players

GET

/stats/h5/servicerecords/warzone

Read warzone service records

GET

/stats/h5/player-leaderboards/csr/{seasonId}/{playlistId}

Read the CSR leaderboard for a playlist and season

Why though Jentic?

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

Credential isolation

The Halo 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 service record' or 'halo match details' and receive the matching operation with its input schema, so the agent calls the right endpoint without browsing the developer portal.

Time to first call

Direct Halo API integration: half a day to a day to handle subscription auth, gamertag encoding, and metadata cross-references. Through Jentic: under thirty minutes to search, load, and execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

Halo Metadata API

Pure metadata catalogue for maps, weapons, medals, vehicles, and ranks across Halo 5 and Halo Wars 2.

Use the Metadata API alongside the consolidated Halo API when you only need game catalogue lookups.

Complementary

Halo Profile API

Player profile assets - emblem, appearance, and Spartan render.

Use the Profile API alongside the consolidated Halo API when you only need profile imagery rather than stats.

Alternative

Riot Games API

Equivalent player stats and match data for League of Legends, Valorant, and TFT.

Pick Riot Games when the agent supports a different competitive title rather than Halo.

FAQs

Specific to using Halo API API through Jentic.

What authentication does the Halo API use?

The Halo API uses an Azure API Management subscription key passed as the Ocp-Apim-Subscription-Key header (or as a subscription-key query parameter). Through Jentic, this key is stored encrypted in the vault and injected at execution time so the agent never holds the raw subscription key.

Is the Halo API still active?

The 343 Industries Halo API for Halo 5 is deprecated and the production server is marked as such in the spec. It still serves historical data for fan tools but no new feature work or matchmaking telemetry is shipping. For Infinite-era games, refer to the modern Halo Waypoint endpoints which are not part of this spec.

Can I get a player's recent Halo 5 matches?

Yes. GET /stats/h5/players/{player}/matches returns the recent match list for the gamertag, paginated by start and count parameters. Each entry returns a match id which you can pass to /stats/h5/matches/{matchId} to expand into the full per-player breakdown.

How do I read the CSR leaderboard for a playlist?

GET /stats/h5/player-leaderboards/csr/{seasonId}/{playlistId} returns the season-end CSR leaderboard rows for a specific playlist. Pair with the /metadata/h5/metadata/playlists endpoint to discover valid playlist ids and human-readable labels.

What rate limits apply to the Halo API?

Limits are tied to the API Management subscription tier on the Azure-fronted developer portal. Free keys are heavily rate-limited; commercial tiers receive higher quotas. The API returns 429 Too Many Requests on overage, and the Retry-After header indicates back-off seconds.

How do I use the Halo API with AI agents through Jentic?

Run pip install jentic, then search 'halo player service record' to find /stats/h5/servicerecords/arena. Load and execute it with a list of player gamertags. Sign up at https://app.jentic.com/sign-up to get an agent key.