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

Auction

Receive
/v1/cefi/market
Server

Message sent from server containing the latest opening-auction indicative for a subscribed instrument. A status of INVALID indicates the instrument is not currently in an opening auction; updates are emitted while an auction is in progress, plus one final zeroed update (status INVALID) when the auction completes.

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

Messages

  1. payload
seqnum*string

Current sequence number of the channel.

channel*"AUCTION"
Value in"AUCTION"
update*string

SNAPSHOT is sent upon subscription with the current indicative. UPDATE is sent while an opening auction is in progress, on a timer and after each book change, plus once with a zeroed payload (status INVALID) when the auction completes.

Value in"SNAPSHOT""UPDATE"
data*
Example
{  "seqnum": "string",  "channel": "AUCTION",  "update": "SNAPSHOT",  "data": {    "type": "OPENING",    "indicative_price": "string",    "matched_volume": "string",    "projected_best_bid_price": "string",    "projected_best_ask_price": "string",    "timestamp": "string",    "status": "INVALID",    "symbol": "string"  }}