Lighter - Positions

Get Lighter market positions

Every open position in one market at the latest live snapshot, or at the committed hourly snapshot hour, sorted by position value, largest first. The first page carries meta.totals over the whole filtered set. System accounts are excluded unless include_system=true. Billed at 1 credit per 1,000 rows returned, minimum 1 credit per request.

get/v1/lighter/positions/{symbol}

Request

  • Base URL: https://api.0xarchive.io
  • URL: https://api.0xarchive.io/v1/lighter/positions/{symbol}
  • Auth: API key in header X-API-Key

Path parameters

symbolstring required
Example:BTC

Lighter perpetual symbol (e.g. BTC). Spot markets have no positions. Pass it exactly as the instruments route lists it, in uppercase.

Query parameters

hourinteger

Committed hourly snapshot to read, as an exact UTC hour in Unix milliseconds. Echoed as meta.snapshot_ts. Defaults to the latest live snapshot.

side'long' | 'short'

Only long or only short positions.

min_valuenumber

Only positions worth at least this much in USD.

include_systemboolean

Include settlement, insurance, and other system accounts (excluded by default).

limitinteger

Maximum rows per page (default 100, max 2000).

cursorstring

Cursor from the previous response meta.next_cursor. Keep every other parameter unchanged.

Response

Get Lighter market positions

successboolean required

Example response

{
  "success": true,
  "data": [
    {
      "user_address": "0x31ca8395cf837de08b24da3f660e77761dfb974b",
      "account_index": "513030",
      "account_kind": "user",
      "symbol": "BTC",
      "coin": "BTC",
      "dex": "xyz",
      "size": "12.5",
      "side": "long",
      "entry_price": "64210.5",
      "mark_price": "65020.1",
      "position_value": "812751.25",
      "unrealized_pnl": "10120.2",
      "leverage_type": "cross",
      "liquidation_price": "51000",
      "quality": "complete"
    }
  ],
  "meta": {
    "totals": {
      "symbol": "BTC",
      "coin": "BTC",
      "dex": "xyz",
      "long_count": 18234,
      "short_count": 15102,
      "long_size": "8123.45",
      "short_size": "8120.1",
      "long_value": "528000000.5",
      "short_value": "527800000.25",
      "long_avg_entry_price": "63120.4",
      "short_avg_entry_price": "66210.9",
      "long_positions_with_entry": 18230,
      "short_positions_with_entry": 15100,
      "long_top10_value_share": "0.412345",
      "short_top10_value_share": "0.385",
      "top10_value_share": "0.301",
      "quality": "complete"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.