market:futures:open

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:open_interests", { "instrument": "XRPUSDT", "exchange": "binance" } ]
}

Param	Type	Description
instrument	`string`	The asset instrument.
exchange	`string`	The exchange for which to retrieve asset instruments.

Response

{
    "jsonrpc": "2.0",
    "method": "subscription",
    "params": {
        "subscription": "e91d68fa-84c8-445b-8da4-62c9e6036b56",
        "result": {
            "exchange": "binance",
            "instrument": "BTCUSDT",
            "timestamp": 1711582494214,
            "value": "82862.305",
            "type": null
        }
    }
}

Field	Type	Description
exchange	`string`	The exchange name.
instrument	`string`	The instrument name.
timestamp	`number`	The time at which the data was received.
value	`string`	The total open interest for the specified instrument.
type	`string`	The type of futures contract.

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

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