This method retrieves the call limit and utilization data for an application user. The call-limit data is returned for all RESTful APIs and resources that limit calls on a per-user basis.
The response from getUserRateLimits 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 that limit request access by user. 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.
|api_name||string||This optional query parameter filters the result to include only the APIs specified. Example values are |
|api_context||string||This optional query parameter filters the result to include only the specified API context. Acceptable values for the parameter are |
All requests made to eBay REST operations require you to provide the
Authorization HTTP header for authentication authorization.
This method has no additional required headers. See HTTP request headers- opens rest request components page for details.
This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
See OAuth access tokens for more information.
This call has no payload.
This call has no field definitions.
This call has no response headers.
|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.
The context of the API for which rate-limit data is returned. For example
The name of the API for which rate-limit data is returned. For example
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
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.
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.
The remaining number of requests that can be made to this resource before the associated time window resets.
The data and time the time window and accumulated calls for this resource reset.
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.
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
|500||Internal Server Error|
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.|
This call has no warnings.
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.
This example shows call how to retrieve the call-limit data for all the resources that limit requests on a per-user basis.
This method does not use a request body. However, you can use the api_name and api_context query parameters to control the data returned in the response.
A successful request for a call that does not specify any query parameters returns a list of call-limit data for all the supported resources.