Skip to main content
GET
Perps WebSocket session

Authorizations

Authorization
string
header
required

An OceanX API key, created in the app under Settings → Developer API. Send it as Authorization: Bearer ox_live_…. Required scopes are operation-specific: market reads use md.read, tracker uses tracker.read, copy reads use copy.read, alert operations use alerts.read or alerts.write, and owned wallet/funding reads require explicit account.read. New scopes require explicit selection and grant no trading authority. Existing perps operations retain their documented scopes.

Query Parameters

format
enum<string>
default:msgpack

Only json selects JSON; other values use MessagePack.

Available options:
json,
msgpack

Response

Session and subscription/keepalive contract.

wsUrl
string<uri>
required

Short-lived WebSocket URL. Treat the embedded ticket as a credential.

expiresInSeconds
integer
required
subscribeContract
object
required
keepalive
object
required