market:futures:tickers

Subscribes/Unsubscribes to market futures Tickers data.

Once you're connected to this subscription: wss://ws.amberdata.com/futures, every subscription message must include an explicit instrument. This is mandatory across all market types.

  • You must always specify the instrument.
  • For Futures and Options, you must also include the exchange field.

See here for more details and examples.

Request

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

Response

{
    "jsonrpc": "2.0",
    "method": "subscription",
    "params": {
        "subscription": "d5475b6c-552a-4ab6-903a-ba054e468ab5",
        "result": {
            "exchange": "binance",
            "instrument": "BTCUSDT",
            "exchangeTimestamp": 1711571015981,
            "exchangeTimestampNanoseconds": 0,
            "timestamp": 1711571015981,
            "bid": 69135.9,
            "ask": 69136,
            "mid": 69135.95,
            "last": null,
            "sequence": 4292896044090,
            "markPrice": 69136.1,
            "lastVolume": null,
            "bidVolume": 9.517,
            "askVolume": 0.527
        }
    }
}
FieldTypeDescription
exchangestringThe exchange name.
instrumentstringThe instrument name.
exchangeTimestampnumberThe exchange provided timestamp.
exchangeTimestampNanosecondsnumberThe exchange provided nanosecond part of the exchangeTimestamp (if available from the exchange).
timestampnumberThe timestamp at which the event took place.
bidnumberThe bid of the instrument.
asknumberThe ask of the instrument.
midnumberThe mid of the instrument.
lastnumberThe last of the instrument.
sequencenumberThe sequence number (equal to null if it is not provided by the exchange).
lastVolumenumberThe last volume for the instrument.
bidVolumenumberThe order size of the best bid.
askVolumenumberThe order size of the best ask.

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

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