/General

Errors

Draft: Status codes and the error body are a proposal pending the API contract.

HTTP Status Codes

The API uses standard HTTP status codes to indicate the success or failure of a request. Codes in the 2xx range indicate success; codes in the 4xx range indicate a client error; codes in the 5xx range indicate a server-side problem.

StatusNameDescription
200OKRequest succeeded.
400Bad RequestMissing or invalid parameters.
401UnauthorizedMissing or invalid credentials.
404Not FoundUnknown endpoint, or no data found for the given parameters.
405Method Not AllowedOnly GET requests are supported.
500Internal Server ErrorSomething went wrong on our end.

Error Response Format

Error responses return the relevant HTTP status code with a JSON body containing a single error field that describes what went wrong:

{ "error": "Unknown parameter: ccy. Did you mean currency?" }