Subscribes/Unsubscribes to market futures Order Book Events data.
Make sure you're connected. Either the instrument or exchange have to be specified - one needs to be specified, but both cannot be empty.
Note that there is a dedicated URL for this subscription: wss://ws.web3api.io/futures.
Request
{
"jsonrpc" : "2.0",
"id" : 1,
"method" : "subscribe",
"params" : [ "market:futures:order:events", { "instrument": "XRPUSDT", "exchange": "binance" } ]
}
Param | Type | Description |
---|---|---|
instrument | string | The asset instrument. |
exchange | string | The exchange for which to retrieve asset instruments. |
Response
"result": {
"exchange": "binance",
"instrument": "XRPUSDT",
"timestamp": 1607744820000.0,
"exchangeTimestamp": 1607744862915,
"exchangeTimestampNanoseconds": 758789,
"receivedTimestamp": 1607744862915,
"receivedTimestampNanoseconds": 758789,
"isBid": true,
"data": [
[
0.00002808,
0.0
]
],
"sequence": 1124155158
}
Field | Type | Description |
---|---|---|
exchange | string | The exchange. |
timestamp | number | The time at which the order book event took place. |
Example
const WebSocket = require('ws');
const ws = new WebSocket('wss://ws.web3api.io/futures', {headers: {x-api-key:'<api_key>'}});
ws.on('open', () => {
ws.send(JSON.stringify({
jsonrpc: '2.0',
method: 'subscribe',
params: ['market:futures:order:events', {'instrument': 'XRPUSDT', 'exchange': 'binance'}],
id: 1,
}));
});
ws.on('message', data => {
console.log(JSON.stringify(JSON.parse(data), null, 2));
});