Skip to main content
GET
Live stream

Authorizations

X-API-Key
string
header
required

Headers

Last-Event-ID
string

The id of the last event received, sent by SSE clients on reconnect.

Maximum string length: 40

Query Parameters

topics
string
required

Comma-separated topics to receive.

Pattern: ^(quotes|trades|books|relations|leads|rules)(,(quotes|trades|books|relations|leads|rules))*$
venue
enum<string>

Only results on this venue.

Available options:
kalshi,
polymarket
markets
string

Up to 50 comma-separated markets as venue:id.

Maximum string length: 10500
min_usd
integer
default:0

Only trades of at least this notional, in USD.

Required range: 0 <= x <= 100000000
cursor
string

Resume after this event id. Last-Event-ID does the same; this parameter wins when both are sent.

Maximum string length: 40
Pattern: ^[0-9]+(-[0-9]+)?$

Response

An event stream. Each event's data is one JSON object; the schema for each event name is in x-events: ready (StreamReady), quote (StreamQuote), trade (StreamTrade), book (StreamBook), relation (StreamRelation), relations_truncated (StreamRelationsTruncated), lead (StreamLead), rule_change (StreamRuleChange), reset (StreamNotice), reconnect (StreamReconnect) and error (StreamError).

The response is of type string.