market:futures:long_short_ratios [ENT]

Subscribes/Unsubscribes to market futures Long/Short Ratios data.

Make sure you're connected. 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:futures:long_short_ratios", { "instrument": "XRPUSDT", "exchange": "binance", "period": "minutely" } ]
}

Param

Type

Description

instrument

string

The asset instrument.

exchange

string

The exchange for which to retrieve asset instruments.

Response

"result": {
  "exchange": "binance",
  "instrument": "XRPUSDT",
  "timestamp": 1607731200000,
  "longAccount": 0.8267,
  "ratio": 4.7703,
  "shortAccount": 0.1733,
  "period": 1
}

Field

Type

Description

exchange

string

The exchange.

timestamp

number

The time at which the long/short ratio was updated.

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:futures:long_short_ratios', {'instrument': 'XRPUSDT', 'exchange': 'binance', 'period': 'minutely'}],
      id: 1,
    }));
});

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