Skip to main content
Subscribe to real-time trade executions with price, size, and side information for trading instruments. WebSocket URL: wss://api.hotstuff.trade/ws Channel: trades

​
Example Request

{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "subscribe",
  "params": {
    "channel": "trades",
    "symbol": "BTC-PERP"
  }
}

​
Parameters

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

​
Supported Methods

  • subscribe - Subscribe to trade execution updates
  • unsubscribe - Unsubscribe from trade execution updates

​
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": "trades",
            "symbol": "BTC-PERP"
        }
    }
    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": "trades",
            "symbol": "BTC-PERP"
        }
    };
    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.