Access to the Open Data API is typically subject to rate limiting: if you submit too many requests within a short period of time, you will be unable to submit further requests to the API until your limit resets. This is to ensure that the API performs well for all users and that it is not possible for a single application to overload the server.
From version 9.9.1, the system administrator can choose to set different limits for the
/table endpoints (prior to version 9.9.1 a single limit applied to both), and can choose to turn off rate limiting entirely (although this is not recommended). By default, the Open Data API is configured to allow any given API key to submit up to 100 table requests per hour, but a different limit may have been set on your system.
Check Your Rate Limit
/rate_limit endpoint returns endpoint returns information about your current rate limit.
Please note that:
- Prior to version 9.9.1 there was only a single rate limit, with one endpoint
/rate_limitfor checking your current limits.
- From 9.9.1 onwards there are three limits: a global setting, as well as individual settings for the
/schemaendpoint and the
/tableendpoint. Use the endpoints
/rate_limit_tableto check each individual limit.
In addition, if rate limiting is configured, all requests return the 3 relevant
X-RateLimit headers, allowing you to check your rate limit at any time without having to submit a specific request.
|Submitting a request to the |
Following is an example response. In this example the API key has 100 requests remaining (from a configured rate limit of 100). This allocation will be reset at UNIX timestamp 1451001600000 (25/12/2015 at midnight UTC).