Integration

Halo Public API integration

The Halo Public API (Beta) by 343 Industries serves official Halo 5: Guardians and Halo Wars 2 data. Read a player's match history, detailed match results and match events, lifetime service records per game mode, commendation progress, CSR leaderboards, Spartan Company and appearance, and the game and map variants a player created; and read the game metadata (maps, medals, weapons, vehicles, playlists, seasons, requisitions, and for Halo Wars 2 leaders, cards, packs, game objects and more) to turn the ids in stats into names. Players are identified by gamertag. The two routes that redirect to a player's emblem or Spartan image are not included. Authentication is a subscription key from the Halo developer portal (the free Developer Access product, 10 requests per 10 seconds), sent in the Ocp-Apim-Subscription-Key header.

Connect Halo Public API How integrations work

Ask it in chat

Say what should happen.
The workflow builds itself.

When this happens, do that in Halo Public API.Built from the 70 Halo Public API tools below, on the connection you add once.

What you can do with Halo Public API

Each of these is one operation on one endpoint, available both as a workflow step and as a tool an AI agent can call on its own. Nothing bundles several operations into one action, so what a run did stays readable afterwards.

Most endpoints run on the free plan. A few, mainly the ones that publish on your behalf, need a paid plan.

Match, 10 operations

halo5_get_arena_matchHalo5 get arena matchGETReturns the detailed result of a Halo 5 Arena match: per-player stats (kills, headshots, damage, shots fired and landed, CSR before and after, XP, medals, weapons) and per-team score and rank, map, playlist and duration.
halo5_get_campaign_matchHalo5 get campaign matchGETReturns the detailed result of a Halo 5 campaign match (one play session of a mission): per-player stats, mission completion, difficulty, skulls, playthrough time and duration.
halo5_get_custom_local_matchHalo5 get custom local matchGETReturns the detailed result of a Halo 5 Custom Local match played on a local server: per-player stats, per-team score and rank, map, game variant and duration.
halo5_get_custom_matchHalo5 get custom matchGETReturns the detailed result of a Halo 5 Custom match played on Xbox Live servers: per-player stats, per-team score and rank, map, game variant and duration. Local server games use halo5_get_custom_local_match.
halo5_get_warzone_matchHalo5 get warzone matchGETReturns the detailed result of a Halo 5 Warzone match: per-player stats (kills, Warzone level, XP, credits, commendation deltas), per-team score and rank, objectives completed, map and duration.
halo5_list_player_matchesHalo5 list player matchesGETLists a player's recent completed Halo 5 matches, newest first: match id and game mode, map, variants, duration, completion date, teams and players. Filter by modes; pages of up to 25 (start, count).
halo5_pc_get_custom_matchHalo5 pc get custom matchGETReturns the detailed result of a Halo 5 PC Custom match: per-player stats, per-team score and rank, map, game variant and duration.
halo5_pc_list_player_matchesHalo5 pc list player matchesGETLists a player's recent Halo 5 PC matches, newest first: match id, mode, map, variants, duration, completion date, teams and players. Pages of up to 25 (start, count).
halo_wars2_get_matchHalo wars2 get matchGETReturns the result of a Halo Wars 2 match: match type, game mode, season, playlist, map, completion and end reason, start date, duration, and per-team and per-player data. In-progress matches update every few minutes.
halo_wars2_list_player_matchesHalo wars2 list player matchesGETLists a player's recent Halo Wars 2 matches, newest first: match id, type, mode, season, playlist, map, leader, outcome, duration, XP and rating progress. Filter by matchType; pages of up to 25.

Commendation, 3 operations

halo5_get_company_commendationsHalo5 get company commendationsGETReturns a Halo 5 Spartan Company's commendation progress: progressive commendations with progress and completed levels, and meta commendations with their met requirements.
halo5_get_player_commendationsHalo5 get player commendationsGETReturns a Halo 5 player's commendation progress: progressive commendations with progress and completed levels, and meta commendations with met requirements. Names come from halo5_list_commendations.
halo5_list_commendationsHalo5 list commendationsGETLists the Halo 5 player commendations: name, description, icon, type, category, levels with their thresholds and rewards (XP, requisition packs), and id. Use with halo5_get_player_commendations.

Season, 3 operations

halo5_list_seasonsHalo5 list seasonsGETLists the Halo 5 seasons: name, icon, start and end dates, whether active, id, and the playlists available in each season.
halo_wars2_get_player_season_statsHalo wars2 get player season statsGETReturns a player's Halo Wars 2 stats for one season (or current): per ranked playlist, highest CSR, time played, matches started, completed, won and lost, units built, lost and destroyed, and leader stats.
halo_wars2_list_seasonsHalo wars2 list seasonsGETLists the Halo Wars 2 seasons as content items (100 per page, paged with startAt): start date, playlists and display info.

Csr, 2 operations

halo5_get_csr_leaderboardHalo5 get csr leaderboardGETReturns the Halo 5 CSR leaderboard of a playlist in a season: the top players with a CSR of 1800 or above, each with rank and score. Up to 250 entries (count, default 200).
halo_wars2_get_csr_leaderboardHalo wars2 get csr leaderboardGETReturns the Halo Wars 2 CSR leaderboard of a playlist in a season: the top players with a CSR of 1800 or above, each with rank and score. Up to 250 entries (count, default 200).

Csr designation, 2 operations

halo5_list_csr_designationsHalo5 list csr designationsGETLists the Halo 5 Competitive Skill Rank (CSR) designations (Bronze, Silver, Gold, Platinum, Diamond, Onyx, Champion), each with its banner image and tiers. Use it to name the designation and tier ids found in match results and leaderboards.
halo_wars2_list_csr_designationsHalo wars2 list csr designationsGETLists the Halo Wars 2 Competitive Skill Rank designations and their tiers as content items (100 per page, paged with startAt), to name the designation ids found in ratings.

Custom, 2 operations

halo5_get_custom_service_recordsHalo5 get custom service recordsGETReturns the Halo 5 Custom game service records (lifetime stats on Xbox Live servers) of up to 32 players at once, one result per gamertag with a result code.
halo5_pc_get_custom_service_recordsHalo5 pc get custom service recordsGETReturns the Halo 5 PC Custom game service records (lifetime stats) of up to 32 players at once, one result per gamertag with a result code.

Event, 2 operations

halo5_get_match_eventsHalo5 get match eventsGETReturns the events of a completed Halo 5 match (kills, deaths, medals, weapon and location details) and whether the set is complete. Less accurate than other endpoints; matches before December 2015 may be missing.
halo_wars2_get_match_eventsHalo wars2 get match eventsGETReturns the events of a completed Halo Wars 2 match and whether the set is complete. Not available for Custom matches; the set may grow as data becomes available.

Gamevariant, 2 operations

halo5_get_player_game_variantHalo5 get player game variantGETReturns a game variant created by a Halo 5 player: name, description, base game, score to win, lives, duration and rounds, access control, dates, banned flag and bookmark count.
halo5_list_player_game_variantsHalo5 list player game variantsGETLists the game variants a Halo 5 player created (name, description, base game, rules, dates, bookmark count), sorted by modified date by default; paged with start and count.

Map, 2 operations

halo5_list_mapsHalo5 list mapsGETLists the Halo 5 maps: localized name and description, supported game modes (Arena, Campaign, Custom, Warzone), image URL and id, to name the map ids found in match results.
halo_wars2_list_mapsHalo wars2 list mapsGETLists the Halo Wars 2 maps as content items (100 per page, paged with startAt): map id, image and display info.

Mapvariant, 2 operations

halo5_get_player_map_variantHalo5 get player map variantGETReturns a map variant created by a Halo 5 player: name, description, base map, access control, creation and modification dates, banned flag and bookmark count.
halo5_list_player_map_variantsHalo5 list player map variantsGETLists the map variants a Halo 5 player created (name, description, base map, dates, bookmark count), sorted by modified date by default; paged with start and count.

Playlist, 2 operations

halo5_list_playlistsHalo5 list playlistsGETLists the Halo 5 matchmaking playlists: localized name and description, whether ranked (CSR shown), image URL, game mode, whether currently active, and id.
halo_wars2_list_playlistsHalo wars2 list playlistsGETLists the Halo Wars 2 matchmaking playlists as content items (100 per page, paged with startAt): party and player counts, team or ranked flags, entries, images and display info.

Spartan rank, 2 operations

halo5_list_spartan_ranksHalo5 list spartan ranksGETLists the Halo 5 Spartan Ranks: the XP each rank starts at, its reward (XP, requisition packs) and id.
halo_wars2_list_spartan_ranksHalo wars2 list spartan ranksGETLists the Halo Wars 2 player ranks as content items (100 per page, paged with startAt): rank number, the XP it starts at, packs awarded and display info.

Appearance, 1 operation

halo5_get_player_appearanceHalo5 get player appearanceGETReturns a Halo 5 player's appearance information from their gamertag: gamertag, service tag, first and last modified dates, and their Spartan Company id and name when they belong to one.

Arena, 1 operation

halo5_get_arena_service_recordsHalo5 get arena service recordsGETReturns the Halo 5 Arena service records (lifetime stats, per-playlist CSR) of up to 32 players at once, for the current season or the one given in seasonId.

Campaign, 1 operation

halo5_get_campaign_service_recordsHalo5 get campaign service recordsGETReturns the Halo 5 campaign service records (lifetime campaign stats and mission progress) of up to 32 players at once, one result per gamertag with a result code.

Campaign level, 1 operation

halo_wars2_list_campaign_levelsHalo wars2 list campaign levelsGETLists the Halo Wars 2 campaign levels as content items (100 per page, paged with startAt): max score, critical, bonus and optional objectives, skulls, awarded packs and display info.

Campaign log, 1 operation

halo_wars2_list_campaign_logsHalo wars2 list campaign logsGETLists the Halo Wars 2 campaign logs as content items, 100 per page, paged with startAt. Each item carries its id, title and dates.

Campaign mission, 1 operation

halo5_list_campaign_missionsHalo5 list campaign missionsGETLists the Halo 5 campaign missions: mission number, localized name and description, background image URL, team (BlueTeam or OsirisTeam) and id.

Campaign progress, 1 operation

halo_wars2_get_player_campaign_progressHalo wars2 get player campaign progressGETReturns a player's Halo Wars 2 campaign progress: campaign XP, per-level completion and the campaign logs unlocked.

Card, 1 operation

halo_wars2_list_cardsHalo wars2 list cardsGETLists the Halo Wars 2 Blitz cards as content items (100 per page, paged with startAt): rarity, faction, leader, energy cost, play type, keywords, game object, images and display info.

Card keyword, 1 operation

halo_wars2_list_card_keywordsHalo wars2 list card keywordsGETLists the Halo Wars 2 Blitz card keywords as content items (100 per page, paged with startAt): the keyword and its display info.

Company, 1 operation

halo5_get_companyHalo5 get companyGETReturns a Halo 5 Spartan Company by id: name, creator, peak membership, suspension date, creation and modification dates, and its members with role (Member, Lieutenant, Leader) and join date.

Company commendation, 1 operation

halo5_list_company_commendationsHalo5 list company commendationsGETLists the Halo 5 Spartan Company commendations: name, description, icon, type, category, levels with thresholds and rewards, and id. Use with halo5_get_company_commendations.

Customlocal, 1 operation

halo5_get_custom_local_service_recordsHalo5 get custom local service recordsGETReturns the Halo 5 Custom Local service records (lifetime stats on local servers, games since December 22, 2017) of up to 32 players at once.

Difficulty, 1 operation

halo_wars2_list_difficultiesHalo wars2 list difficultiesGETLists the Halo Wars 2 difficulty levels as content items (100 per page, paged with startAt): id and display info.

Enemy, 1 operation

halo5_list_enemiesHalo5 list enemiesGETLists the Halo 5 enemies: faction (UNSC, Covenant or Promethean), localized name and description, large and small icon URLs, and id, to name the enemy ids found in campaign and Warzone stats.

Flexible stat, 1 operation

halo5_list_flexible_statsHalo5 list flexible statsGETLists the Halo 5 flexible stats: name, type (Count or Duration) and id, to name the flexible stat ids found in match results and service records.

Game base variant, 1 operation

halo5_list_game_base_variantsHalo5 list game base variantsGETLists the Halo 5 game base variants: localized name, internal name, icon URL, the game modes each is available in (Arena, Campaign, Custom, Warzone) and id, to name the base variant ids in match results.

Game object, 1 operation

halo_wars2_list_game_objectsHalo wars2 list game objectsGETLists the Halo Wars 2 game objects as content items (100 per page, paged with startAt): object type id, categories, supply, population and energy costs, effectiveness and display info.

Game object category, 1 operation

halo_wars2_list_game_object_categoriesHalo wars2 list game object categoriesGETLists the Halo Wars 2 game object categories as content items, 100 per page, paged with startAt.

Game variant, 1 operation

halo5_get_game_variantHalo5 get game variantGETReturns one official Halo 5 game variant by id: localized name and description, its game base variant id, icon URL and id. Player-created variants are read with halo5_get_player_game_variant.

Impulse, 1 operation

halo5_list_impulsesHalo5 list impulsesGETLists the Halo 5 impulses (invisible medals tracked in match stats): internal name and id.

Leader, 1 operation

halo_wars2_list_leadersHalo wars2 list leadersGETLists the Halo Wars 2 leaders as content items (100 per page, paged with startAt): faction (UNSC or Banished), starting army options, id, image and display info.

Leader power, 1 operation

halo_wars2_list_leader_powersHalo wars2 list leader powersGETLists the Halo Wars 2 leader powers as content items (100 per page, paged with startAt): object type id, image and display info.

Map variant, 1 operation

halo5_get_map_variantHalo5 get map variantGETReturns one official Halo 5 map variant by id: localized name and description, image URL, the base map id and id. Player-created map variants are read with halo5_get_player_map_variant.

Medal, 1 operation

halo5_list_medalsHalo5 list medalsGETLists the Halo 5 medals: name, description, classification (Multi-kill, Spree, Style, Vehicle, Breakout, Objective), difficulty, sprite sheet location and id.

Pack, 1 operation

halo_wars2_list_packsHalo wars2 list packsGETLists the Halo Wars 2 Blitz card packs as content items (100 per page, paged with startAt): pack rules, images, sort priority, marketplace product ids and display info.

Rating, 1 operation

halo_wars2_get_playlist_ratingsHalo wars2 get playlist ratingsGETReturns the current-season ratings (CSR) in one Halo Wars 2 playlist of up to 6 players at once, one result per gamertag with a result code.

Requisition, 1 operation

halo5_get_requisitionHalo5 get requisitionGETReturns one Halo 5 requisition (REQ card) by id: name, description, rarity, category, supported game modes, images, sell price, level requirement and flags such as mythic, certification and wearable.

Requisition pack, 1 operation

halo5_get_requisition_packHalo5 get requisition packGETReturns one Halo 5 requisition pack by id: name, description, images, credit price, purchase options (credits, Xbox Marketplace product), featured and new flags, and merchandising order.

Skull, 1 operation

halo5_list_skullsHalo5 list skullsGETLists the Halo 5 campaign skulls: localized name and description, image URL, the mission where it is found, and id.

Stat, 1 operation

halo_wars2_get_player_statsHalo wars2 get player statsGETReturns a player's lifetime Halo Wars 2 stats summary: custom and skirmish stats, and matchmaking stats per social and ranked playlist and per game mode.

Team color, 1 operation

halo5_list_team_colorsHalo5 list team colorsGETLists the Halo 5 team colors: localized name and description, the color as an RGB hex string, icon URL and id, to name the team ids found in match results.

Tech, 1 operation

halo_wars2_list_techsHalo wars2 list techsGETLists the Halo Wars 2 techs as content items (100 per page, paged with startAt): object type id, image and display info.

Vehicle, 1 operation

halo5_list_vehiclesHalo5 list vehiclesGETLists the Halo 5 vehicles: localized name and description, large and small icon URLs, whether usable by players, and id.

Warzone, 1 operation

halo5_get_warzone_service_recordsHalo5 get warzone service recordsGETReturns the Halo 5 Warzone service records (lifetime Warzone stats) of up to 32 players at once, one result per gamertag with a result code.

Weapon, 1 operation

halo5_list_weaponsHalo5 list weaponsGETLists the Halo 5 weapons: localized name and description, type, large and small icon URLs, whether usable by players, and id, to name the weapon ids found in match stats.

Xp, 1 operation

halo_wars2_get_player_xpHalo wars2 get player xpGETReturns the Halo Wars 2 XP and rank of up to 6 players at once, one result per gamertag with a result code.

Use Halo Public API from Claude Code, Cursor or Codex

Connect Halo Public API in LiveContext, create an API key in Settings, then add the LiveContext MCP server to your client. Its Halo Public API operations become tools the client can call, next to every other integration you connected.

Claude Code

claude mcp add --transport http livecontext https://livecontext.ai/mcp --header "X-API-Key: YOUR_API_KEY"

Codex (~/.codex/config.toml)

[mcp_servers.livecontext]
url = "https://livecontext.ai/mcp"

[mcp_servers.livecontext.http_headers]
"X-API-Key" = "YOUR_API_KEY"

Cursor, Claude Desktop and other JSON configs

{
  "mcpServers": {
    "livecontext": {
      "type": "http",
      "url": "https://livecontext.ai/mcp",
      "headers": {
        "X-API-Key": "YOUR_API_KEY"
      }
    }
  }
}

Set up the MCP server step by step

How to connect Halo Public API

Create your workspace
Sign up free. Nothing to install.
Connect Halo Public API once
Add your Halo Public API connection in Settings. Every tool from this integration reuses it, and secrets are encrypted at rest and visible only to you.
Describe the job in chat
The workflow builds itself in front of you and picks the endpoints it needs. Drag the steps yourself on the canvas whenever you would rather be explicit.