Skip to main content
Subscribe to real-time best bid and offer (BBO) data showing top-of-book prices and sizes. WebSocket URL: wss://api.hotstuff.trade/ws Channel: bbo

​
Example Request

{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "subscribe",
  "params": {
    "channel": "bbo",
    "symbol": "BTC-PERP"  // support "all"
  }
}

​
Parameters

ParameterTypeRequiredDescriptionExample
jsonrpcstringYesJSON-RPC version"2.0"
idstring/numberYesRequest identifier for tracking"1" or 1
methodstringYesAction to perform"subscribe" or "unsubscribe"
channelstringYesChannel name"bbo"
symbolstringYesTrading symbol or “all”"BTC-PERP", "ETH-PERP", "all"

​
Supported Methods

  • subscribe - Subscribe to best bid/offer updates
  • unsubscribe - Unsubscribe from best bid/offer updates

​
Supported Symbols

  • Individual symbols: BTC-PERP, ETH-PERP, etc.
  • All symbols: "all"

​
WebSocket Client Examples

​
Python

import websocket
import json

def on_message(ws, message):
    print(f"Received: {message}")

def on_open(ws):
    subscribe_msg = {
        "jsonrpc": "2.0",
        "id": "1",
        "method": "subscribe",
        "params": {
            "channel": "bbo",
            "symbol": "BTC-PERP"  # or "all"
        }
    }
    ws.send(json.dumps(subscribe_msg))

ws = websocket.WebSocketApp("wss://api.hotstuff.trade/ws",
                          on_message=on_message,
                          on_open=on_open)
ws.run_forever()

​
JavaScript

const ws = new WebSocket('wss://api.hotstuff.trade/ws');

ws.onopen = function() {
    const subscribeMsg = {
        "jsonrpc": "2.0",
        "id": "1",
        "method": "subscribe",
        "params": {
            "channel": "bbo",
            "symbol": "BTC-PERP"  // or "all"
        }
    };
    ws.send(JSON.stringify(subscribeMsg));
};

ws.onmessage = function(event) {
    console.log('Received:', event.data);
};
Note: The “Try It” button above uses HTTP requests, which won’t work for WebSocket connections. Use the WebSocket client examples instead.