Get Positions
Method: private/get_positions
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| currency | string | false | Currency. Options: BTC, ETH, USDC, USDT, EURR, any |
| kind | string | false | Instrument kind. Options: future, option, spot, future_combo, option_combo |
| subaccountId | integer | false | The user id for the subaccount |
Response
Returns an array of position objects with the following fields:
| Name | Type | Description |
|---|---|---|
| averagePrice | number | Average price of trades that built this position |
| averagePriceUsd | number | Only for options, average price in USD |
| delta | number | Delta parameter |
| side | string | Direction: buy, sell or zero |
| estimatedLiquidationPrice | number | Estimated liquidation price, added only for futures, for users with segregated_sm margin model |
| floatingProfitLoss | number | Floating profit or loss |
| floatingProfitLossUsd | number | Only for options, floating profit or loss in USD |
| gamma | number | Only for options, Gamma parameter |
| indexPrice | number | Current index price |
| initialMargin | number | Initial margin |
| instrumentName | string | Unique instrument identifier |
| interestValue | number | Value used to calculate realized_funding (perpetual only) |
| kind | string | Instrument kind: "future", "option", "spot", "future_combo", "option_combo" |
| leverage | integer | Current available leverage for future position |
| maintenanceMargin | number | Maintenance margin |
| markPrice | number | Current mark price for position's instrument |
| openOrdersMargin | number | Open orders margin |
| realizedFunding | number | Realized Funding in current session included in session realized profit or loss, only for positions of perpetual instruments |
| realizedProfitLoss | number | Realized profit or loss |
| settlementPrice | number | Optional (not added for spot). Last settlement price for position's instrument 0 if instrument wasn't settled yet |
| size | number | Position size for futures size in quote currency (e.g. USD), for options size is in base currency (e.g. BTC) |
| sizeCurrency | number | Only for futures, position size in base currency |
| theta | number | Only for options, Theta parameter |
| totalprofitLoss | number | Profit or loss from position |
| vega | number | Only for options, Vega parameter |
Response Example
{
"rid": 50002,
"result": [{
"averagePrice": "110957.5",
"delta": "0.974421544",
"side": "buy",
"floatingProfitLoss": "-0.014474194",
"indexPrice": "113853.63",
"initialMargin": "0.039024337",
"instrumentName": "BTC-17OCT25",
"kind": "future",
"leverage": 25,
"maintenanceMargin": "0.019535906",
"markPrice": "113882.95",
"openOrdersMargin": "0.0",
"realizedProfitLoss": "0.0",
"settlementPrice": "115600.09",
"size": "110970.0",
"sizeCurrency": "0.974421544",
"totalProfitLoss": "0.025691112"
}]
}