This page explains the page limits we enforce on our API endpoints to ensure system reliability and outlines how you can efficiently retrieve all the data you need.
What is the Page Limit?
A page limit is a restriction on the maximum number of items returned from a single API call.
To ensure optimal performance and fair usage across all users, we enforce a limit of 1,000 items per page for most endpoints.
If you attempt to exceed this limit in a single request, the API will respond with a 422 - Unprocessable Content error.
Why We Enforce Limits
We apply page limits to ensure our service remains:
Stable and Responsive: It prevents any single, large request from overwhelming the server or causing slow response times for other users.
Equitable: It prevents any application from unfairly monopolising shared API resources.
Secure: It protects the system against traffic spikes or unintended performance issues.
How to Work Within the Page Limits
To efficiently retrieve large datasets while respecting the 1,000-item limit, follow these best practices:
Optimise queries: Only retrieve the data you absolutely need by using appropriate filters and parameters in your request URL.
Implement limiting logic: Implement client-side logic to respect the limits set in the documentation.
Monitor status codes: Regularly check for and handle the
422error (for page limit violations) gracefully in your application without crashing the process.
If You Exceed the Page Limit
If you exceed the page limit, you must change your client-side logic to go through as many pages as you need. Ensure your revised logic adheres to the established Rate Limits to maintain service stability.