Skip to main content
Subscribe to real-time OHLCV chart data with configurable resolution and chart type for technical analysis. WebSocket URL: wss://api.hotstuff.trade/ws Channel: chart

​
Example Request

{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "subscribe",
  "params": {
    "channel": "chart",
    "symbol": "1",
    "chart_type": "mark",
    "resolution": "1m"
  }
}

​
Parameters

ParameterTypeRequiredDescriptionExample
jsonrpcstringYesJSON-RPC version"2.0"
idstring/numberYesRequest identifier for tracking"1" or 1
methodstringYesAction to perform"subscribe" or "unsubscribe"
channelstringYesChannel name"chart"
symbolstring/numberYesSymbol identifier"1", 1, "BTC-PERP"
chart_typestringYesType of chart data"mark", "index", "oracle"
resolutionstringYesTime resolution"1m", "5m", "15m", "1h", "4h", "1d"

​
Supported Methods

  • subscribe - Subscribe to chart data updates
  • unsubscribe - Unsubscribe from chart data updates

​
Chart Types

  • mark - Mark price data
  • index - Index price data
  • oracle - Oracle price data

​
Resolutions

  • 1m, 5m, 15m, 30m - Minute intervals
  • 1h, 4h, 12h - Hour intervals
  • 1d, 1w - Day/week intervals

​
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": "chart",
            "symbol": "1",
            "chart_type": "mark",
            "resolution": "1m"
        }
    }
    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": "chart",
            "symbol": "1",
            "chart_type": "mark",
            "resolution": "1m"
        }
    };
    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.