Open a scoped state stream

GET

https://api.liftx.io

stream

Upgrade scoped canonical unified WebSocket

curl --request GET \
  --url https://api.liftx.io/v1/stream \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.liftx.io/v1/stream', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Preview contract. Production availability remains subject to activation and release qualification. Examples are synthetic; the documentation cannot submit requests.

Authorization

read in the upgrade Authorization header.

Behavior

This HTTP GET upgrades to WebSocket (101). Send scoped JSON text controls and decode the documented versioned binary messages. Browser WebSocket clients cannot normally set the required header; do not move secrets into URLs. Mutations remain HTTP commands.

Upgrade example

GET /v1/stream
Authorization: Bearer YOUR_API_KEY_FROM_PRIVATE_STORAGE
Connection: Upgrade
Upgrade: websocket
Sec-WebSocket-Version: 13
Sec-WebSocket-Key: CLIENT_GENERATED_HANDSHAKE_NONCE

Use a WebSocket library to construct the handshake and verify its response. The client controls and complete channel codecs are in the stream guide.

Response and errors

The generated response schema below is the wire contract. Preserve fixed-point strings, nullable fields and endpoint-specific envelopes. Inspect HTTP status and Content-Type before decoding failures; reused trading routes may return JSON or plain text. Authentication, entitlement and exact link/instrument restrictions apply in addition to endpoint validation. See errors and recovery. Read the related guide for lifecycle, units and recovery semantics.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Success

Upgrade scoped canonical unified WebSocket

curl --request GET \
  --url https://api.liftx.io/v1/stream \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.liftx.io/v1/stream', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Discovery and account data

Positions and history

Templates

Commands and streams

TradingView webhook

Session-only Settings

Open a scoped state stream

Authorization

Behavior

Upgrade example

Response and errors

Authorizations

Response

​Authorization

​Behavior

​Upgrade example

​Response and errors

Authorizations

Response

Authorization

Behavior

Upgrade example

Response and errors