Request/Response Format

REST API request, response format

Request Format

All API requests are in either GET or POST method. For GET request, all parameters are path parameters. For POST request, all parameters are in POST body and in JSON format.

Response Format

All response will be returned in JSON format. The top level JSON is a wrapper object which has metadata "status". The actual per API response data is in "data" field. Response JSON Wrapper Content

Success response

{
    status: "success",
    data: {}
}

Fail response

{
  "status": "error",
  "code": 1112,
  "message": "BAD_SYMBOL",
  "data": null
}

Last updated