Skip to Content

Rate Limiting

To ensure fair usage and maintain the stability and performance of the Checkbook API for all users, we implement rate limiting on the number of requests you can make within a specific time window for some endpoints. Understanding these limits is crucial for building robust applications that can handle potential throttling. Rate limiting helps to:

  • Prevent Abuse: Protect the API from malicious or accidental overuse that could impact other users.
  • Ensure Fair Usage: Distribute API resources equitably among all integrators.
  • Maintain Performance: Prevent individual applications from overwhelming the API infrastructure.
  • Improve Reliability: Ensure the API remains responsive and available to everyone.

The specific rate limits applied to your API keys may vary depending on your plan and usage patterns. While we don’t publish exact, universally fixed limits to allow for flexibility and adjustments as needed, the following general principles apply:

  • Different Endpoints, Different Limits: Some API endpoints, especially those involving more resource-intensive operations, might have stricter limits than others.
  • Time Windows: Rate limits are typically enforced within specific time windows (e.g., per second, per minute, per hour).

Detecting Rate Limits

If your application exceeds the allowed rate of requests, the Checkbook API will return a 429 Too Many Requests HTTP status code. The response body may also include information about when you can retry your request, often provided in headers like:

  • Retry-After: This header specifies the number of seconds to wait before making subsequent requests.

Handling Rate Limits

To avoid hitting rate limits and ensure a smooth integration, follow these best practices:

  • Design Efficient Integrations: Optimize your API calls to retrieve only the necessary data and avoid making redundant requests.
  • Implement Throttling and Backoff: Your application should be designed to handle 429 responses gracefully. Implement logic to pause requests and retry after the recommended Retry-After interval. Consider using exponential backoff strategies (increasing the delay between retries) to avoid overwhelming the API after being throttled.
  • Monitor Your Usage: Keep track of your API request volume to anticipate potential rate limit issues, especially during peak usage periods.
  • Use Webhooks: For asynchronous events, consider using Checkbook’s webhooks instead of constantly polling the API. This can significantly reduce your API request volume.
  • Batch Operations (Where Applicable): If the API supports batch operations for certain tasks, use them to perform multiple actions in a single request, reducing the overall number of API calls.
  • Cache Data: If your application frequently requests the same data that doesn’t change rapidly, consider implementing caching mechanisms to reduce the need to repeatedly fetch it from the API.

Determining Your Rate Limits

While specific limits are not publicly documented, you can generally infer them through careful observation during development in the sandbox environment. Pay attention to when you start receiving 429 errors.

If you anticipate needing higher rate limits for your application due to specific use cases or high transaction volumes, please contact our support team to discuss your requirements. We can review your needs and potentially adjust your limits accordingly.

By understanding and adhering to our rate limiting policies, you can build reliable and scalable integrations with the Checkbook API while ensuring a consistent experience for all users.

Last updated on