For AI agents: the documentation index is at /llms.txt, and this page is available as Markdown at /api/websocket/institutional/heartbeat.md.

Heartbeat

Receive
/v1/cefi/market
Server

Message sent to a connection subscribed to the HEARTBEAT channel after 10 seconds with nothing else sent to it, so clients can tell a quiet feed from a dead connection.

Code Sample
const socket = new WebSocket("wss://api.truemarkets.co/v1/cefi/market");socket.addEventListener("message", (event) => {  console.log(event.data);});

Messages

  1. payload
timestamp?string

Server UTC time the heartbeat was sent, in nanoseconds since the Unix epoch.

channel?"HEARTBEAT"

Channel this message originated from.

Value in"HEARTBEAT"
update?"HEARTBEAT"

Type of update for the current message.

Value in"HEARTBEAT"
Example
{  "timestamp": "string",  "channel": "HEARTBEAT",  "update": "HEARTBEAT"}