Skip to main content
POST
GetMarketSummaryStreaming

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Connect-Protocol-Version
enum<number>
default:1
required

Define the version of the Connect protocol. If omitted, use 1.

Available options:
1
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json
market
market_id · object
required

Market to stream a summary for, by market_id or market_symbol.

updateIntervalMs
integer | null

Interval between stream updates, in milliseconds. Defaults to 250 when omitted or zero, and is clamped to the 100–60000 range.

Response

200 - application/json

One streamed message (the server sends a sequence of these, not a single response).

marketSummary
market_summary · object

Live trading summary for the requested market.