Skip to main content
GET
Live market stream (Server-Sent Events)
The market snapshot, pushed: the same depth payload at your chosen interval. A text/event-stream of event: market messages. Requires the market:read scope. Query parameters: scheme (default RODTEP), interval seconds between events (default 2), limit maximum events before the server closes the stream (default 600, cap 3600). Clients are expected to reconnect on close; treat the close as normal, not an error.

Request example

Stream example

Every event counts against your rate limit’s spirit but the stream itself is one call; prefer one stream over hammering the snapshot.

Errors

  • 401 / 403 / 429 before the stream opens, the standard auth errors.
Terms used here: scheme, paise, firm quote, API key, scope. Full list in the terminology annexure.

Next steps

Authorizations

X-ScripX-Key
string
header
required

Your API key, e.g. scripx_live_…. Bound to one firm; tenant isolation is enforced.

Query Parameters

scheme
enum<string>
Available options:
RODTEP,
ROSCTL
interval
number
default:2
limit
integer
default:600
Required range: x <= 3600

Response

SSE stream

The response is of type string.