For AI agents: the documentation index is at /llms.txt, and this page is available as Markdown at /api/websocket/institutional/subscribe.md.
Subscribe
Message sent to server indicating what channels and data the user would like to subscribe to.
const payload = { "item_names": [ "string" ], "channels": [ "INSTRUMENT" ], "timestamp": "string", "type": "SUBSCRIBE", "organization_id": "string", "key": "string", "signature": "string"};const socket = new WebSocket("wss://api.truemarkets.co/v1/cefi/market");socket.addEventListener("open", () => { socket.send(JSON.stringify(payload));});- payload
Authenticated request (SUBSCRIBE or UNSUBSCRIBE) requiring credentials.
type?string"SUBSCRIBE""UNSUBSCRIBE"item_names?array<string>List of items the request is intending to act upon. For market data channels (INSTRUMENT, EBBO, DEPTH, TRADE, AUCTION), this contains instrument symbols. For the INDEX channel, observable ids as strings. For the DROPCOPY channel, this contains client IDs as strings.
channels?array<>List of channels the request is intending to interact with. Note: DROPCOPY channel requires authentication. HEARTBEAT applies to the connection and ignores item_names.
timestamp?stringRequired field on all requests; a UTC Unix epoch in seconds. Must not be in the future and must be no older than 15 seconds relative to server time.
organization_id*stringkey*stringsignature*string{ "item_names": [ "string" ], "channels": [ "INSTRUMENT" ], "timestamp": "string", "type": "SUBSCRIBE", "organization_id": "string", "key": "string", "signature": "string"}