Subscribes/Unsubscribes to market futures OHLCV data.
Make sure you're connected to this subscription: wss://ws.web3api.io. Either the instrument or exchange have to be specified - one needs to be specified, but both cannot be empty.
Request
{
"jsonrpc" : "2.0",
"id" : 1,
"method" : "subscribe",
"params" : [ "market:options:ohlcv", { "instrument": "BTC-10DEC21-100000-C", "exchange": "deribit"} ]
}
Param | Type | Description |
---|---|---|
instrument | string | The asset instrument. |
exchange | string | The exchange for which to retrieve asset instruments. |
Response
"result": {
"exchange": "deribit",
"instrument": "BTC-10DEC21-100000-C",
"timestamp": "1638174960000",
"open": 0.0005,
"high": 0.0005,
"low": 0.0005,
"close": 0.0005,
"volume": 0
},
Field | Type | Description |
---|---|---|
exchange | string | The exchange. |
timestamp | number | The time at which the trade took place. |
Example
const WebSocket = require('ws');
const ws = new WebSocket('wss://ws.web3api.io/', {headers: {x-api-key:'<api_key>'}});
ws.on('open', () => {
ws.send(JSON.stringify({
jsonrpc: '2.0',
method: 'subscribe',
params: ['market:options:ohlcv', {'instrument': 'BTC-10DEC21-100000-C', 'exchange': 'deribit'}],
id: 1,
}));
});
ws.on('message', data => {
console.log(JSON.stringify(JSON.parse(data), null, 2));
});