Skip to main content

PositionResp

marginTypestring

Margin mode of the position (e.g. CROSS or ISOLATED).

Possible values: [CROSS, SPOT, ISOLATED, LEAD, COPY, ALL]

entryPricedouble

Average entry price of the position.

markPricedouble

Latest mark price used to value the position.

symbolstring

Market symbol of the position (e.g. BTC-PERP).

sidestring

Side of the position (BUY for long, SELL for short).

Possible values: [BUY, SELL]

notionalValuedouble

Notional value of the position, in the settlement currency.

settleWithAssetstring

Asset used to settle PnL and fees for this position.

unrealizedProfitLossdouble

Unrealized profit or loss at the latest mark price.

totalMaintenanceMargindouble

Total maintenance margin currently required for the position.

sizeint32

Position size, in contracts.

liquidationPricedouble

Estimated liquidation price based on the current margin and mark price.

isolatedLeveragedouble

Isolated leverage configured on the position; only applicable in isolated margin mode.

timestampint64

Server timestamp of the position snapshot, in milliseconds since epoch.

takeProfitOrder object

Take-profit trigger currently attached to the position, if any.

orderIdstring
sidestring

Possible values: [BUY, SELL]

triggerPricedouble
triggerUseLastPriceboolean
stopLossOrder object

Stop-loss trigger currently attached to the position, if any.

orderIdstring
sidestring

Possible values: [BUY, SELL]

triggerPricedouble
triggerUseLastPriceboolean
positionModestring

Position mode: ONE_WAY (net position) or HEDGE (independent long and short positions).

Possible values: [ONE_WAY, HEDGE, ISOLATED]

positionDirectionstring

Position direction in hedge mode (LONG or SHORT).

Possible values: [LONG, SHORT]

positionIdstring

Unique identifier of the position.

walletNamestring

Name of the wallet holding the position.

currentLeveragedouble

Effective leverage currently applied to the position.

minimumRequiredMargindouble

Minimum initial margin required to hold the position at its current size.

PositionResp
{
"marginType": "CROSS",
"entryPrice": 0,
"markPrice": 0,
"symbol": "string",
"side": "BUY",
"notionalValue": 0,
"settleWithAsset": "string",
"unrealizedProfitLoss": 0,
"totalMaintenanceMargin": 0,
"size": 0,
"liquidationPrice": 0,
"isolatedLeverage": 0,
"timestamp": 0,
"takeProfitOrder": {
"orderId": "string",
"side": "BUY",
"triggerPrice": 0,
"triggerUseLastPrice": true
},
"stopLossOrder": {
"orderId": "string",
"side": "BUY",
"triggerPrice": 0,
"triggerUseLastPrice": true
},
"positionMode": "ONE_WAY",
"positionDirection": "LONG",
"positionId": "string",
"walletName": "string",
"currentLeverage": 0,
"minimumRequiredMargin": 0
}