GET
cURL

Authorizations

Authorization
string
header
required

The authorization field takes the session bearer returned by sign-in, or an API key where the route allows keys. Paste the token itself into the authorization field. When invitation-only access is enabled, private operations require the account's sign-in email to be invited. Sign-in can complete without an invitation, but private HTTP, MCP and FIX operations refuse with access_not_allowlisted (HTTP 403): "Private access is limited to invited accounts. Contact support to request access." Public market data remains available. Invitation changes apply to the next private operation, including existing FIX sessions. Do not retry until support confirms access.

Path Parameters

accountId
string
required
Minimum string length: 1

Query Parameters

symbols
string

Optional comma-separated perpetual symbols.

Minimum string length: 1

Response

Success

id
string
required
Minimum string length: 1
symbol
string
required
Minimum string length: 1
timestamp
integer
required
Required range: x >= 0
datetime
string
required
side
enum<string>
required
Available options:
long,
short
contracts
number
required
Required range: x >= 0
contractSize
number
required
notional
number
required
Required range: x >= 0
entryPrice
number
required
markPrice
number
required
liquidationPrice
number
required
realizedPnl
number
required
info
object
required
unrealizedPnl
number
maintenanceMargin
number
Required range: x >= 0
leverage
number

This position's leverage: its notional value at the mark price divided by the account's equity at the same sequence, as a nonnegative decimal with 4 decimal places, rounded toward zero (a decimal string on the stream, a JSON number on rows). The denominator is the whole account's equity, not a margin amount set aside for this position. Margin is held per account (cross margin): all open positions share one pool of account equity, so no position has margin of its own. The value is null on the stream, and the field is left out of rows, when account equity is zero or negative or the position is flat; it is never infinite and never a placeholder zero. Absent on frames and rows from a producer that does not carry it.

Required range: x >= 0