Subscribes/Unsubscribes to market futures Tickers 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:tickers", { "instrument": "BTCUSDT", "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": "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
}
}
}
Field | Type | Description |
---|---|---|
exchange | string | The exchange name. |
instrument | string | The instrument name. |
exchangeTimestamp | number | The exchange provided timestamp. |
exchangeTimestampNanoseconds | number | The exchange provided nanosecond part of the exchangeTimestamp (if available from the exchange). |
timestamp | number | The timestamp at which the event took place. |
bid | number | The bid of the instrument. |
ask | number | The ask of the instrument. |
mid | number | The mid of the instrument. |
last | number | The last of the instrument. |
sequence | number | The sequence number (equal to null if it is not provided by the exchange). |
lastVolume | number | The last volume for the instrument. |
bidVolume | number | The order size of the best bid. |
askVolume | number | The 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));
});