Skip to main content
POST
/
ws
/
liquidationPerps
Subscribe: Perps Liquidation
curl --request POST \
  --url wss://api.ondoperps.xyz/ws/liquidationPerps \
  --header 'Content-Type: application/json' \
  --data '
{
  "op": "subscribe",
  "channel": "liquidationPerps"
}
'
{
  "type": "update",
  "channel": "liquidationPerps",
  "data": {
    "id": "<string>",
    "time": "2023-11-07T05:31:56Z",
    "initiatedAt": "2023-11-07T05:31:56Z",
    "accountId": "<string>",
    "status": "<string>",
    "insuranceFundUsed": "0.00",
    "adl": true,
    "retryCount": 123,
    "triggeringPositions": [
      {
        "market": "AAPL-USD.P",
        "direction": "long",
        "netQuantity": "10.00",
        "averageEntryPrice": "225.00",
        "usedMargin": "1125.00",
        "unrealizedPnl": "25.00",
        "markPrice": "227.50",
        "liquidationPrice": "180.00",
        "bankruptcyPrice": "170.00",
        "maintenanceMargin": "112.50",
        "notionalValue": "2275.00",
        "leverage": "2.0",
        "netFundingSinceNeutral": "-1.23",
        "stopLossTriggerPrice": "<string>",
        "takeProfitTriggerPrice": "<string>",
        "returnOnEquity": "0.022"
      }
    ],
    "filledQuoteSize": "<string>",
    "filledQuantity": "<string>",
    "reclaimOrderMargin": true
  }
}

Body

application/json
​
op
enum<string>
required

Operation type

Available options:
ping,
login,
subscribe,
unsubscribe,
sendMessage
​
channel
enum<string>

Channel to subscribe/unsubscribe

Available options:
topOfBooksPerps,
depthBooksPerps,
tradesPerps,
ordersPerps,
fillsPerps,
cancelAllOrdersAfterPerps,
positionsPerps,
liquidationPerps,
liquidationAnnouncementsPerps,
marginTransfersPerps,
balancePerps,
ordersSummariesPerps,
fundingRatesPerps,
markPricesPerps,
fundingPaymentsPerps,
kLinePerps,
deposits,
withdrawals,
chat
​
markets
string[]

Filter by market(s). Required for kLine (exactly one). Optional for most channels.

​
args
object

Authentication arguments. Use either JWT (token) or API key (key + time + sign).

​
numPastTrades
integer

Number of historical trades to receive on subscribe (trades channels only)

​
resolution
enum<string>

Kline resolution (required for kLine channels)

Available options:
1,
5,
15,
1H,
4H,
1D,
1W
​
timeout_seconds
integer

Dead man's switch timeout (required for cancelAllOrdersAfter channels)

​
depthLevels
string

Price grouping level for depth book (depthBooks channels only)

​
limit
integer

Max depth levels to return; 0 for unlimited (depthBooks channels only)

​
message
string

Chat message text (sendMessage only)

​
context
object

Optional context for chat (market, page, etc.)

Response

200 - application/json

Channel update for liquidationPerps

​
type
enum<string>
Available options:
update
​
channel
enum<string>
Available options:
liquidationPerps
​
data
object