0xDocs 0x.limo

Docs / REST API

Push stream

Generated reference for the 1 /v1/stream operation of the 0x REST API.

Generated from steamworks sg-backend/openapi.yaml at build 3a4a58e45c+dirty. Do not edit by hand.

Errors are {"error": "..."} with the status (errors); limits are in rate limits.

MethodPathAuthSummary
GET/v1/streamBearer tokenPush channel

#GET /v1/stream

Push channel (WebSocket upgrade)

Text frames: JSON events ({"type": "lobby"|"lobby_invite"|"resync"|..., "_eid": "<id>"}). Binary frames: relay [u64 to][payload] out, [u64 from][payload] in. Reconnect with ?since=&lt;last \_eid&gt; to receive missed events (drop duplicates by ID).

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
sincequerystringno
StatusResponse
101Switching protocols
401Bad token
bash
curl -s "https://api.0x.limo/v1/stream" \
  -H "Authorization: Bearer $ZEROX_TOKEN"