The response from getRateLimits includes a list of the applicable resources and the "call limit", or quota, that is set for each resource. In addition to quota information, the response also includes the number of remaining calls available before the limit is reached, the time remaining before the quota resets, and the length of the "time window" to which the quota applies.
By default, this method returns utilization data for all RESTful API resources. Use the api_name and api_context query parameters to filter the response to only the desired APIs.
For more on call limits, see Compatible Application Check.
Resource URI (production)
|api_context||string||This optional query parameter filters the result to include only the specified API context. Acceptable values for the parameter are |
|api_name||string||This optional query parameter filters the result to include only the APIs specified. Example values are |
HTTP request headers
This request requires an access token created with the client credentials grant flow, using one scope from the following list:
See OAuth access tokens for more information.
|rateLimits||array of RateLimit||The rate-limit data for the specified APIs. The rate-limit data is returned for all the methods in the specified APIs and data pertains to the current time window. |
|rateLimits.apiContext||string||The context of the API for which rate-limit data is returned. For example |
|rateLimits.apiName||string||The name of the API for which rate-limit data is returned. For example |
|rateLimits.apiVersion||string||The version of the API for which rate-limit data is returned. For example |
|rateLimits.resources||array of Resource||A list of the methods for which rate-limit data is returned. For example |
|rateLimits.resources.name||string||The name of the resource (an API or an API method) to which the rate-limit data applies. |
|rateLimits.resources.rates||array of Rate||A list of rate-limit data, where each list element represents the rate-limit data for a specific resource. |
|rateLimits.resources.rates.limit||integer||The maximum number of requests that can be made to this resource during a set time period. The length of time to which the limit is applied is defined by the associated timeWindow value. |
This value is often referred to as the "call quota" for the resource.
|rateLimits.resources.rates.remaining||integer||The remaining number of requests that can be made to this resource before the associated time window resets. |
|rateLimits.resources.rates.reset||string||The data and time the time window and accumulated calls for this resource reset. |
When the reset time is reached, the remaining value is reset to the value of limit, and this reset value is reset to the current time plus the number of seconds defined by the timeWindow value.
The time stamp is formatted as an ISO 8601 string, which is based on the 24-hour Universal Coordinated Time (UTC) clock.
|rateLimits.resources.rates.timeWindow||integer||A period of time, expressed in seconds. The call quota for a resource is applied to the period of time defined by the value of this field. |
For more on errors, plus the codes of other common errors, see Handling errors.
|105000||API_ANALYTICS||APPLICATION||There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.|
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.