Skip to main content
GET
Get positions with metrics

Headers

x-wallet
string

Wallet address — primary user identification method

x-device-id
string

Device identifier — mobile fallback when x-wallet is not set

Query Parameters

wallet
string

Wallet address — fallback if neither x-wallet nor x-device-id headers are set

Response

200 - application/json

Array of positions with P&L metrics

instrument_id
string
required
Example:

"SOL_USDC-28FEB26-150-C"

quantity
integer
required

Net position in millicontracts

Example:

1000

avg_price
integer
required

Average entry price (USDC micros)

Example:

1500000

mid_price
integer
required

Current mid price (USDC micros, 0 if no quotes)

Example:

1700000

current_value
integer
required

Current position value (USDC micros, 0 if no quotes)

Example:

1700000

pnl
integer
required

Unrealized P&L (USDC micros, 0 if no quotes)

Example:

200000

pnl_percent
number
required

P&L as a percentage

Example:

13.33

breakeven
integer
required

Breakeven price (USDC micros)

Example:

1500000

price_decimals
integer
required

Decimals for avg_price/mid_price/current_value/pnl/breakeven (always 6).

Example:

6

size_decimals
integer
required

Decimals for quantity (always 3).

Example:

3

contract_size
integer
required

Underlying units per contract — currently 1 for all listed instruments. Always read this from the response, never hard-code: future contracts may ship with a different multiplier. 0 indicates the instrument has rolled off and is no longer in the live engine.

Example:

1