market:options:ohlcv

Once you're connected to this subscription: wss://ws.amberdata.com/options, 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: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

{
    "jsonrpc": "2.0",
    "method": "subscription",
    "params": {
        "subscription": "203e79ed-3985-4fb8-a8d6-bef7cebc2fda",
        "result": {
            "exchange": "deribit",
            "instrument": "BTC-12APR24-71000-C",
            "timestamp": 1711571340000,
            "open": 0.049,
            "high": 0.049,
            "low": 0.049,
            "close": 0.049,
            "volume": 0
        }
    }
}

Field	Type	Description
exchange	`string`	The exchange name.
instrument	`string`	The instrument name.
timestamp	`number`	The time at which the event took place.
open	`number`	The price at which the first trade occurred during the specified period.
high	`number`	The highest price at which a trade took place during the period.
low	`number`	The lowest price at which a trade occurred during the period.
close	`number`	The price at which the last trade occurred during the specified period.
volume	`number`	The total quantity traded during the period.

Example

const WebSocket = require('ws');
const ws = new WebSocket('wss://ws.amberdata.com/options', {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));
});