Contents

Identifying Rate Limits

Recognize the rate limits that REST API responses provide and handle them in your code.

Overview

The App Store Connect API limits the volume of requests that you can submit within a specified timeframe. The limits apply to requests you send using the same API key.

Identify Limits Provided in the HTTP Header

The API presents rate limits to users in an HTTP header. Every response from the API includes an X-Rate-Limit HTTP header. Its value has the form:

user-hour-lim:3500;user-hour-rem:500;

The header info includes:

  • user-hour-lim, which indicates the number of requests you can make per hour with the same API key.

  • user-hour-rem, which shows the number of requests remaining.

In this example, you are limited to 3500 requests per hour, with 500 remaining. Actual limits can vary.

The time frame is a “rolling hour.” At any moment, the user-hour-rem value is your per-hour limit, minus the total requests you’ve made in the previous 60 minutes.

Interpret the Error Response

If you exceed a per-hour limit, the API rejects requests with an HTTP 429 response, with the RATE_LIMIT_EXCEEDED error code. See About the HTTP Status Code for more information.

Handle Exceeded Limits Gracefully

Consider rate limits as you integrate the API:

  • If you periodically call the API to check a value, throttle your requests to avoid exceeding the per-hour limit for that endpoint.

  • Manage the HTTP 429 RATE_LIMIT_EXCEEDED error in your error-handling process. For example, log the failure and queue the job to be processed again at a later time.

See Also

Essentials