Rate limiting is used to control the flow of requests coming into the Shift API. This allows for a consistent experience for all users and prevents any runaway scripts or attacks from abusing the system.
Rate limits are measured on a per-user basis, within a 1 hour window. Our default is 10,000 requests per hour–however, this may vary depending on your account type and use of the system. A user can make up to 10,000 requests within 1 hour. Once the user passes this limit, they will not be able to make any requests until the rate limit resets.
Every request to the Shift API returns HTTP headers that contain rate-limit information. You can use the information in these headers to determine your account's hourly rate limit, requests remaining this hour, and when the limit will be reset.
The following headers are returned with all Shift API requests:
X-RateLimit-Reset: 1452270749 X-RateLimit-Limit: 10000 X-RateLimit-Remaining: 4578
Once a user reaches the rate limit, that user will no longer be able to make requests until the date/time noted in the X-RateLimit-Reset header. If a user attempts to make a request after the rate limit is exceeded, the response will be an HTTP status code of 420.
Updated 2 months ago