Halo: Reach API Reference
This has been taken from the Halo: Reach Stats API Reference released on September 7, 2010. I wasn’t terribly happy with how the documentation was styled so I thought I’d throw up another copy over here.
The official documentation can be found here and will always be up to date. I’ll try and make sure to update this page whenever I spot changes. Have something to contribute? Send me an email to steve at dnite dot org. Enjoy!
This is a collection of methods to access the Halo: Reach game, player, and file information. They are available as a .NET 4.0 WCF service with two endpoints. To enforce consistency between the different protocols, both endpoints follow this interface. Each protocol may be accessed through its associated endpoint located at http://www.bungie.net/api/reach/. The available endpoints are reachapijson.svc for JSON REST queries, and reachapisoap.svc for legacy SOAP XML support. Note that the examples given in this documentation use the REST syntax, documentation for SOAP Web services is not available. Consult your development environment’s (Visual Studio) documentation for more information. No official support is available other than this documentation.
Note: identifier is always your application’s API key string. This is used to ensure we know who’s application is making the statistics call. Unregistered applications will not work.
GetGameMetadata(String)
This function returns no dynamic data, but rather is used to translate resource ids into full resources (medals, commendations, etc.)
- identifier: Your application’s identifier string.
Return Value: An object containing several dictionaries that can be used to translate the various ids of resources into more detailed versions.
http://www.bungie.net/api/reach/reachapijson.svc /game/metadata/ {identifier}
GetGameHistory(String, String, String, String)
This function is used to browse through a player’s history of games.
- identifier: Your application’s identifier string.
- gamertag: The target player’s gamertag.
- variant_class: The variant class of game to get. Valid values are “Campaign”, “Firefight”, “Competitive”, “Arena”, “Invasion”, “Custom”. Pass “Unknown” to get all games.
- iPage: The page of results you want, starting at page 0.
Return Value: A GameHistoryResponse object containing a list of the games matching the criteria you specified.
http://www.bungie.net/api/reach/reachapijson.svc /player/gamehistory/ {identifier}/{gamertag}/{variant_class_string}/{iPage}
GetGameDetails(String, String)
This function allows you to access detailed information about a single game.
- identifier: Your application’s identifier string.
- gameId: The requested game id.
Return Value: A GameDetailsResponse object containing highly detailed statistics on the game.
http://www.bungie.net/api/reach/reachapijson.svc /game/details/ {identifier}/{gameId}
GetPlayerDetailsWithStatsByMap(String, String)
Returns detailed aggregate information on a player, including arena information.
- identifier: Your application’s identifier string.
- gamertag: The player you want to find.
Return Value: A PlayerDetailsResponse object that contains detailed aggregate statistics.
http://www.bungie.net/api/reach/reachapijson.svc /player/details/bymap/ {identifier}/{gamertag}
GetPlayerDetailsWithStatsByPlaylist(String, String)
Returns detailed aggregate information on a player, including arena information.
- identifier: Your application’s identifier string.
- gamertag: The player you want to find.
Return Value: A PlayerDetailsResponse object that contains detailed aggregate statistics.
http://www.bungie.net/api/reach/reachapijson.svc /player/details/byplaylist/ {identifier}/{gamertag}
GetPlayerDetailsWithNoStats(String, String)
Returns basic information about a player.
- identifier: Your application’s identifier string.
- gamertag: The player you want to find.
Return Value :A PlayerDetailsResponse object with only basic information and no arena stats or aggregate stats.
http://www.bungie.net/api/reach/reachapijson.svc /player/details/nostats/ {identifier}/{gamertag}
GetPlayerFileShare(String, String)
Returns a listing of files in a player’s file share.
- identifier: Your application’s identifier string.
- gamertag: The player’s gamertag.
Return Value: A FileResponse object containing a listing of files.
http://www.bungie.net/api/reach/reachapijson.svc /file/share/ {identifier}/{gamertag}
GetFileDetails(String, String)
Returns information on a specific file.
- identifier: Your application’s identifier string.
- fileId: The id of the file to access.
Return Value: A FileResponse object containing the single file’s information.
http://www.bungie.net/api/reach/reachapijson.svc /file/details/ {identifier}/{fileId}
GetPlayerRecentScreenshots(String, String)
Returns a player’s recent screenshots.
- identifier: Your application’s identifier string.
- gamertag: The player’s gamertag.
Return Value: A FileResponse object return a listing of the recent screenshots uploaded by a user.
http://www.bungie.net/api/reach/reachapijson.svc /file/screenshots/ {identifier}/{gamertag}
GetPlayerFileSets(String, String)
Returns a list of file sets.
- identifier: Your application’s identifier string.
- gamertag: The player’s gamertag.
Return Value: A FileResponse object containing a list of file set names and their ids.
http://www.bungie.net/api/reach/reachapijson.svc /file/sets/ {identifier}/{gamertag}
GetPlayerFileSetFiles(String, String, String)
Returns a list of files in a particular file set.
- identifier: Your application’s identifier string.
- gamertag: The player’s gamertag.
- fileSetId: The file set id as returned by GetPlayerFileSets
Return Value: A File Response object containing a list of files in a particular file set.
http://www.bungie.net/api/reach/reachapijson.svc /file/sets/files/ {identifier}/{gamertag}/{fileSetId}
GetPlayerRenderedVideos(String, String, String)
Returns a list of rendered videos created by a player.
- identifier: Your application’s identifier string.
- gamertag: A player’s gamertag.
- iPage: The page of results you want, starting at page 0.
Return Value: A FileResponse object containing a list of rendered videos.
http://www.bungie.net/api/reach/reachapijson.svc /file/videos/{identifier}/{gamertag}/{iPage}
ReachFileSearch(String, String, String, String, String, String, String, String)
Used to search for files with various available filters and sorts.
- identifier: Your application’s identifier string.
- file_category: The type of file you wish to search for. Valid values are “Image”, “GameClip”, “GameMap”, or “GameSettings”.
- MapFilter: An optional map to limit your results. Should be a valid map id, pass “null” for no filtering by map. Results are undefined when file_category is GameSettings.
- engineFilter: An optional game engine type to limit your results. Valid values are “null”, “Campaign”, “Forge”, “Multiplayer”, and “Firefight”.
- DateFilter: A required date filter. Valid values are “Day”, “Week”, “Month”, and “All”.
- SortFilter: A required sort parameter. Valid values are “MostRelevant”, “MostRecent”, “MostDownloads”, and “HighestRated”.
- iPage: The page of search results you want, starts at 0.
- tags: A semi-colon delimited list of file tags to search for, empty if you don’t wish to search by tags.
Return Value: A FileResponse object containing your search results.
http://www.bungie.net/api/reach/reachapijson.svc /file/search/{identifier}/{file_category}/{MapFilter} /{engineFilter}/{DateFilter}/ {SortFilter}/{iPage}?tags={tags}