All API responses follow the structure outlined below: The top-level response contains four fields: code, msg, timestamp, and data. The actual business data is contained within the data object. The example fields in the API response parameters refer to the fields inside data.

​
Response Parameters

Parameter NameData TypeDescription
codeintResponse code
msgstringError message (if any)
timestampstringTimestamp when the request was completed
dataobjectMain body of the API response data

​
Response Example

{
    "code": 200,
    "message": "success",
    "timestamp": "1724125848133",
    "data": {
        // per API response data in nested JSON object
    }
}