market:swaps:liquidations [ENT]

Make sure you're connected to this subscription: wss://ws.web3api.io/swaps. Either the instrument or exchange have to be specified - one needs to be specified, but both cannot be empty.

Request

{
  "jsonrpc" : "2.0",
  "id"      : 1,
  "method"  : "subscribe",
  "params"  : [ "market:swaps:liquidations", { "instrument": "BTC-USDT", "exchange": "huobi" } ]
}

Param	Type	Description
instrument	`string`	The asset instrument.
exchange	`string`	The exchange for which to retrieve asset instruments.
period	`string`	'minutely' 'hourly' 'daily'

Response

"result": {
  "exchange": "huobi",
  "instrument": "BTC-USDT",
  "timestamp": 1693411730905,
  "price": 27068.9,
  "side": "SELL",
  "status": "CLOSE",
  "type": null,
  "timeInForce": null,
  "action": null,
  "orderId": null,
  "volume": 199.0
}

Field	Type	Description
exchange	`string`	The exchange.
timestamp	`number`	The time at which the liquidation took place.

Example

const WebSocket = require('ws');
const ws = new WebSocket('wss://ws.web3api.io/swaps', {headers: {x-api-key:'<api_key>'}});

ws.on('open', () => {
  ws.send(JSON.stringify({
      jsonrpc: '2.0',
      method: 'subscribe',
      params: ['market:swaps:liquidations', {'instrument': 'BTC-USDT', 'exchange': 'huobi'}],
      id: 1,
    }));
});

ws.on('message', data => {
  console.log(JSON.stringify(JSON.parse(data), null, 2));
});