Too many requests error

About

Contains a too many requests error message and data. The error occurs if more requests are made within a certain period than the application allows. The HTTP response contains the Retry-After header, which indicates when it is recommended to repeat the request for its successful completion. See more Rate limiting

Fields

Name	Type	Required	Description
id	integer	Yes	Error id
error	string	Yes	Error name
message	string	Yes	Error description
metadata	object	Yes	Additional information about error. See below

Metadata

Name	Type	Required	Description
periodInMinutes	integer	Yes	rate limiting period in minutes
requestsPerPeriodAllowed	integer	Yes	available requests for period
recommendedRetryTime	date	Yes	recommended time to retry request

Example

{
  "id": 1,
  "error": "TooManyRequestsError",
  "message": "The /users/current/accounts API allows 10 requests per 60s to avoid overloading our servers. Please wait some time and retry your request or contact support to extend your quota.",
  "metadata": {
    "total": 10,
    "available": 0,
    "needed": 1,
    "resourceId": 'user:userId',
    "multiplierId": 'accountCount:userId',
    "exceededConfig": 'perAccount',
    "exceededPeriod": '60s',
    "recommendedRetryTime": "2022-05-31T09:00:52.361Z",
    "method": "getAccounts",
    "path": "/users/current/accounts"
  }
}

Usages

All responses of REST API