Stats

Name: Stats API
Brand: Stats
Availability: InStock

★ Only Publicly Available OpenAPI DocumentMediaContent DeliveryapiKey28 EndpointsREST

For Agents

Look up Halo 5 and Halo Wars 2 player stats, match results, leaderboards, and service records using a developer subscription key.

Connect the Stats to your agent

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

Retrieve Halo 5 arena, warzone, custom, and campaign match results by match ID

Pull a player's match history across Halo 5, Halo 5 PC, and Halo Wars 2

Read player service records broken down by arena, warzone, custom, and campaign modes

Fetch player and company commendation progress for Halo 5

GET STARTED

Start building with Stats API

Explore with Jentic

View OpenAPI Document

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

The Halo Stats API exposes player and match statistics from Halo 5: Guardians and Halo Wars 2 across arena, warzone, custom, and campaign game modes. It returns match results, player service records, leaderboards, company data, and per-match event timelines suitable for tracker sites, esports tooling, and community dashboards. Authentication uses an Ocp-Apim-Subscription-Key header issued by the Halo developer portal. The API covers 28 read-only endpoints scoped to the Halo 5 and Halo Wars 2 titles only.

Use Cases

Patterns agents use Stats API for, with concrete tasks.

★ Halo Stats Tracker Dashboard

Build a community stats site that displays a player's recent Halo 5 matches, win rates, and CSR rank using the player match history and service record endpoints. The Halo Stats API returns JSON for each match and aggregated service records per game mode, so a dashboard can update on demand without scraping. Each subscription key is rate limited by the Halo developer portal.

Fetch the last 25 matches for player gamertag 'AgentSmith' from /h5/players/AgentSmith/matches and summarise wins and losses per playlist.

Esports Match Replay Analysis

Pull per-match event timelines from /h5/matches/{matchId}/events to reconstruct kill, death, and objective events for esports analysts and casters. Combined with /h5/arena/matches/{matchId} this gives a complete picture of a competitive match without parsing game film. Coverage is limited to Halo 5 arena and supported playlists.

Retrieve match events for Halo 5 match ID 'abc-123' and produce a chronological list of kills with weapon and victim.

Spartan Company Recruitment

Use /h5/companies/{companyId} and /h5/companies/{companyId}/commendations to surface a Halo 5 Spartan Company's roster and commendation progress on a recruitment page. The endpoints return member rosters and aggregate achievement data so prospective members can evaluate company activity. Data is read-only and cached short-term by the upstream service.

Get company commendations for company ID '00000000-0000-0000-0000-000000000001' and rank members by total commendation score.

AI Agent Halo Lookup Tool

Expose Halo player and match lookups as agent tools so an assistant can answer questions like 'how did I do in my last warzone match' or 'what's my arena CSR'. Through Jentic, the agent calls /h5/players/{player}/matches and /h5/servicerecords/arena with credentials kept in the Jentic vault. The Stats API is read-only, so agents cannot modify game data.

When a user asks 'how am I doing in arena', call /h5/servicerecords/arena for their gamertag and report KDR, win rate, and current CSR.

Key Endpoints

28 endpoints — the halo stats api exposes player and match statistics from halo 5: guardians and halo wars 2 across arena, warzone, custom, and campaign game modes.

METHOD

PATH

DESCRIPTION

GET

/h5/players/{player}/matches

Halo 5 player match history

GET

/h5/arena/matches/{matchId}

Halo 5 arena match result

GET

/h5/warzone/matches/{matchId}

Halo 5 warzone match result

GET

/h5/servicerecords/arena

Halo 5 arena service records

GET

/h5/matches/{matchId}/events

Halo 5 per-match event timeline

GET

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

Halo 5 CSR leaderboard

GET

/hw2/matches/{matchId}

Halo Wars 2 match result

GET

/h5/players/{player}/matches

Halo 5 player match history

GET

/h5/arena/matches/{matchId}

Halo 5 arena match result

GET

/h5/warzone/matches/{matchId}

Halo 5 warzone match result

GET

/h5/servicerecords/arena

Halo 5 arena service records

GET

/h5/matches/{matchId}/events

Halo 5 per-match event timeline

Why though Jentic?

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

Credential isolation

Halo subscription keys are stored in the Jentic vault and injected as the Ocp-Apim-Subscription-Key header on each call. The raw key is never passed into the agent's context, so prompt logs and tool transcripts cannot leak it.

Intent-based discovery

Agents search Jentic for intents like 'get a halo 5 player's match history' and Jentic returns the matching operation with its parameter schema, removing the need to crawl the Halo developer portal docs.

Time to first call

Direct integration: half a day to register a subscription key, model the 28 endpoints, and add retry logic. Through Jentic: under 15 minutes — search, load, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

Twitch API

Twitch streams and clips alongside Halo match data for esports overlays.

Use Twitch when the agent needs live stream metadata or VOD references to pair with Halo match results.

Alternative

Steam Web API

Player stats and game data for Steam titles when the user plays non-Halo games.

Choose Steam Web API when the player's title is on Steam rather than Halo's Xbox-side ecosystem.

Complementary

RAWG Video Games Database

Game metadata, screenshots, and reviews for catalog enrichment around Halo titles.

Use RAWG when the agent needs general game metadata (release dates, genres, screenshots) rather than per-player stats.

FAQs

Specific to using Stats API through Jentic.

What authentication does the Halo Stats API use?

The Halo Stats API uses an API key in the Ocp-Apim-Subscription-Key header (or a subscription-key query parameter) issued by the Halo developer portal. Through Jentic the key is stored in the encrypted vault and injected per request, so it never enters the agent's prompt context.

Can I retrieve a player's match history with the Halo Stats API?

Yes. Call GET /h5/players/{player}/matches with the player's gamertag to retrieve their Halo 5 match history. For Halo 5 PC use /h5pc/players/{player}/matches. Both endpoints return paginated match summaries that you can join against the per-match endpoints for detailed results.

What are the rate limits for the Halo Stats API?

Rate limits are tied to the developer portal subscription tier (typically 10 requests per second on the standard tier). The API does not return retry-after headers, so clients should back off on HTTP 429 responses. Limits are per subscription key, not per endpoint.

How do I get a Halo 5 match result through Jentic?

Search Jentic for 'get halo 5 match result', load the schema for GET /h5/arena/matches/{matchId} (or the warzone, custom, or campaign variant), then execute with the matchId. Run pip install jentic and use the async client.search, client.load, and client.execute pattern.

Does the Halo Stats API cover Halo Infinite?

No. This spec covers Halo 5: Guardians, Halo 5 PC, and Halo Wars 2 only. Halo Infinite stats are served by a separate, unofficial waypoint endpoint that is not part of this OpenAPI spec.

Is the Halo Stats API free to use?

The Halo developer portal offered free subscription tiers for community sites, though new sign-ups have been restricted at various points. Existing keys continue to work for Halo 5 and Halo Wars 2 data. Check the Halo developer portal for current availability before building.