Skip to main content

API Rate Limits

Overview​

API rate limiting is being introduced to ensure the stability, performance, and security of the platform. This change protects the system from overuse or abuse and ensures reliable service for all users.

Rate Limiting Details​

  • Rate Limit: 200 requests per minute (subject to change).
  • HTTP Status for Rate Limits: When the rate limit is exceeded, the API will return a HTTP 429 (Too Many Requests) response.
  • Retry-After Header: The HTTP 429 response includes a Retry-After header specifying the number of seconds to wait before retrying.

This rate applies uniformly across all API users and endpoints. The limit has been calculated to accommodate a wide range of workflows, with adjustments made based on ongoing evaluations.

Implementation Timeline​

  • Staging Environment: Rate limiting will be enforced starting 31 January 2025.
  • Production Environment: Rate limiting will be enforced starting 30 June 2025.

Users are encouraged to test their integrations in the Staging environment before the Production rollout to ensure compliance and a seamless transition.

Best Practices for Handling Rate Limits​

  • Handle HTTP 429 Responses: Ensure your application handles 429 responses appropriately by reading the Retry-After header to determine when to retry requests.
  • Avoid Hard-Coding Limits: Avoid hard-coding rate limits into your application, as these limits may change globally or on a per-endpoint basis in the future.

Optimising API Usage​

If your integration relies on high-frequency polling, consider optimising your workflows:

  • Use Webhooks: Subscribe to webhooks to receive real-time notifications of changes, reducing the need for frequent polling. See our Webhook Documentation.
  • Leverage Bulk Data Retrieval: Use the Reporting API to retrieve data in bulk where possible.
  • Review Endpoint Usage: Ensure the most efficient endpoints are being used for the required data.

Requesting Support​

If you have concerns about the rate limit meeting your needs, here are some ways to ensure your integration works efficiently:

  • Evaluate your workflow to identify areas for optimisation.
  • Assess polling schedules to determine if they can be reduced or replaced with webhooks.
  • Explore whether data retrieval can be consolidated using bulk operations through the Reporting API.
  • Discuss whether additional API endpoints or webhook triggers might better meet your requirements.

Support for exploring these options is available via the standard support channels. Be sure to provide as much detail as possible about your integration and any specific challenges.

Continuous Improvement​

Rate limits will be evaluated continuously throughout the transition period. Any necessary adjustments to limits, endpoints, filters, parameters, or webhook triggers will be made to support smooth integrations and workflows. Users are encouraged to prepare early to allow sufficient time for adjustments or consultations.