 |
The Halo: Reach Stats API has been discontinued as of March 31st, 2012. The API is only serving historical data at this time. |
Getting started
Curious about the Halo: Reach Stats API? You have come to the right place! If you are new to developing using APIs (Application Programming Interfaces) or could use a knowledge refresher, begin with the "Things Every Developer Should Know" section below. If you are a more experienced developer, feel free to find more specific documentation regarding this API under the section "So You've Been Around the Block Before".
Contents |
[edit] Things Every Developer Should Know
Bungie is making the statistics data from Halo: Reach available to the world through the use of the Halo: Reach Stats API (or Application Programming Interface). An API is an interface implemented by one software application that allows it to communicate with another software application. The Halo: Reach Stats API is an effective way to communicate statistics data from the Bungie servers to other applications, such as web applications. Another way to think of the Stats API is as a web service.
[edit] Accessing the API
[edit] API Key
Before you can take the API out for a spin, you will need to obtain an API key. To learn how to obtain one, please refer to the API key documentation page. With your API key in hand, your journey can begin!
[edit] API Endpoints
The Halo: Reach Stats API offers three endpoints, RESTful JSON or XML (this endpoint has since been deprecated), or SOAP. One of the first steps on your way to using the API is to choose one of these three endpoints.
[edit] Development Languages
The API and its data can be accessed using several different development languages. Below you will find a list of a few of the commonly used languages with links to additional resources.
[edit] PHP
PHP, which stands for PHP: Hypertext Preprocessor (Yes, that is a Recursive acronym) is a widely used scripting language that is often utilized in web development. For more information on PHP, you can visit http://php.net/.
[edit] .NET (C#)
C#, a programming language for Microsoft's .NET Framework is also widely used in software development.
[edit] So You've Been Around the Block Before
For the more experienced developer, the following documentation and resources should come in handy.
[edit] API Rate Limits and Policies
Currently, the Halo: Reach Stats API throttles requests. Each API key allows up to 5 requests per second (300 per minute). Going over your limit returns an error. The ideal solution is to utilize caching. For example, caching every 15 minutes should be more than sufficient for your application.
Additionally, use of the API requires your agreement to abide by the Terms and Conditions.
[edit] Available Methods
The Halo: Reach Stats API currently contains thirteen methods to access the API. These thirteen methods can be further broken down into three groups: Game, Player, and File. Successfully and efficiently managing the API methods is an important part of your application. Each method that is called counts as one request to the API.
[edit] Code Library
As developers familiarize themselves with the API and improve their applications, code examples and samples will be provided.
- For more information on incorporating player emblems in your application, please refer to the Emblems resource page.
- For details on player models and their generation, see the Player model resource page.
- For more details on how to interpret and properly use the date and time formats please refer to the Date time format page.
[edit] Examples
- Working demo: Using the Halo Reach API with JQuery and YQL
