market:futures:funding_rates

Subscribes/Unsubscribes to market futures Trades 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:futures:funding_rates", { "instrument": "XRPUSDT", "exchange": "binance" } ]
}
ParamTypeDescription
instrumentstringThe asset instrument.
exchangestringThe exchange for which to retrieve asset instruments.

Response

"result":{
  "exchange": "bitmex",
  "instrument": "DOGEUSDT",
  "timestamp": 1616137200,
  "insertionTimestamp": 1616137200,
  "fundingInterval": 353633,
  "fundingRate": 279393,
  "nextFundingRate": 279393,  
   "nextFundingTime":1616137200
}
FieldTypeDescription
exchangestringThe exchange.
instrumentstringThe asset pair
timestampnumberThe time at which the funding rate took place.
insertionTimestampnumberThe time at which the funding rate insert to database
fundingIntervalnumberThe interval funding
fundingRatenumberThe funding rate value
nextFundingRatenumberThe next funding rate for which data is available.
nextFundingTimenumber|nullThe next funding time for which data is available.

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:funding_rates', {'instrument': 'BTCUSD_PERP', 'exchange': 'binance'}],
      id: 1,
    }));
});

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