Skip to main content
GET
Get Lighter market positions
API key required. Send X-API-Key with this request. See REST authentication.
Open the generated operation schema for machine-readable request and response details.

Authorizations

X-API-Key
string
header
required

API key for authentication. Get yours at https://0xarchive.io/dashboard

Path Parameters

symbol
string
required

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

Example:

"BTC"

Query Parameters

hour
integer<int64>

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
enum<string>

Only long or only short positions.

Available options:
long,
short
min_value
number

Only positions worth at least this much in USD.

Required range: x >= 0
include_system
boolean
default:false

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

limit
integer
default:100

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

Required range: 1 <= x <= 2000
cursor
string

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

Response

Get Lighter market positions

Open positions in a market or across markets.

success
boolean
required
Example:

true

data
object[]
required
meta
object
required

Response metadata of the account positions routes. Every instant is RFC 3339 UTC with milliseconds and comes from the data, never the request time.

Last modified on September 28, 2026