Account Quotas

 

ON THIS PAGE      Show

 

 

 

 

Description

Returns API throttling/quota information for your account.

Request

Required Request Header

  • x-api-key. Specifies the API key to authorize the request. The x-apikey header is also currently supported.

Optional Request Header

  • Accept-Encoding. Compresses the response to the gzip format. The valid value is gzip.

Request URI

  • Method: GET

  • Request URI (must be URL-encoded):

    https://api.ap.org/media/v[{version}]/account/quotas

Base URI Parameter

  • version (optional). The API version; for example, 2.0. When this parameter value is not specified, the API version set as default for your account is returned.

Request URI Example

https://api.ap.org/media/v/account/quotas

Response

The Account Quotas method returns the standard HTTP status code of "200 - OK" and the throttle/quota information for the specified API key in the JSON format.

For information about error codes, see API Codes.

Top-Level Properties

  • api_version. The API version.
  • api_mode. The API mode; for example, "live" or "preview."
  • id. The response ID.
  • method. The API method name and HTTP method.
  • params. Parameters used in the API request.
  • data. Contains the data and metadata associated with the response.

Response Descriptive Properties

  • id. The Account Quotas URL.
  • title. The response name.
  • updated. The date and time (in UTC) when the response was generated.
  • quotas. Contains the account's throttle/quota information (for example, the limit on the number of queries per minute).
    • method. The API method to which the throttle/quota applies. Possible values are search, feed, account, download, ondemand, item, other.
    • limit. The maximum number of calls allowed during a certain interval; for example, per minute.
    • period. The interval for limiting the number of calls; for example, 'PT1M' indicates that the number of queries is limited per minute. For possible values, refer to ISO 8601 Durations.

 

  Note

 

If calls using a certain method are not controlled by a quota, "limit": 0, "unlimited": true is returned for that method.

 

 

 

Sample Response

{
 "api_version": "v",
 "api_mode": "live",
 "id": "0927153727a167Z37a125",
 "method": "quotas.get",
 "params": {},
 "data": {
    "id": "/quotas",
    "title": "AP Media API Account Quotas",
    "updated": "2020-07-02T15:13:42.927Z",
    "quotas": [
      {
        "method": "search",
        "limit": 10,
        "period": "PT1M"
      },
      {
        "method": "search",
        "limit": 500,
        "period": "P1D"
      },
      {
        "method": "feed",
        "limit": 20,
        "period": "PT1M"
      },
      {
        "method": "account",
        "limit": 40,
        "period": "PT1M"
      },
      {
        "method": "download",
        "limit": 20,
        "period": "PT1M"
      },
      {
        "method": "ondemand",
        "limit": 20,
        "period": "PT1M"
      },
      {
        "method": "item",
        "limit": 30,
        "period": "PT1M"
      },
      {
        "method": "other",
        "limit": 0,
        "unlimited": true
      }
    ]
  }
}