market:swaps:open_interests

Subscribes/Unsubscribes to market swaps Open Interests data.

Make sure you're connected to this subscription: wss://ws.web3api.io. 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:open_interests", { "instrument": "BTC-USDT", "exchange": "huobi" } ]
}
ParamTypeDescription
instrumentstringThe asset instrument.
exchangestringThe exchange for which to retrieve asset instruments.

Response

"result":{
  "exchange": "buobi",
  "instrument": "BTC-USDT",
  "timestamp": 1616140800,
  "value": 900,
  "type": null
}
FieldTypeDescription
exchangestringThe exchange.
instrumentstringThe asset pair
timestampnumberThe time at which the trade took place.
valuenumberThe open interest value
typestringThe type of open interest

Example

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

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

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