Rate Limits
The Stannp API imposes rate limits to prevent misuse and mitigate potential instability caused by large bursts of incoming traffic.
Rate Limit Details
The majority of our APIs allow up to 300 requests per minute. The specific allowances can be seen in the following three response headers which are returned with every request.
- X-RateLimit-Limit: The total number of requests allowed.
- X-RateLimit-Remaining: The number of requests remaining for your quota.
- X-RateLimit-Reset: The time, in seconds for the quota to reset.
Exceeding Rate Limits
In the event of the rate limit being exceeded we will return a http 429 response and the request operation will not be completed. If you are finding that you are running into 429 responses often, please contact us.
Status Codes
| Status Code | Description |
|---|---|
| 429 Too Many Requests | Rate limit exceeded. Wait before making another request. |
Example Request
Here's an example of checking your user information to see the rate limit headers:
[GET]
https://ca.stannp.com/api/v1/users/me
Request Example
curl "https://ca.stannp.com/api/v1/users/me" \
-u {API_KEY}:
Response Example
{
"success": true,
"data": {
"account_id": "1",
"email": "email@example.com",
"user_id": "1",
"first_name": "John",
"last_name": "Smith"
}
}Response Headers
The following headers are included with every API response to help you monitor your rate limit usage:
{
"X-RateLimit-Limit": "300",
"X-RateLimit-Remaining": "158",
"X-RateLimit-Reset": "46",
"...": "..."
}