Skip to main content

Rate Limiting and Throttling

Rate Limiting

Rate limiting of the Pigeonhole Live API is considered per Workspace Token or OAuth User.

All our API endpoints require authentication. Regardless of the authentication method, the Pigeonhole Live API allows performing requests according to the plan.

The Pigeonhole Live API rate limit window duration is 24 hours.

Each Pigeonhole Live API request will include the following rate limit response headers.

  • X-RateLimit-Limit: The maximum number of requests current Workspace Token or OAuth User can perform per 24-hour window.
  • X-RateLimit-Remaining: The number of requests left for the 24-hour window.
  • X-RateLimit-Reset: Time at which the rate limit resets. The value is in UTC epoch seconds.

For example, after a request has been made, the API response headers would look like this:

X-RateLimit-Limit: 40
X-RateLimit-Remaining: 39
X-RateLimit-Reset: 1587352369

If you exceed the rate limit, our API will start rejecting your requests and you'll receive an error response of HTTP 429 "Too Many Requests" and the body:

{
  "code": 8000,
  "message": "API rate limit exceeded"
}

Throttling

Regardless of your account plan, the Pigeonhole Live API throttles requests based on the number of requests in a given amount of time.

This mechanism helps to prevent our API from being overwhelmed by too many requests. The throttling limit can change over time and also depends on our servers limit and internal strategies.

info

Throttled requests will not be counted in your plan usage.

In this scenario, your requests will be rejected and you'll receive an error response of HTTP 503 "Service Unavailable" and the body:

Service Unavailable