Halo Metadata API

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

★ Only Publicly Available OpenAPI DocumentMediaContent DeliveryapiKey37 EndpointsREST

For Agents

Look up Halo 5 and Halo Wars 2 in-game content - maps, playlists, weapons, vehicles, medals, cards, and leader powers - by id or in bulk.

Connect the Halo Metadata API to your agent

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

List all Halo 5 maps, weapons, vehicles, medals, and team colors

Resolve a Halo 5 game variant by id to its name and metadata

Look up Halo 5 playlists, seasons, skulls, and Spartan ranks

List Halo 5 campaign missions, enemies, and commendations

GET STARTED

Start building with Halo Metadata API API

Explore with Jentic

View OpenAPI Document

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

Jentic publishes the only available OpenAPI specification for Halo Metadata API, keeping it validated and agent-ready. The Halo Metadata API exposes the catalogue of in-game content for Halo 5: Guardians and Halo Wars 2 - maps, playlists, weapons, vehicles, medals, seasons, CSR designations, leader powers, cards, campaign missions, and more. Agents use it to translate ids in match records into human-readable names and images. The catalogue is the lookup layer that pairs with the Halo stats and profile APIs.

Use Cases

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

★ Match Detail Hydration

Convert raw Halo 5 match ids and weapon ids in a match payload into human-readable strings and image URLs by joining against the metadata catalogue. The agent caches /h5/metadata/maps, /h5/metadata/weapons, and /h5/metadata/medals once per session and looks up entries by id during render. This is the lookup layer that powers any Halo stats UI.

GET /h5/metadata/maps and /h5/metadata/weapons, build an in-memory id-to-name map, then resolve a list of match ids.

Halo Wars 2 Leader Builder

Build a deck or leader-power loadout tool by listing /hw2/leader-powers and /hw2/cards. The agent presents the catalogue with metadata (cost, faction, rarity) and lets the user assemble a build to share. Useful for HW2 community sites that want richer build-share features.

GET /hw2/cards filtered by faction and emit the card list with name, cost, and rarity for each.

CSR Display Tier Lookup

Render a player's CSR rank with the correct tier image and label by joining the leaderboard payload against /h5/metadata/csr-designations. The agent fetches CSR rows from the stats API, looks up each designation by id, and emits the tier image URL plus localised label. Saves community sites from hardcoding CSR tier data.

GET /h5/metadata/csr-designations and resolve a list of CSR ids returned by the leaderboard API.

Agent Discovery Through Jentic

Halo community agents discover the metadata operations through Jentic by searching for intents like 'list halo maps'. Jentic returns the matching GET operation with its input schema and the agent retrieves the catalogue. The Ocp-Apim-Subscription-Key stays in the Jentic vault.

Use Jentic search 'list halo maps' to find GET /h5/metadata/maps and execute it.

Key Endpoints

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

METHOD

PATH

DESCRIPTION

GET

/h5/metadata/maps

List all Halo 5 maps

GET

/h5/metadata/weapons

List all Halo 5 weapons

GET

/h5/metadata/medals

List all Halo 5 medals

GET

/h5/metadata/playlists

List all Halo 5 playlists

GET

/h5/metadata/seasons

List all Halo 5 seasons

GET

/hw2/cards

List all Halo Wars 2 cards

GET

/hw2/leader-powers

List Halo Wars 2 leader powers

GET

/hw2/campaign-levels

List Halo Wars 2 campaign levels

GET

/h5/metadata/maps

List all Halo 5 maps

GET

/h5/metadata/weapons

List all Halo 5 weapons

GET

/h5/metadata/medals

List all Halo 5 medals

GET

/h5/metadata/playlists

List all Halo 5 playlists

GET

/h5/metadata/seasons

List all Halo 5 seasons

Why though Jentic?

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

Credential isolation

The Halo Metadata 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 'list halo maps' or 'halo wars 2 cards' and receive the matching metadata operation with its input schema. No URL building required.

Time to first call

Direct integration: a few hours to wire up subscription auth and pagination. Through Jentic: under fifteen minutes to search, load, and execute the relevant lookup.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

Halo API

Stats, profile, and consolidated Halo 5 endpoints that reference these metadata ids.

Use the Halo API to fetch matches, service records, and leaderboards, then resolve ids against this Metadata API.

Complementary

Halo Profile API

Player profile assets - emblem, appearance, Spartan render.

Pair with Profile when displaying a metadata-resolved match recap with player imagery.

Alternative

Riot Games API

In-game catalogue (champions, items, runes) for League of Legends and Valorant.

Pick Riot Games when the use case is metadata lookup for a Riot title rather than Halo.

FAQs

Specific to using Halo Metadata API API through Jentic.

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

343 Industries does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Halo Metadata 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 Metadata 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.

Does the Halo Metadata API cover Halo Wars 2 as well as Halo 5?

Yes. Endpoints under /h5/metadata serve Halo 5 catalogues (maps, weapons, medals, etc.) and endpoints under /hw2 serve Halo Wars 2 (cards, leader-powers, game-objects, campaign-levels). Both are queried with the same subscription key.

How often does the Halo Metadata catalogue change?

Catalogue entries change rarely - typically only when 343 ships a content update for the supported title. Agents should cache responses aggressively (hours to a day) rather than calling on every request, to stay under the subscription rate limits.

How do I look up a Halo weapon name by id through Jentic?

Run pip install jentic, then search 'list halo weapons' to find GET /h5/metadata/weapons. Execute it once, build an id-to-name map in memory, and reuse it across requests. The full setup runs in under five minutes.

What rate limits apply to the Halo Metadata API?

Rate limits are tied to the Azure subscription tier of your developer key. Free keys receive a low quota and return 429 quickly; paid tiers receive higher quotas. Always cache catalogue responses since the data is near-static.