v1
latestSwagger 2.02026-07-14280390.8 KBHalo Wars 2 - Player Match History
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.
Changelog
September 5, 2017:
- Documented new game mode "Terminus Firefight".
February 21, 2017:
- Added Endpoint.
Path parameters
The Player's Gamertag.
Query parameters
Indicates what Match Type the client is interested in getting Matches for ("custom" or "matchmaking").
When the parameter is omitted or empty, Matches from all Match Types are returned.
When an invalid Mode is specified, HTTP 400 ("Bad Request") is returned.
When specified, this indicates the starting index (0-based) for which the batch of results will begin at. For example, "start=0" indicates that the first qualifying result will be returned, no items are 'skipped'. Passing "start=10" indicates that the result will begin with the 11th item, the first 10 will be 'skipped'.
When omitted, zero is assumed.
When the value contains a non-digit, HTTP 400 ("Bad Request") is returned.
When specified, this indicates the maximum quantity of items the client would like returned in the response.
When omitted, 25 is assumed.
When the value contains a non-digit or is exactly "0", HTTP 400 ("Bad Request") is returned.
When the value is greater than the allowed range [1,25], the maximum allowed value is used instead. The "Count" field in the response will confirm the actual value that was used.
Response
The response body will contain the Match History for the Player.