Skip to main content

Liquidation Orders

Description​

This interface allows users to subscribe to liquidation orders triggered by platform events, with one order pushed per second for the same trading pair.

Pushing Frequency​

Real Time

Channel​

liquidation_orders

Request Parameters​

ParameterRequiredTypeDescription
eventYesStringOperation: subscribe, unsubscribe
channelYesArrayliquidation_orders
symbolsYesArraytrading pair array

Request Response​

ParameterTypeDescription
eventStringOperation: subscribe, unsubscribe
channelStringliquidation_orders
symbolsArraytrading pair array
messageStringError message

Push Data​

ParameterTypeDescription
channelStringliquidation_orders
dataArrayThe subscribed data
> sStringA trading pair
> sideStringEnumerate: BUY, SELL
> posSideStringPosition side LONG SHORT BOTH
> szStringliquidation order, with a unit of contract.
> bkPxStringBankruptcy price.
> uTimeLongCompletion time of liquidation order
> tsLongPush time (millisecond)

Request Example​

{
"event": "subscribe",
"channel": ["liquidation_orders"],
"symbols": ["BTC_USDT_PERP"]
}

Push Data Example​

{
"channel": "liquidation_orders",
"data": [
{
"s": "BTC_USDT_PERP",
"side": "BUY",
"posSide": "BOTH",
"sz": "1",
"bkPx": "94120.8368032",
"uTime": 1739367328421,
"ts": 1739367328446
}
]
}