Standards and Conventions

computer

Each HTTP request must contain the header Accept: application/json. You should also send an Accept-Encoding: deflate, gzip header to receive data fast and efficiently.

Typical Endpoint Response Format

All endpoints return data in JSON format with the results of your query under data if the call is successful.

A status object is always included for both successful calls and failures when possible. This object always includes the current time on the server when the call was executed as timestamp. Any details about errors encountered can be found under the error_code and error_message.

If the result field is set to OK it indicates that the request was successful.

Pagination (in which the results are spread across multiple requests) are indicated using the pages value which indicates the total number of pages.

{
  "data": [],
  "status": {
    "current_page": 1,
    "error_code": 200,
    "error_message": "",
    "pages": 1,
    "result": "OK",
    "timestamp": "2018-06-06T07:52:27.273Z"
  }
}