Docs / Guides

Errors

Every error answers with a status code and a short reason you can show or log.

Format

Errors are JSON with a detail field:

Response 401

{
  "detail": "That API key is not valid"
}

Code	Meaning	What to do
`400`	You asked for more cards than your plan allows in one request.	Split the list, or move to a bigger plan.
`401`	The `X-API-Key` header is missing, or the key is not valid.	Check the header name and the key on your dashboard.
`403`	The key has been turned off, or your plan doesn't include history that long.	Check your plan on the dashboard, or ask for a shorter `timeframe`.
`404`	The path doesn't exist, such as a typo in the endpoint.	Check the path against these docs.
`411`	A POST request came without a `Content-Length` header.	Send the body with its length; HTTP clients do this for you.
`413`	The request body is too large.	Send fewer cards in one request.
`422`	A parameter is not valid: a name shorter than 2 characters, a limit above 100, an unknown timeframe and so on.	Read `detail`; it names the parameter.
`429`	You reached a limit for this minute, day or month, or Starter's daily card limit.	Wait the seconds in the `Retry-After` header.
`503`	The service is briefly unavailable or busy. The answer may carry a `Retry-After` header.	Retry with a short backoff. See the status page.

An unknown card_id is not an error. It is listed under not_found, and the cards that do exist are still returned.