market:futures:funding_rates

Subscribes/Unsubscribes to market futures Trades data.

Once you're connected to this subscription: wss://ws.amberdata.com/futures, you must provide either the instrument or exchange - one needs to be specified, both cannot be empty.

Request

{
  "jsonrpc" : "2.0",
  "id"      : 1,
  "method"  : "subscribe",
  "params"  : [ "market:futures:funding_rates", { "instrument": "ICXUSDT", "exchange": "binance" } ]
}
ParamTypeDescription
instrumentstringThe asset instrument.
exchangestringThe exchange for which to retrieve asset instruments.

Response

{
    "jsonrpc": "2.0",
    "method": "subscription",
    "params": {
        "subscription": "8d5b4e5a-435d-40d4-9701-b3d8c2d15148",
        "result": {
            "exchange": "binance",
            "instrument": "GASUSDT",
            "timestamp": 1711571101000,
            "insertionTimestamp": 1711571101000,
            "fundingInterval": null,
            "fundingRate": 0.00019676,
            "nextFundingRate": null,
            "nextFundingTime": 1711584000000,
            "isActualFundingRate": false
        }
    }
}
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
fundingIntervalnumber|nullThe 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.
isActualFundingRatebooleanIf true, then it's the actual funding rate that has been realized and applied. If false, then it's a projected/estimated funding rate for an upcoming funding interval.

Example

const WebSocket = require('ws');
const ws = new WebSocket('wss://ws.amberdata.com/futures', {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));
});