Skip to main content
GET
Get positions
An account’s futures positions and margin, read from chain. No authentication is needed.

Reading a position

futures has one entry per series the account holds.
  • contracts is signed. A long gains when the base strengthens against the dollar.
  • notional_usdc is |contracts| × the contract size × mark_price.
  • status is trading, then closing after last_trade_time, then settled.
  • pending_vm_usdc is variation margin accrued since the last settlement, positive when owed to you. See Variation margin. The retired USDC-cNGN-30NOV26 reports pending_vm_cngn instead.

Margin

futures_account reports margin once for the whole account:
  • Below zero im_surplus_usd, the account cannot open or add to a position.
  • Below zero mm_surplus_usd, the account is liquidated.

Unreadable fields

A value the venue could not read is left out. Treat an absent field as unknown, not as zero.

Query Parameters

subaccount_id
string
required

The subaccount to read, as a decimal integer.

Pattern: ^[0-9]+$

Response

The account's positions

Read futures and futures_account. Other keys are reserved.

futures
object[]
required

One entry per listed series the account holds. Empty when the account is flat in every series.

futures_account
object

Margin across the whole account. Absent when the account is under another manager.

positions
object[]

Reserved. Not part of the documented response; it may be absent.

accounts
object[]

Reserved. Not part of the documented response; it may be absent.