Rate Limiting

Rate limiting is used to prevent abuse or excessive usage of an API, and ensure that the API remains available for all users.

Response headers

X-RateLimit headers are used to indicate the limit of requests that a client can make to an API.

The X-RateLimit headers include the following information:

• x-ratelimit-limit: The maximum number of requests a client can make in a given period.
• x-ratelimit-remaining: The number of remaining requests a client can make before hitting the limit.

Exceeding the limit

After the limit is exceeded, the following response will be returned:

< HTTP/2 429
< content-type: application/json
{
    "errors": [
        {
            "code": "too_many_requests",
            "message": "You have reached the limit of allowed attempts"
        }
    ]
}