The body of every response will include the following fields.
| Field | Description |
|---|---|
description | Description of the response. |
payload | The object containing the actual data requested. |
status | The status of the response. |
title | The human readable name associated with the HTTP status according to the HTTP Status Code Registry. |
Historical Data
Some endpoints have startDate & endDate parameters, but no pagination parameter. These endpoints have a limit to how much historical data can be returned per query depending on the granularity. In order to get more than the max, you must use the startDate & endDate parameters to move the time frame window to get the next n minutes/days/months of data.
Errors
In an erroneous response, the description field will indicate the reason for the error.
| Status Code | REST | WebSocket |
|---|---|---|
| 200 | Successful Request | Successful Connection |
| 400 | Bad Request – Invalid request format or query results exceed 10 MB limit | Bad Request - Invalid request format, instrument is not supported or missing parameter |
| 401 | Unauthorized – Invalid or missing API Key | Unauthorized – Invalid or missing API Key |
| 403 | Forbidden – Access to endpoint is not authorized | |
| 404 | Not Found – Pair or address does not exist for example | |
| 429 | Too Many Requests – rate limit was exceeded | |
| 5xx | Internal Server Error – We had a problem with our server | Internal Server Error – We had a problem with our server |
| 502 | Bad Gateway | |
| 504 | Gateway Timeout – Exceeded 28 second limit |
Success
A successful response will be indicated by a HTTP status code of 200 and the payload will include the desired data.