A rate limit is the number of API requests an integration partner can do within a given time period. If this limit is exceeded, further API requests will be blocked. All API requests are subject to rate limits.
Each integration partner is granted a default rate limit. Contact [email protected] if the default rate limit is not sufficient.
There are two different values used to calculate the rate limit.
Replenish rate
The number of API requests replenished each second.
Burst capacity
Burst capacity is the maximum number of requests in a single second. It allows temporary bursts of requests while decreasing the available requests for the upcoming seconds.
For example, with a replenish rate of 2 and burst capacity of 10, a steady rate of 2 requests / second is possible. If a partner sends ten requests during a single second, the capacity for the upcoming 4 seconds is used, and requests will be blocked for that time period.
When the rate limit is exceeded, the API will respond with HTTP 429 - Too Many Requests.
Response headers
X-RateLimit-Remaining
The number of API requests remaining within the time cycle (one second).
X-RateLimit-Replenish-Rate
The replenish rate.
X-RateLimit-Burst-Capacity
The burst capacity.
