API that provides Metadata information.
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://www.haloapi.com/metadata https://www.haloapi.com/stats https://www.haloapi.com/ugc https://www.haloapi.com/profile
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
API that provides Metadata information.
| method | path | what the vendor says it does |
|---|---|---|
GET | /h5/metadata/campaign-missions | Halo 5 - Campaign Missions Changelog February 21, 2017: Renamed Endpoint from "Campaign Mis |
GET | /h5/metadata/commendations | Halo 5 - Commendations Changelog February 21, 2017: Renamed Endpoint from "Commendations" t |
GET | /h5/metadata/company-commendations | Halo 5 - Company Commendations Changelog August 15, 2018: Added Endpoint. |
GET | /h5/metadata/csr-designations | Halo 5 - CSR Designations Changelog February 21, 2017: Renamed Endpoint from "CSR Designati |
GET | /h5/metadata/enemies | Halo 5 - Enemies Changelog February 21, 2017: Renamed Endpoint from "Enemies" to "Halo 5 - |
GET | /h5/metadata/flexible-stats | Halo 5 - Flexible Stats Changelog February 21, 2017: Renamed Endpoint from "Flexible Stats" |
GET | /h5/metadata/game-base-variants | Halo 5 - Game Base Variants Changelog February 21, 2017: Renamed Endpoint from "Game Base V |
GET | /h5/metadata/game-variants/{id} | Halo 5 - Game Variant Changelog February 21, 2017: Renamed Endpoint from "Game Variants" to |
GET | /h5/metadata/impulses | Halo 5 - Impulses Changelog February 21, 2017: Renamed Endpoint from "Impulses" to "Halo 5 |
GET | /h5/metadata/map-variants/{id} | Halo 5 - Map Variant Changelog February 21, 2017: Renamed Endpoint from "Map Variants" to " |
GET | /h5/metadata/maps | Halo 5 - Maps Changelog February 21, 2017: Renamed Endpoint from "Maps" to "Halo 5 - Maps". |
GET | /h5/metadata/medals | Halo 5 - Medals Changelog February 21, 2017: Renamed Endpoint from "Medals" to "Halo 5 - Me |
GET | /h5/metadata/playlists | Halo 5 - Playlists Changelog February 21, 2017: Renamed Endpoint from "Playlists" to "Halo |
GET | /h5/metadata/requisition-packs/{id} | Halo 5 - Requisition Pack Changelog February 21, 2017: Renamed Endpoint from "Requisition P |
GET | /h5/metadata/requisitions/{id} | Halo 5 - Requisition Changelog February 21, 2017: Renamed Endpoint from "Requisitions" to " |
GET | /h5/metadata/seasons | Halo 5 - Seasons Changelog February 21, 2017: Renamed Endpoint from "Seasons" to "Halo 5 - |
GET | /h5/metadata/skulls | Halo 5 - Skulls Changelog February 21, 2017: Renamed Endpoint from "Skulls" to "Halo 5 - Sk |
GET | /h5/metadata/spartan-ranks | Halo 5 - Spartan Ranks Changelog February 21, 2017: Renamed Endpoint from "Spartan Ranks" t |
GET | /h5/metadata/team-colors | Halo 5 - Team Colors Changelog February 21, 2017: Renamed Endpoint from "Team Colors" to "H |
GET | /h5/metadata/vehicles | Halo 5 - Vehicles Changelog February 21, 2017: Renamed Endpoint from "Vehicles" to "Halo 5 |
GET | /h5/metadata/weapons | Halo 5 - Weapons Changelog February 21, 2017: Renamed Endpoint from "Weapons" to "Halo 5 - |
GET | /hw2/campaign-levels | Halo Wars 2 - Campaign Levels Changelog February 21, 2017: Added Endpoint. |
GET | /hw2/campaign-logs | Halo Wars 2 - Campaign Logs Changelog February 21, 2017: Added Endpoint. |
GET | /hw2/card-keywords | Halo Wars 2 - Card Keywords Changelog February 22, 2017: Added Endpoint. |
GET | /hw2/cards | Halo Wars 2 - Cards Changelog February 21, 2017: Added Endpoint. |
GET | /hw2/csr-designations | Halo Wars 2 - CSR Designations Changelog February 22, 2017: Added Endpoint. |
GET | /hw2/difficulties | Halo Wars 2 - Difficulties Changelog February 21, 2017: Added Endpoint. |
GET | /hw2/game-object-categories | Halo Wars 2 - Game Object Categories Changelog February 21, 2017: Added Endpoint. |
GET | /hw2/game-objects | Halo Wars 2 - Game Objects Changelog February 21, 2017: Added Endpoint. |
GET | /hw2/leader-powers | Halo Wars 2 - Leader Powers Changelog February 21, 2017: Added Endpoint. |
GET | /hw2/leaders | Halo Wars 2 - Leaders Changelog February 21, 2017: Added Endpoint. |
GET | /hw2/maps | Halo Wars 2 - Maps Changelog February 21, 2017: Added Endpoint. |
GET | /hw2/packs | Halo Wars 2 - Packs Changelog February 21, 2017: Added Endpoint. |
GET | /hw2/playlists | Halo Wars 2 - Playlists Changelog February 21, 2017: Added Endpoint. |
GET | /hw2/seasons | Halo Wars 2 - Seasons Changelog February 21, 2017: Added Endpoint. |
GET | /hw2/spartan-ranks | Halo Wars 2 - Spartan Ranks Changelog February 27, 2017: Updated documentation to clarify t |
GET | /hw2/techs | Halo Wars 2 - Techs Changelog February 21, 2017: Added Endpoint. |
specification origin: https://developer.haloapi.com/docs/services/58ace18c21091812784ce8c5/export?DocumentFormat
API that provides statistical data about Players and Matches.
| method | path | what the vendor says it does |
|---|---|---|
GET | /h5/arena/matches/{matchId} | Halo 5 - Match Result - Arena Retrieves detailed statistics for a Match with the Arena Game Mode. Changelog |
GET | /h5/campaign/matches/{matchId} | Halo 5 - Match Result - Campaign Retrieves detailed statistics for a Match with the Campaign Game Mode. Every |
GET | /h5/companies/{companyId} | Halo 5 - Company Retrieves information about the Company. The response will contain the Company's name, status |
GET | /h5/companies/{companyId}/commendations | Halo 5 - Company Commendations Retrieves the commendation state for a Company. Changelog July 14, 2017: |
GET | /h5/custom/matches/{matchId} | Halo 5 - Match Result - Custom Retrieves detailed statistics for a Match with the Custom Game Mode. Games with |
GET | /h5/customlocal/matches/{matchId} | Halo 5 - Match Result - Custom Local Retrieves detailed statistics for a Match with the Custom Local Game Mode |
GET | /h5/matches/{matchId}/events | Halo 5 - Match Events Retrieves a set of Events related to the Match specified. Events are only available once |
GET | /h5/player-leaderboards/csr/{seasonId}/{playlistId} | Halo 5 - Leaderboard - Player CSR Retrieves the Leaderboard for Player CSRs. The Leaderboard consists of the t |
GET | /h5/players/{player}/commendations | Halo 5 - Player Commendations Retrieves the commendation state for a Player. Changelog July 14, 2017: |
GET | /h5/players/{player}/matches | Halo 5 - Player Match History Retrieves a list of Matches that the Player has participated in and which have c |
GET | /h5/servicerecords/arena | Halo 5 - Player Service Records - Arena Retrieves Service Records for the Arena Game Mode for one or more play |
GET | /h5/servicerecords/campaign | Halo 5 - Player Service Records - Campaign Retrieves Service Records for the Campaign Game Mode for one or mor |
GET | /h5/servicerecords/custom | Halo 5 - Player Service Records - Custom Retrieves Service Records for the Custom Game Mode for one or more pl |
GET | /h5/servicerecords/customlocal | Halo 5 - Player Service Records - Custom Local Retrieves Service Records for the Custom Local Game Mode for on |
GET | /h5/servicerecords/warzone | Halo 5 - Player Service Records - Warzone Retrieves Service Records for the Warzone Game Mode for one or more |
GET | /h5/warzone/matches/{matchId} | Halo 5 - Match Result - Warzone Retrieves detailed statistics for a Match with the Warzone Game Mode. Changel |
GET | /h5pc/custom/matches/{matchId} | Halo 5 PC - Match Result - Custom Retrieves detailed statistics for a Match with the Custom Game Mode. Games w |
GET | /h5pc/players/{player}/matches | Halo 5 PC - Player Match History Retrieves a list of Matches that the Player has participated in and which hav |
GET | /h5pc/servicerecords/custom | Halo 5 PC - Player Service Records - Custom Retrieves Service Records for the Custom Game Mode for one or more |
GET | /hw2/matches/{matchId} | Halo Wars 2 - Match Result Retrieves detailed statistics for a Match. Matches can be retrieved before they are |
GET | /hw2/matches/{matchId}/events | Halo Wars 2 - Match Events Retrieves a set of Events related to the Match specified. Events are only available |
GET | /hw2/player-leaderboards/csr/{seasonId}/{playlistId} | Halo Wars 2 - Leaderboard - Player CSR Retrieves the Leaderboard for Player CSRs. The Leaderboard consists of |
GET | /hw2/players/{player}/campaign-progress | Halo Wars 2 - Player Campaign Progress Retrieves the Campaign Progress state for a Player. Changelog Feb |
GET | /hw2/players/{player}/matches | Halo Wars 2 - Player Match History Retrieves a list of Matches that the Player has participated in. If the Pla |
GET | /hw2/players/{player}/stats | Halo Wars 2 - Player Stats Summary Retrieves high-level aggregations across the lifetime of a Player. Changel |
GET | /hw2/players/{player}/stats/seasons/{seasonId} | Halo Wars 2 - Player Season Stats Summary Retrieves high-level aggregations across a Season for a Player. Cha |
GET | /hw2/playlist/{playlistId}/rating | Halo Wars 2 - Player Playlist Ratings Retrieves Playlist Ratings in the current season for one or more Players |
GET | /hw2/xp | Halo Wars 2 - Player XPs Retrieves XP and Rank information for one or more players. Changelog February 2 |
specification origin: https://developer.haloapi.com/docs/services/58acdf27e2f7f71ad0dad84b/export?DocumentFormat
API that provides Metadata about User-Generated Content (Maps and Game Variants).
| method | path | what the vendor says it does |
|---|---|---|
GET | /h5/players/{player}/gamevariants | Halo 5 - Player Game Variants Retrieves a list of Game Variants created by a Player. Changelog February |
GET | /h5/players/{player}/gamevariants/{variant} | Halo 5 - Player Game Variant Retrieves Metadata about a Player-created Game Variant. Changelog February |
GET | /h5/players/{player}/mapvariants | Halo 5 - Player Map Variants Retrieves a list Map Variants created by a Player. Changelog February 21, 2 |
GET | /h5/players/{player}/mapvariants/{variant} | Halo 5 - Player Map Variant Retrieves Metadata about a Player-created Map Variant. Changelog February 21 |
specification origin: https://developer.haloapi.com/docs/services/58acde2921091812784ce8c3/export?DocumentFormat
API that provides Profile information about Players.
| method | path | what the vendor says it does |
|---|---|---|
GET | /h5/profiles/{player}/appearance | Halo 5 - Player Appearance This Endpoint retrieves appearance information for a player. If the player is a mem |
GET | /h5/profiles/{player}/emblem | Halo 5 - Player Emblem Image This Endpoint returns an HTTP Redirect (302 Found) response to the caller with th |
GET | /h5/profiles/{player}/spartan | Halo 5 - Player Spartan Image This Endpoint returns an HTTP Redirect (302 Found) response to the caller with t |
specification origin: https://developer.haloapi.com/docs/services/58acdc2e21091812784ce8c2/export?DocumentFormat
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.