Halo API Changelog

The Halo API service is still in beta, but continues to grow and evolve as we march towards a full release. Please refer to this thread for all updates to the Halo API service.

----------

Effective Date
May 20, 2016 at 12:00 PM

Description
The Stats service was deployed.

API Changes
Events for Match

  • The HTTP header for “Content-Type” is now correctly reported as “application/json”.----------

Archived Changes

Effective Date
May 16, 2016 at 2:00 PM PT

Description
Corrected an error in Metadata documentation.

API Changes
Events for Match

  • Updated endpoint documentation to include HTTP 503 Status Code responses.Post-Game Carnage Report for Arena, Campaign, Custom, and Warzone

  • Updated endpoint documentation to include HTTP 503 Status Code responses.Post-Game Carnage Report for Arena and Warzone

  • Added documentation for MatchSpeedWinAmount, ObjectivesCompletedAmount, and BoostData.----------

Effective Date
May 13, 2016 at 8:00 PM PT

Description
Reconfigured and removed some caching layers in the Stats service.

----------

Effective Date
April 26, 2016 at 10:00 AM PT

Description
Corrected an error in Metadata documentation.

API Changes
Metadata – Weapons

  • Changed the documentation of the “type” field to read “The type of the weapon” instead of “The type of the vehicle”. Thank you IMI E D I C for pointing this out.----------

Effective Date
April 20, 2016 at 5:00 PM PT

Description
The Stats service was deployed. The new deployment adds new event types to the Events for Match endpoint and fixes some bugs. It also adds a new Player leaderboard API. The documentation was updated to accommodate these changes, fix some typos, and add some clarification.

API Changes
Metadata – Enemies

  • Changed “lageIconImageUrl” to “largeIconImageUrl” to correct a typo. Thank you Five0h0ne for pointing this out.Stats – Events for Match

  • Added new types of events: Impulses, Medals, Player Spawns, Round Starts, Round Ends, Weapon Drops, Weapon Pickups, and Weapon Pickup Pads. - Fixed an issue that caused the API to consistently return 500s for matches where a player left and rejoined the match. - The documentation for this API has significantly changed in order to reflect the new event types.Stats – Matches for Player

  • Updated documentation for MapVariant and GameVariant for clarity. - Changed valid options for OwnerType in MapVariant and GameVariant. User-generated is represented exclusively by the value of “1”. Previously, the documentation stated that User-generated would be represented by a value of “1” or “2”.Stats – Player Leaderboard

  • Added a new Player Leaderboard API that returns the top players on a playlist for a particular season.Stats – Post-Game Carnage Report for Arena, Campaign, Custom, and Warzone

  • Updated API description to indicate that Post-Game Carnage Reports are not available for in-progress matches. - Added documentation for GameVariantResourceId, MapVariantResourceId, and PlayerScore. Thank you Furiousn00b for pointing this out. - Updated documentation for MapVariantId and GameVariantId with the recommendation of using MapVariantResourceId and GameVariantResourceId, respectively.Stats – Service Record

  • Added documentation for CsrPercentile.----------

Effective Date
December 16, 2015

Description
The Seasons end point has been added to Halo API with the Cartographer’s Gift update to Halo 5.

Effective Date
April 20, 2016 at 5:00 PM PT

Description
The Stats service was deployed. The new deployment adds new event types to the Events for Match endpoint and fixes some bugs. It also adds a new Player leaderboard API. The documentation was updated to accommodate these changes, fix some typos, and add some clarification.

API Changes
Metadata – Enemies

  • Changed “lageIconImageUrl” to “largeIconImageUrl” to correct a typo. Thank you Five0h0ne for pointing this out.Stats – Events for Match

  • Added new types of events: Impulses, Medals, Player Spawns, Round Starts, Round Ends, Weapon Drops, Weapon Pickups, and Weapon Pickup Pads. - Fixed an issue that caused the API to consistently return 500s for matches where a player left and rejoined the match. - The documentation for this API has significantly changed in order to reflect the new event types.Stats – Matches for Player

  • Updated documentation for MapVariant and GameVariant for clarity. - Changed valid options for OwnerType in MapVariant and GameVariant. User-generated is represented exclusively by the value of “1”. Previously, the documentation stated that User-generated would be represented by a value of “1” or “2”.Stats – Player Leaderboard

  • Added a new Player Leaderboard API that returns the top players on a playlist for a particular season.Stats – Post-Game Carnage Report for Arena, Campaign, Custom, and Warzone

  • Updated API description to indicate that Post-Game Carnage Reports are not available for in-progress matches. - Added documentation for GameVariantResourceId, MapVariantResourceId, and PlayerScore. Thank you Furiousn00b for pointing this out. - Updated documentation for MapVariantId and GameVariantId with the recommendation of using MapVariantResourceId and GameVariantResourceId, respectively.Stats – Service Record

  • Added documentation for CsrPercentile.

Effective Date
April 26, 2016 at 10:00 AM PT

Description
Corrected an error in Metadata documentation.

API Changes
Metadata – Weapons

  • Changed the documentation of the “type” field to read “The type of the weapon” instead of “The type of the vehicle”. Thank you IMI E D I C for pointing this out.

Effective Date
May 13, 2016 at 8:00 PM PT

Description
Reconfigured and removed some caching layers in the Stats service.

Effective Date
May 16, 2016 at 2:00 PM PT

Description
Corrected an error in Metadata documentation.

API Changes
Events for Match

  • Updated endpoint documentation to include HTTP 503 Status Code responses.Post-Game Carnage Report for Arena, Campaign, Custom, and Warzone

  • Updated endpoint documentation to include HTTP 503 Status Code responses.Post-Game Carnage Report for Arena and Warzone

  • Added documentation for MatchSpeedWinAmount, ObjectivesCompletedAmount, and BoostData.

Effective Date
May 20, 2016 at 12:00 PM

Description
The Stats service was deployed.

API Changes
Events for Match

  • The HTTP header for “Content-Type” is now correctly reported as “application/json”.

Effective Date
August 5, 2016 at 4:00PM PT
Description
New APIs have been exposed that provide metadata about player-created content (maps and game variants).
API Changes
UGC – Get Game Variant

  • This is a new API that queries for a game variant by its resource ID. This can be used to query for metadata for a custom game variant in a custom game.UGC – Get Map Variant

  • This is a new API that queries for a map variant by its Resource ID. This can be used to query for metadata for a custom map variant in a custom game.UGC – List Game Variants

  • This is a new API that queries for all of the game variants created by a player.UGC – List Map Variants

  • This is a new API that queries for all of the map variants created by a player.