Skip to main content

Subscribe & Unsubscribe

After the WebSocket connection is open, you can subscribe or unsubscribe to channels.

Message Envelope

All client commands follow this structure:
{
  "cmd": "subscribe",
  "data": {
    "channel": "ticker",
    "symbols": ["AAPL.US", "BTCUSDT"]
  }
}

Subscribe

{
  "cmd": "subscribe",
  "data": {
    "channel": "ticker",
    "symbols": ["AAPL.US", "BTCUSDT"]
  }
}

Unsubscribe

{
  "cmd": "unsubscribe",
  "data": {
    "channel": "ticker",
    "symbols": ["AAPL.US"]
  }
}

Supported Channels

ChannelDescriptionNotes
tickerReal-time ticker updates✅ Available
depthOrder book depth updates⚠️ Partially supported
tradeTrade prints (executions)⚠️ Partially supported

Notes

  • For Forex symbols, only ticker is available.
  • depth / trade are currently supported for Stocks and Crypto.