Rate Limiting

🚧

Warning

It's important your API client takes into account the 429 status code and the rate limit headers to implement a retry mechanism depending on the values returned. Otherwise you may experience data loss.

The Splio's API Rate Limiting is based on the API Client's IP Address

In case the limit is reached, Splio's APIs returns an HTTP/1.1 429status code with the following JSON body and specific headers described bellow.

{ "message": "API rate limit exceeded" }

Headers sent to the API client

The headers shows the allowed limits, number of available requests, and the time remaining (in seconds) until the quota is reset.

Here’s an example headers :

rateLimit-limit: 6 // allowed limits 
rateLimit-remaining: 4  // number of available requests
rateLimit-reset: 47 // time remaining in seconds until the quota is reset

Additional headers show the time limit and the minutes still available :

x-rateLimit-limit-minute: 10 // time limit
x-rateLimit-remaining-minute: 9 // minutes still available

General Rate Limiting

RPS: HTTP requests per second