Ctrl+K

Get net open positions snapshot

get/api/prime/trading/v1/accounts/{accountId}/margin/netopenpositions/snapshot

Returns the net open positions snapshot as of a given time for the specified account.

Path Parameters

  • accountIdstringRequired
    The ID of the account

Query Parameters

  • transactionDateLtstring<date-time>Required
    Returns unsettled positions based on transactions that occurred before this timestamp.
  • currencyarray[string]
    Filter results to specific currencies. If omitted, returns unsettled positions for all currencies with non-zero balances.
  • useFutureTransfersbooleanDefault: false
    If true, applies position transfers sent after transactionDateLt to cover short positions as of transactionDateLt.

200 Response

netOpenPositions array[object] required
Example: {"currency":"BTC","enterpriseId":"63925f940c259a00061853808ffea830","accountId":"f230fdebfa084ffebc7e00515f54603f","netOpenPosition":"-2.5","appliedFutureTransfers":"1.5","earliestTransactionDate":"2025-12-01T01:30:00.000Z","latestTransactionDate":"2025-12-01T23:45:00.000Z","latestFutureTransferDate":"2025-12-02T10:00:00.000Z"}
currency string required
The currency symbol for this position
Example: BTC
enterpriseId string required
The enterprise ID associated with this position
Example: 63925f940c259a00061853808ffea830
accountId string required
The trading account ID
Example: f230fdebfa084ffebc7e00515f54603f
netOpenPosition string required
The net position quantity at the snapshot time. Negative values indicate short positions (borrowed/owed), positive values indicate long positions (owned).
Example: -2.5
Match pattern: ^-?[0-9]+(\.[0-9]+)?$
appliedFutureTransfers string required
The total amount of pending transfers (after cutoff) applied to cover this position (only when useFutureTransfers=true). Always zero for long positions. For short positions, shows how much of the position will be covered by pending incoming transfers.
Example: 1.5
Match pattern: ^[0-9]+(\.[0-9]+)?$
earliestTransactionDate string <date-time>required
Timestamp of the earliest transaction that contributed to this position
Example: 2025-12-01T01:30:00.000Z
latestTransactionDate string <date-time>required
Timestamp of the most recent transaction that contributed to this position (before the cutoff)
Example: 2025-12-01T23:45:00.000Z
latestFutureTransferDate
string or null
<date-time>
Timestamp of the most recent pending transfer applied to this position. Only present when useFutureTransfers=true and pending transfers were applied. Null otherwise.
Example: 2025-12-02T10:00:00.000Z