Skip to main content
WSS
appId
type:userPassword

App-level auth: pass appId as a query parameter on connect. Required for all connections. Browsers are admitted by an Origin on the app's allowed origins; servers by the apiKey scheme instead.

x-app-api-key
type:httpApiKey

Optional server-to-server auth on the handshake; any supplied key must be valid and replaces the Origin check. Without a key, an allowed Origin is required even when the app has requireApiKey for REST. WebSocket key enforcement is currently deferred. Needed for the app-events channel and for the firehose channel on the orderbook socket. Never send from a browser.

jwt
type:http

User-level auth: send { action: 'authenticate', token } after connected (a token query param still works but is deprecated). Required for user-specific events (orders, balances). Same JWT as the REST API.

Arb-return update for a specific market
type:object

Pushed to clients subscribed to { channel: "arb", marketIds } when the engine detects a new arbReturn value for that market.

Subscribe to orderbook
type:object

Subscribe to aggregated orderbook updates for markets

Unsubscribe from orderbook
type:object