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
enterpriseId string <uuid>required
netOpenPosition number <decimal>required
netOpenPositionValue number <decimal>required
shortMarginPositionNotionalLimit object required
Example: {"quantity":"100.0","currency":"USD"}
longMarginPositionNotionalLimit object required
Example: {"quantity":"100.0","currency":"USD"}
unrealizedPnL object required
Example: {"quantity":"100.0","currency":"USD"}
lastModified string <date-time>required