Community OpenAPI document · agent-readyMediaContent DeliveryapiKey28 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Look up Halo 5 and Halo Wars 2 player stats, match results, leaderboards, and service records using a developer subscription key.
Use for: Get the match result for a specific Halo 5 arena match, Retrieve a player's Halo 5 warzone service record, List all matches a Halo 5 player has played recently, Find the CSR leaderboard for a Halo 5 ranked playlist
Not supported: Does not handle matchmaking, game purchases, or Halo Infinite stats - use for read-only Halo 5 and Halo Wars 2 statistics only.
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.
Install Jentic One Beta
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.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fhaloapi.com%2Fhaloapi-stats" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fhaloapi.com%2Fhaloapi-stats" | sh
jentic register # connects your agent to your Jentic One instanceJentic 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
Query CSR season leaderboards for a given playlist
Access per-match event timelines for replay and analysis tooling
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 your Jentic One instance. 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
GET
/h5/player-leaderboards/csr/{seasonId}/{playlistId}
Halo 5 CSR leaderboard
GET
/hw2/matches/{matchId}
Halo Wars 2 match result
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
S
Stats
- Foundational (D)47/100
74
Foundational Compliance74
Developer Experience & Jentic Compatibility24
AI-Readiness & Agent Experience94
Agent Usability33
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
74
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A-Signals: 4
97%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
0%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
74
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: A-Signals: 4
23%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
73%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
24
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
63%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
0%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
33%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
33
Security
Trust, risk posture, and security compliance.
Grade: FSignals: 1
33%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Halo Stats API by hand means setting its Ocp-Apim-Subscription-Key header on every call and building each Halo 5 and Halo Wars 2 statistics request yourself. Through Jentic you install once, import the Halo Stats API from the API Directory, store the subscription key once, and your agent calls it.
Permission scoping
The Halo Stats API is read-only, covering Halo 5 and Halo Wars 2 statistics, so scope your agent to the operations it needs, such as reading a player's match history or a service record. You choose what it may call, and there are no write operations for it to reach.
Credential isolation
Your Halo Ocp-Apim-Subscription-Key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'get a halo 5 player match history' or 'get match events', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without crawling the Halo developer portal docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
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.
Can I limit what my agent is allowed to do with the Halo Stats API?
Yes. Because you run Jentic One yourself, your own rules decide which Halo Stats operations and credentials the agent may use, so you can allow only the endpoints it needs, such as GET /h5/players/{player}/matches for match history or /h5/servicerecords/arena for a service record. The Halo Stats API is entirely read-only for Halo 5 and Halo Wars 2, so there are no write operations for the agent to reach and it cannot modify game data. Your Ocp-Apim-Subscription-Key is stored once by your own instance and injected at execution time, so it never enters the agent's prompt or context.
GET STARTED