Rate limiting

To ensure consistent performance and fair access to the API, reasonable rate limits are enforced on API endpoints.

Whilst rate limits are not currently published, reasonable limits have been applied based on intended use in real-world applications.

If your application exceeds rate limits, an HTTP 429 (Too Many Requests) status code is returned. The response contains a Retry-After header indicating the number of seconds you need to wait before retrying the request. The response body also contains an error with code rate_limited.

Example:

1
{
2
  "type": "https://developer.yoco.com/docs/api/error-codes/rate-limited",
3
  "title": "Too Many Requests",
4
  "detail": "You have exceeded the rate limit for this API end-point.",
5
  "status": 429,
6
  "code": "rate_limited"
7
}

You should implement your own retry logic that gracefully handles 429 errors and respects the Retry-After header.