Best practices

We expect all developers to follow the best practices set out in our documentation to ensure the API works well for everyone. Using the API responsibly helps prevent issues that could affect other users. Try to avoid making too many requests in a short time or using the API in ways that might slow down service for others. Let's keep the API efficient and reliable for everyone's benefit.

Rate limiting

We apply rate limits to our GraphQL API to ensure fair access for all users and to prevent misuse. These limits are documented on the API limiting page. As we continue to learn from usage patterns, we'll adjust these limits. Your feedback is crucial to us, so please share your experiences and suggestions.

Avoiding hitting limits

Most users can avoid our rate limits by using our APIs efficiently. Here are a few strategies to help you stay within the limits.

Don't use Polling

We highly recommend against using polling to fetch updates from our API. In the future, we will introduce subscriptions to notify you of updates automatically. As our API develops, we will include subscriptions, which will inform you when certain updates are made. In the meantime, if you absolutely need to poll, please get in touch with our team in advance so we can advise you best.

Cache responses

Save the results of queries locally when you expect to need the same data multiple times.

Use filtering to avoid fetching unnecessary data

Use our filtering options to request only the data you need. This helps you focus on specific records and can often eliminate the need for pagination.

Optimize Queries

Only request the data you really need, and avoid unnecessary or overly complex queries.