Stats
API that provides statistical data about Players and Matches.
Media & content#openapi#entertainment
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
API that provides statistical data about Players and Matches.
Endpoints 28
- GETHalo 5 - Match Result - Arena
/h5/arena/matches/:matchId<p>Retrieves detailed statistics for a Match with the Arena Game Mode.</p> <br /> <h4>Changelog</h4> <div class="panel-body"> <p><strong>December 12,… - GETHalo 5 - Match Result - Campaign
/h5/campaign/matches/:matchId<p>Retrieves detailed statistics for a Match with the Campaign Game Mode.</p> <p>Every time a player plays a portion of a Campaign Mission, a Match will be… - GETHalo 5 - Company
/h5/companies/:companyId<p>Retrieves information about the Company. The response will contain the Company's name, status, and members.</p> <br /> <h4>Changelog</h4> <div… - GETHalo 5 - Company Commendations
/h5/companies/:companyId/commendations<p>Retrieves the commendation state for a Company.</p> <br /> <h4>Changelog</h4> <div class="panel-body"> <p><strong>July 14, 2017:</strong></p> <ul>… - GETHalo 5 - Match Result - Custom
/h5/custom/matches/:matchId<p>Retrieves detailed statistics for a Match with the Custom Game Mode. Games with the Custom Game Mode are played on Xbox Live Servers. For games played on… - GETHalo 5 - Match Result - Custom Local
/h5/customlocal/matches/:matchId<p>Retrieves detailed statistics for a Match with the Custom Local Game Mode. Games with the Custom Local Game Mode are played on Local Servers. For games… - GETHalo 5 - Match Events
/h5/matches/:matchId/events<p>Retrieves a set of Events related to the Match specified. Events are only available once the Match has completed.</p> <p>The set of Events may grow over… - GETHalo 5 - Leaderboard - Player CSR
/h5/player-leaderboards/csr/:seasonId/:playlistId?count=0.0<p>Retrieves the Leaderboard for Player CSRs. The Leaderboard consists of the top Players with a CSR of 1800 or above for a given Playlist in a Season.</p>… - GETHalo 5 - Player Commendations
/h5/players/:player/commendations<p>Retrieves the commendation state for a Player.</p> <br /> <h4>Changelog</h4> <div class="panel-body"> <p><strong>July 14, 2017:</strong></p> <ul> <li>Added… - GETHalo 5 - Player Match History
/h5/players/:player/matches?modes=string&start=0.0&count=0.0&include-times=true<p>Retrieves a list of Matches that the Player has participated in and which have completed processing. If the Player is currently in a match, it is not… - GETHalo 5 - Player Service Records - Arena
/h5/servicerecords/arena?players=string&seasonId=string<p>Retrieves Service Records for the Arena Game Mode for one or more players. A Service Record contains a player's lifetime statistics in the Game Mode.</p>… - GETHalo 5 - Player Service Records - Campaign
/h5/servicerecords/campaign?players=string<p>Retrieves Service Records for the Campaign Game Mode for one or more players. A Service Record contains a player's lifetime statistics in the Game… - GETHalo 5 - Player Service Records - Custom
/h5/servicerecords/custom?players=string<p>Retrieves Service Records for the Custom Game Mode for one or more players. A Service Record contains a player's lifetime statistics in the Game Mode.… - GETHalo 5 - Player Service Records - Custom Local
/h5/servicerecords/customlocal?players=string<p>Retrieves Service Records for the Custom Local Game Mode for one or more players. A Service Record contains a player's lifetime statistics in the Game… - GETHalo 5 - Player Service Records - Warzone
/h5/servicerecords/warzone?players=string<p>Retrieves Service Records for the Warzone Game Mode for one or more players. A Service Record contains a player's lifetime statistics in the Game Mode.</p>… - GETHalo 5 - Match Result - Warzone
/h5/warzone/matches/:matchId<p>Retrieves detailed statistics for a Match with the Warzone Game Mode.</p> <br /> <h4>Changelog</h4> <div class="panel-body"> <p><strong>December 22,… - GETHalo 5 PC - Match Result - Custom
/h5pc/custom/matches/:matchId<p>Retrieves detailed statistics for a Match with the Custom Game Mode. Games with the Custom Game Mode are played on Xbox Live Servers. For games played on… - GETHalo 5 PC - Player Match History
/h5pc/players/:player/matches?modes=string&start=0.0&count=0.0&include-times=true<p>Retrieves a list of Matches that the Player has participated in and which have completed processing. If the Player is currently in a match, it is not… - GETHalo 5 PC - Player Service Records - Custom
/h5pc/servicerecords/custom?players=string<p>Retrieves Service Records for the Custom Game Mode for one or more players. A Service Record contains a player's lifetime statistics in the Game Mode.… - GETHalo Wars 2 - Match Result
/hw2/matches/:matchId<p>Retrieves detailed statistics for a Match. Matches can be retrieved before they are completed; however, the data for in-progress Matches is only updated… - GETHalo Wars 2 - Match Events
/hw2/matches/:matchId/events<p>Retrieves a set of Events related to the Match specified. Events are only available once the Match has completed. Events are not available for Matches… - GETHalo Wars 2 - Leaderboard - Player CSR
/hw2/player-leaderboards/csr/:seasonId/:playlistId?count=0.0<p>Retrieves the Leaderboard for Player CSRs. The Leaderboard consists of the top Players with a CSR of 1800 or above for a given Playlist in a Season.</p>… - GETHalo Wars 2 - Player Campaign Progress
/hw2/players/:player/campaign-progress<p>Retrieves the Campaign Progress state for a Player.</p> <br /> <h4>Changelog</h4> <div class="panel-body"> <p><strong>February 21, 2017:</strong></p> <ul>… - GETHalo Wars 2 - Player Match History
/hw2/players/:player/matches?matchType=string&start=0.0&count=0.0<p>Retrieves a list of Matches that the Player has participated in. If the Player is currently in a Match, it is not returned in this API.</p> <br />… - GETHalo Wars 2 - Player Stats Summary
/hw2/players/:player/stats<p>Retrieves high-level aggregations across the lifetime of a Player.</p> <br /> <h4>Changelog</h4> <div class="panel-body"> <p><strong>September 5,… - GETHalo Wars 2 - Player Season Stats Summary
/hw2/players/:player/stats/seasons/:seasonId<p>Retrieves high-level aggregations across a Season for a Player.</p> <br /> <h4>Changelog</h4> <div class="panel-body"> <p><strong>September 5,… - GETHalo Wars 2 - Player Playlist Ratings
/hw2/playlist/:playlistId/rating?players=string<p>Retrieves Playlist Ratings in the current season for one or more Players.</p> <br /> <h4>Changelog</h4> <div class="panel-body"> <p><strong>February 21,… - GETHalo Wars 2 - Player XPs
/hw2/xp?players=string<p>Retrieves XP and Rank information for one or more players.</p> <br /> <h4>Changelog</h4> <div class="panel-body"> <p><strong>February 21,…
API details
- Base URL
https://www.haloapi.com/stats- Authentication
- An API key in the Ocp-Apim-Subscription-Key header
An API key in the subscription-key query parameter - Operations
- 28 operations on 28 pathsGET 28
- Description format
- Swagger 2.0, API version
1.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Stats in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Stats collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Ocp-Apim-Subscription-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Halo 5 - Match Result - Arena” (GET /h5/arena/matches/:matchId), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Stats?
API that provides statistical data about Players and Matches. It is listed under Media & content and has 28 endpoints.
Who publishes the Stats?
It is listed from Haloapi's public API description (an OpenAPI document), not published by Haloapi on Swastik Codes. Anyone who controls haloapi.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Stats?
Requests go to https://www.haloapi.com/stats. Endpoint paths are added to this base URL.
How do I authenticate with the Stats?
It accepts 2 methods: an API key in the Ocp-Apim-Subscription-Key header; an API key in the subscription-key query parameter.
How many endpoints does the Stats have?
28 operations on 28 paths (28 GET).
Is forking the Stats free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.