Get Position Details

Get the position details of a specified position.

HTTP REQUEST

GET /api/v1/position

Example

GET /api/v1/position?symbol=XBTUSDM

//Isolated Margin
{
  "id": "500000000000000060",
  "symbol": "XBTUSDM",
  "autoDeposit": false,
  "crossMode": false,
  "maintMarginReq": 0.025,
  "riskLimit": 4,
  "realLeverage": 0.17,
  "delevPercentage": 0.25,
  "openingTimestamp": 1717575656090,
  "currentTimestamp": 1717644848634,
  "currentQty": 1,
  "currentCost": -0.000014802,
  "currentComm": 0.0000016124,
  "unrealisedCost": -0.0000143236,
  "realisedGrossCost": -0.0000004784,
  "realisedCost": 0.000001134,
  "isOpen": true,
  "markPrice": 71497.49,
  "markValue": -0.0000139865,
  "posCost": -0.0000143236,
  "posCross": 0.0000671432,
  "posCrossMargin": 0.0000666266,
  "posInit": 0.0000143236,
  "posComm": 0.0000000637,
  "posCommCommon": 0.0000000571,
  "posLoss": 0,
  "posFunding": 0,
  "posMargin": 0.0000815305,
  "posMaint": 0.0000004232,
  "maintMargin": 0.0000818676,
  "realisedGrossPnl": 0.0000004784,
  "realisedPnl": 0.000002006,
  "unrealisedPnl": 0.0000003371,
  "unrealisedPnlPcnt": 0.0235,
  "unrealisedRoePcnt": 0.0235,
  "avgEntryPrice": 69814.85,
  "liquidationPrice": 10478.79,
  "bankruptPrice": 10439.46,
  "settleCurrency": "XBT",
  "isInverse": true,
  "maintainMargin": 0.025,
  "marginMode": "ISOLATED",
  "positionSide": "BOTH", 
  "leverage": 0.17 //the same as realLeverage
}


//Cross Margin
{
	"id": "500000000000000037",
	"symbol": "XBTUSDTM",
	"crossMode": true,
	"delevPercentage": 0.18,
	"openingTimestamp": 1717071888225,
	"currentTimestamp": 1717645230645,
	"currentQty": -11503,
	"currentCost": -777297.064,
	"currentComm": 502198.83836837,
	"unrealisedCost": -778591.0762741665,
	"realisedGrossCost": 1294.0122741665,
	"realisedCost": 503492.8506425365,
	"isOpen": true,
	"markPrice": 71059.32,
	"markValue": -817395.35796,
	"posCost": -778591.0762741665,
	"posInit": 77859.1076274167,
	"posMargin": 81739.535796,
	"realisedGrossPnl": -1294.0122741665,
	"realisedPnl": 499536.3226406035,
	"unrealisedPnl": -38804.2816858335,
	"unrealisedPnlPcnt": -0.0498,
	"unrealisedRoePcnt": -0.4984,
	"avgEntryPrice": 67685.91,
	"liquidationPrice": 983470.75,
	"bankruptPrice": 989293.44,
	"settleCurrency": "USDT",
	"isInverse": false,
	"marginMode": "CROSS",
	"positionSide": "BOTH",
	"leverage": 10
}

API KEY PERMISSIONS

This endpoint requires the General permission.

REQUEST URL

This endpoint support Futures URL

REQUEST RATE LIMIT

Futures weight：2

PARAMETERS

Param	Type	Mandatory	Description
symbol	String	Yes	Symbol of the contract

RESPONSES

Param	Description
id	Position ID
isInverse	Reverse contract or not
symbol	Symbol
delevPercentage	ADL ranking percentile
openingTimestamp	Open time
currentTimestamp	Current timestamp
currentQty	Current postion quantity
currentCost	Current postion value
currentComm	Current commission
unrealisedCost	Unrealised value
realisedGrossCost	Accumulated realised gross profit value
realisedCost	Current realised position value
isOpen	Opened position or not
markPrice	Mark price
markValue	Mark Value
posCost	Position value
posInit	Inital margin Cross = opening value/cross leverage; isolated = accumulation of initial margin for each transaction
posMargin	Bankruptcy cost Cross = mark value * imr; Isolated = position margin (accumulation of initial margin, additional margin, generated funding fees, etc.)
realisedGrossPnl	Accumulated realised gross profit value
realisedPnl	Realised profit and loss
unrealisedPnl	Unrealised profit and loss
unrealisedPnlPcnt	Profit-loss ratio of the position
unrealisedRoePcnt	Rate of return on investment
avgEntryPrice	Average entry price
liquidationPrice	Liquidation price For Cross Margin, you can refer to the liquidationPrice, and the liquidation is based on the risk rate.
bankruptPrice	Bankruptcy price For Cross Margin, you can refer to the bankruptPrice, and the liquidation is based on the risk rate.
settleCurrency	Currency used to clear and settle the trades
crossMode	Cross mode or not
marginMode	Margin Mode: CROSS，ISOLATED
positionSide	Position Side
leverage	leverage
posFunding	The current remaining unsettled funding fee for the position Only applicable to Isolated Margin
autoDeposit	Auto deposit margin or not Only applicable to Isolated Margin
maintMarginReq	Maintenance margin requirement Only applicable to Isolated Margin
riskLimit	Risk limit Only applicable to Isolated Margin
realLeverage	Leverage of the order Only applicable to Isolated Margin
posCross	added margin Only applicable to Isolated Margin
posCrossMargin	Additional margin calls (automatic, manual, adjusted risk limits) Only applicable to Isolated Margin
posComm	Bankruptcy cost Only applicable to Isolated Margin
posCommCommon	Part of bankruptcy cost (positioning, add margin) Only applicable to Isolated Margin
posLoss	Funding fees paid out Only applicable to Isolated Margin
posMaint	Maintenance margin Only applicable to Isolated Margin
maintMargin	Position margin Only applicable to Isolated Margin
maintainMargin	Maintenance margin rate Only applicable to Isolated Margin