Standards and Conventions

Each request must contain the header Accept: application/json. You should also send an Accept-Encoding: deflate, gzip header to receive data fast and efficiently (will be supported in the future).

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

Endpoint Response Payload 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. The Status object always includes the current time on the server when the call was executed as a timestamp.

{
    "data" : {
    ...
    },
    "status": {
        "timestamp": "1688555980233",
        "errorCode": 400,
        "errorMessage": "Invalid value for \"id\"",
   }
}