RESTWebsocketsamberLensAWS S3SnowflakeGoogle BigQueryAsset Reference & Classification
API Documentation

market:futures:open_interests

Subscribes/Unsubscribes to market futures Open Interests data.

Once you're connected to this subscription: wss://ws.amberdata.com/futures, your subscription message must include either a pair/instrument or an exchange field. At least one must be specified — both cannot be empty.

🗒️

Note:

  • Instrument-level wildcards (e.g., "instrument": "ALL") are no longer supported.
  • Exchange-level wildcard subscriptions are only supported for Spot markets.
  • For Futures and Options, you must subscribe using explicit instrument-level subscriptions. See here for more details.

Request

{
  "jsonrpc" : "2.0",
  "id"      : 1,
  "method"  : "subscribe",
  "params"  : [ "market:futures:open_interests", { "instrument": "XRPUSDT", "exchange": "binance" } ]
}
ParamTypeDescription
instrumentstringThe asset instrument.
exchangestringThe 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
        }
    }
}
FieldTypeDescription
exchangestringThe exchange name.
instrumentstringThe instrument name.
timestampnumberThe time at which the data was received.
valuestringThe total open interest for the specified instrument.
typestringThe 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));
});