Get current Long/Short exposure

GET

https://api.liftx.io

dashboard

analytics

snapshot

Get current Long/Short exposure

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

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

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

{
  "type": "analytics_snapshot",
  "scope": {
    "exchange_link_id": 4503599627370495,
    "environment": "live"
  },
  "revision": "<string>",
  "as_of": 123,
  "long_short": {
    "pair_id": "<string>",
    "longs": 4503599627370495,
    "shorts": 4503599627370495,
    "complete": true
  },
  "direction_revision": "<string>",
  "membership_revision": "<string>",
  "orders_revision": "<string>",
  "holding_revision": "<string>"
}

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

read is required for one authorized exact link without instrument restrictions. Supply exchange_link_id, its actual environment and an optional reporting pair_id from the analytics asset catalog. The response contains current Long/Short counts and committed revision tokens. Unknown counts are null; zero counts are valid. Before reading Long/Short history, copy membership_revision and direction_revision into that operation’s membership_revision and revision. The separate snapshot revision is not the history revision. No WebSocket subscription is required. See Account analytics for scope, units, readiness and bounded pagination.

Authorizations

Authorization

string

header

required

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

Query Parameters

exchange_link_id

integer

required

Required range: 1 <= x <= 9007199254740991

environment

enum<string>

required

Available options:

live,

demo

pair_id

string

Opaque reporting pair_id from liftx_analytics_list_assets; omit for All Assets. Not an executable instrument_id.

Maximum string length: 64

Pattern: ^([a-f0-9]{64})?$

Response

Success

Current canonical counts and opaque committed analytics revision tokens. Copy membership_revision and direction_revision into Long/Short history. Revision is observation identity, not a trading revision or execution acknowledgement.

type

enum<string>

required

Available options:

analytics_snapshot

scope

object

required

Show child attributes

revision

string

required

as_of

integer<int64>

required

long_short

object

required

Counts of currently exposed Futures positions. Unknown counts are null; a proven zero remains zero. Ratio longs/shorts is undefined at 0/0 and infinite when only longs remain. This is a position count, not size-weighted or market-wide sentiment.

Show child attributes

direction_revision

string

required

membership_revision

string

required

orders_revision

string

required

holding_revision

string

required

Get current Long/Short exposure

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

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

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

{
  "type": "analytics_snapshot",
  "scope": {
    "exchange_link_id": 4503599627370495,
    "environment": "live"
  },
  "revision": "<string>",
  "as_of": 123,
  "long_short": {
    "pair_id": "<string>",
    "longs": 4503599627370495,
    "shorts": 4503599627370495,
    "complete": true
  },
  "direction_revision": "<string>",
  "membership_revision": "<string>",
  "orders_revision": "<string>",
  "holding_revision": "<string>"
}

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

Discovery and account data

Positions and history

Templates

Commands and streams

TradingView webhook

Session-only Settings

Get current Long/Short exposure

Authorizations

Query Parameters

Response