Message Format

Our WebSocket API uses JSON-formatted messages for all communication.

Request Format

All requests follow a consistent structure:

Code
 
{
  "id": "1",
  "method": "METHOD_NAME",
  "params": {...}
}

Response Format

Successful responses include the request ID and result:

Code
 
{
  "id": "1",
  "status": 200,
  "result": {...}
}

Error Response

Error responses include error details:

Code
 
{
  "id": "1",
  "status": 401,
  "error": {
    "code": -1002,
    "msg": "Authentication required"
  }
}

Error Codes