v1
latestSwagger 2.02026-07-14280390.8 KBHalo 5 - Player Match History
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 returned in this API.
This endpoint will include games played on Local Servers with the Custom Local Game Mode for games that occurred or after December 22, 2017.
Changelog
February 1, 2019:
- Enabled support for viewing the time component of the "MatchCompletedDate" via the "{include-times}" Request Parameter.
December 22, 2017:
- Added support for the Custom Local Game mode.
February 21, 2017:
- Renamed Endpoint from "Matches for Player" to "Halo 5 - Player Match History".
- Removed "{title}" Request Parameter.
April 20, 2016:
- Clarified documentation for the "MapVariant" and "GameVariant" fields.
- Corrected "OwnerType" values for the "MapVariant" and "GameVariant" fields.
Path parameters
The Player's Gamertag.
Query parameters
Indicates what Game Mode(s) the client is interested in getting Matches for (arena, campaign, custom, customlocal, or warzone).
When the parameter is omitted or empty, Matches from all modes are returned. When a client would like to receive Matches spanning multiple Modes, separate the Modes with a comma (e.g. "arena,custom"). There is no significance to the order the Modes are specified in this parameter.
When an invalid Mode is specified, HTTP 400 ("Bad Request") is returned.
When a valid Mode is specified more than once, 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.
When set to "true", this indicates that the time component of the "MatchCompletedDate" field should be populated.
Otherwise, when set to "false" or when omitted, the time component will be set to "00:00:00".
When the value contains a non-boolean, HTTP 400 ("Bad Request") is returned.
Response
The response body will contain the Player's recent Matches. An empty list will be returned if the Player has not played any Matches in the specified Game Mode(s).