Ctrl+K

Get net open margin positions

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

Returns the net open positions for the specified account.

Path Parameters

  • accountIdstringRequired
    The ID of the account

Query Parameters

  • currencyarray[string]
    Filters on provided currencies if provided, otherwise returns net open positions for all currencies

200 Response

netOpenPositions array[object]
Example: {"currency":"BTC","enterpriseId":"63925f940c259a00061853808ffea830","netOpenPosition":"-2.3242","netOpenPositionValue":-124017.22,"shortMarginPositionNotionalLimit":{"quantity":1000000,"currency":"USD"},"longMarginPositionNotionalLimit":{"quantity":1000000,"currency":"USD"},"unrealizedPnL":{"quantity":1200,"currency":"USD"},"lastModified":"2024-07-29T21:13:09.000Z"}
currency string required
Symbol of the instrument (ex. BTC)
enterpriseId string <uuid>required
Enterprise ID for the margin NOP limit
netOpenPosition string required
Number representing the current net open position for the NOP instrument in question (ex. -10 BTC). Negative means a short position and positive means a long position.
Example: -2.3242
Match pattern: ^-?[0-9]+(\.[0-9]+)?$
netOpenPositionValue number <decimal>required
Number representing the net open position denoted in notional amount (ex 600,000 USD)
shortMarginPositionNotionalLimit object required
Number representing the maximum open margin position that can be short in terms of the notional instrument (ex. 10,000 USD) in absolute notional terms, as the NOP is signed
Example: {"quantity":"100.0","currency":"USD"}
longMarginPositionNotionalLimit object required
Number representing the maximum open margin position that can be long in terms of the notional instrument (ex. 10,000 USD)
Example: {"quantity":"100.0","currency":"USD"}
unrealizedPnL object required
Number representing the unrealized profit and loss. Difference between the NOP value at the time of creation and the NOP value as of now.
Example: {"quantity":"100.0","currency":"USD"}
lastModified string <date-time>required
ISO format datetime for date and time the record was last updated in the database