Skip to main content

Positions Channel

Get the current open positions

Request Parameters

ParameterTypeRequiredDescription
opstringYesOperation, subscribe unsubscribe
argslistYesList of channels to request subscription
> instTypestringYesProduct type: USDT-FUTURES
> channelstringYesChannel name: positions
> instIdstringNoProduct ID (optional, omit for all positions)

Request Example

{
"op": "subscribe",
"args": [
{
"instType": "USDT-FUTURES",
"channel": "positions",
"instId": "BTCUSDT"
}
]
}

Response Example

{
"event": "subscribe",
"arg": {
"instType": "USDT-FUTURES",
"channel": "positions",
"instId": "BTCUSDT"
}
}

Push Parameters

ParameterTypeDescription
actionstringPush data action
argobjectChannels with successful subscription
> instTypestringProduct type
> channelstringChannel name
> instIdstringProduct ID
datalistPosition data list
> marginCoinstringMargin coin (USDT)
> symbolstringSymbol
> holdSidestringPosition side: long / short
> openDelegateSizestringPosition size
> marginSizestringPosition margin
> availablestringAvailable size for close
> lockedstringLocked size (pending close orders)
> totalstringTotal position size
> leveragestringLeverage
> achievedProfitsstringRealized profits
> openPriceAvgstringAverage entry price
> marginModestringMargin mode: isolated / cross
> unrealizedPLstringUnrealized profit and loss
> liquidationPricestringLiquidation price
> keepMarginRatestringMaintenance margin rate
> markPricestringCurrent mark price
> breakEvenPricestringBreak-even price
> totalFeestringTotal fees
> uTimenumberUpdate time
> cTimenumberCreate time
tsnumberPush timestamp

Push Data

{
"action": "snapshot",
"arg": {
"instType": "USDT-FUTURES",
"channel": "positions",
"instId": "BTCUSDT"
},
"data": [
{
"marginCoin": "USDT",
"symbol": "BTCUSDT",
"holdSide": "long",
"openDelegateSize": "0.1",
"marginSize": "270.05",
"available": "0.1",
"locked": "0",
"total": "0.1",
"leverage": "10",
"achievedProfits": "0",
"openPriceAvg": "27005.0",
"marginMode": "isolated",
"unrealizedPL": "15.50",
"liquidationPrice": "24500.0",
"keepMarginRate": "0.004",
"markPrice": "27160.5",
"breakEvenPrice": "27015.5",
"totalFee": "10.50",
"uTime": 1695716760565,
"cTime": 1695716700000
}
],
"ts": 1695716761589
}