Public WebSocket API

​

WebSocket Connection Management

• Server closes websocket connection after 60 seconds of inactivity
• Inactivity is defined as no messages sent by the client

​

Maintaining Connection

• Send periodic ping messages every 50 seconds
• Handle potential connection closures gracefully in your application logic

​

Example Implementation

// Establish websocket connection
const socket = new WebSocket("wss://api.whitebit.com/ws");

// Set up periodic ping
setInterval(() => {
  if (socket.readyState === WebSocket.OPEN) {
    socket.send(JSON.stringify({
            id: 0,
            method: "ping",
            params: [],
        }));
  }
}, 50000); // Every 50 seconds

​

⤴️ Request message

• id - Integer. Should be unique to handle response for your request.
• method - String. Name of request.
• params - Array. Here you pass params for method.

​

Types of request messages

• Query (ping, candles_request, etc)
• Subscription (candles_subscribe, lastprice_subscribe, etc). Repeated subscription will be cancelled for the same data type.

​

⤵️ Response message

• id - Integer. Id of request.
• result - Null for failure, for success - look for responses below
• error - Null for success, JSON Object for failure:
  • message - Detailed text
  • code - Error code

​

Types of response messages

• Query result
• Subscription status (success/failed)
• Update events

​

Examples

​

⤴️ Request

{
  "id": 0,
  "method": "ping",
  "params": []
}

​

⤵️ Response

{
  "id": 0,
  "result": "pong",
  "error": null
}

​

⤴️ Request

{
  "id": 0,
  "method": "candles_subscribe",
  "params": []
}

​

⤵️ Response

{
  "id": 0,
  "result": {
    "status": "success"
  },
  "error": null
}

​

🔄 Update events

{
  "id": null,
  "method": "candles_update",
  "params": [] // look below for params
}