WebSockets

​

Use cases

​

Endpoint

wss://api.radion.app/ws

​

Quickstart

import WebSocket from "ws";

const ws = new WebSocket("wss://api.radion.app/ws", {
  headers: { "X-API-Key": process.env.RADION_API_KEY },
});

ws.on("open", () => {
  ws.send(
    JSON.stringify({ action: "subscribe", id: "s1", channel: "trading" })
  );
});

ws.on("message", (raw) => {
  const frame = JSON.parse(raw.toString());
  console.log(frame.type, frame.channel, frame.data);
});

1. Connect — open the socket with your X-API-Key header.
2. Subscribe — send a subscribe message with the channel name (and filters if you want).
3. Receive — read the JSON frames that come back. Each one has a type, a channel, and a data payload.

​

Channels at a glance

​

Connection lifecycle

1. Open — start the WebSocket connection with your API key in the upgrade header.
2. Authenticate — Radion checks the key and accepts the connection. A bad key returns HTTP 401.
3. Subscribe — send one or more subscribe messages to start getting frames on the channels you name.
4. Receive frames — handle the JSON event and control frames until you are done or an error happens.
5. Reconnect — if the connection drops, connect again with exponential back-off, then send your subscriptions again. See Connection state for heartbeat and reconnect tips.

​

Further reading