Throttling best practices and recommendations

HTTP/1.1 429 Too Many Requests
Retry-After: 8

{ 
  "code": 429, 
  "status": "TooManyRequests", 
  "retryAfterSeconds": 8, 
  "error": "APIClientRequestRateLimitExceeded", 
  "errorCode": 1199, 
  "errorMessage": "The client has exceeded the maximum API request rate and is being throttled" 
} 

​

Mitigating throttling issues

1. Review request rate
   • Analyze why you’re sending a high volume of requests.
   • Evaluate ways to lower the request rate for specific player or title entities targeted by the API.
   • To see which APIs and callers are approaching or reaching a limit, check the api_rate_limit_alert event (preview).
2. Batching API calls
   • Reduce frequency by batching API calls.
   • Example: Batch profile updates every 10 seconds instead of updating every second.

​

Key takeaways

• Throttling errors prompt an HTTP 429 response with details on the nature of the error.
• Use the Retry-After and “retryAfterSeconds” property to determine the wait time before making another request.
• Evaluate the necessity of high-frequency requests and optimize accordingly.
• Implement batching strategies to alleviate throttling concerns and enhance overall system efficiency.

​

See also

• Economy v2 Limits