Skip to content

API errors

API errors produce responses with various error codes and a JSON object in the response payload with the following fields:

NameTypeDescription
messagestringError message.

400 Bad Request

The search query in the request body or the request headers are invalid.

ts
{
    "message": "query is required"
}

401 Unauthorized

Partner key is not valid or not provided in X-Partner-Key request header.

ts
{
    "message": "\"X-Partner-Key\" request header with partner key is required"
}

429 Too Many Requests

Requests limit is exceeded.

ts
{
    "message": "API key reached requests limit. Retry after 24 seconds."
}

Also a response contains Retry-After header with number of seconds to wait until the next request.

500 Internal Server Error

An internal (unspecified) API error.

ts
{
    "message": "Internal server error"
}