market:futures:trades

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

Response

{
    "jsonrpc": "2.0",
    "method": "subscription",
    "params": {
        "subscription": "1e235200-b099-457c-956d-e981605ab105",
        "result": {
            "exchange": "binance",
            "instrument": "XRPUSDT",
            "exchangeTimestamp": 1711571031275,
            "exchangeTimestampNanoseconds": 0,
            "isBuySide": false,
            "quoteSize": null,
            "price": 0.6159,
            "size": 211.4,
            "tradeId": "1443425767"
        }
    }
}
FieldTypeDescription
exchangestringThe exchange name.
instrumentstringThe instrument name.
exchangeTimestampnumberThe timestamp at which the event was recorded by the exchange.
exchangeTimestampNanosecondsnumberThe nanosecond timestamp at which the event was recorded by the exchange.
isBuySidebooleanA boolean value indicating the direction of the trade from the perspective of the initiator.
quoteSizenumberThe total amount of the quote asset of the instrument that was traded.
pricenumberThe price at which the futures contract was traded.
sizenumberThe quantity of the contract that was traded.
tradeIdstringA unique identifier for this specific trade.

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

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