WebSocket API

v1.0.0

Real-time data streaming for options trading

📡orderbook

L2 orderbook updates for all symbols

{
  "type": "Subscribe",
  "channel": "orderbook"
}

Messages

Connection

WSSwss://api.hypercall.io/ws

AuthenticationAdd ?wallet=0x... for authenticated channels

HeartbeatServer sends Ping every 20s, expects Pong within 60s

Quick Start

// Connect to WebSocket
const ws = new WebSocket("wss://api.hypercall.io/ws?wallet=0xYourWallet");

// Subscribe to channels
ws.onopen = () => {
  ws.send(JSON.stringify({ type: "Subscribe", channel: "orderbook" }));
  ws.send(JSON.stringify({ type: "Subscribe", channel: "fills" }));
};

// Browsers reply to Ping frames automatically.
// Many websocket libraries, including tungstenite, do too.
// Raw socket clients must handle Ping/Pong themselves.

// Handle messages
ws.onmessage = (event) => {
  const msg = JSON.parse(event.data);
  console.log(`Received: ${msg.type}`);
};

Download AsyncAPI Spec Full Documentation