API rate limits

From Halo: Reach API Wiki
Jump to: navigation, search
This article is a stub. You can help improve the wiki by expanding it.

Contents

[edit] Summary

The Rate Limit is how many requests a specific API key may make to the API per second.

The Halo: Reach stats API throttles requests. Currently the rate limit threshold is set to a maximum of 5 requests per second (300 per minute) per API key. As soon as an API key's requests eclipse this threshold, the server will return an error.

NOTE: The Rate Limit may be adjusted at any time to fall in line with bandwidth usage.

[edit] Exceeding the limit

  • Once the number of requests per minute exceeds the rate limit amount, you will get an error response back until the next minute.

[edit] Example

If the rate limit is established as 5 requests per second (300 per minute) and you are making your 301st request at 45 seconds, you will receive an error message for 15 seconds. After that you will have x amount of requests you can make each minute.

[edit] Recommended Solutions

Due to performance issues for both Bungie and the end user, it is usually profitable for the API client to cache data that it has gathered from the API. For example, caching stats from games or a user's Player model URL.

  • It is Recommended to NOT grab a user's stats more than once every 15 minutes.
  • You should only ever call the GetGameMetadata function periodically (in case some resources ID's have changed) and cache its data.
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox