ticker.{instrument_name}.{interval}
Description
Subscribe to ticker updates for a specific instrument and interval.
Request Path And Method
wss path:
/ws/public
method:
public/subscribe
Request Example
{
"method": "public/subscribe",
"rid": 6,
"params": {
"channels": [
"ticker.BTC-PERPETUAL.raw"
]
}
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| instrumentName | string | true | Instrument name |
| interval | string | true | Frequency of notifications. Events will be aggregated over this interval. Valid values: agg2, 100ms, raw. The value raw means no aggregation will be applied (Please note that raw interval is only available to authorized users) |
Notification Message
| Name | Type | Description |
|---|---|---|
| method | string | Equals to subscription |
| channel | string | Equals to ticker |
| result | object | Response data |
| > greeks | object | Only for options |
| >> delta | string | (Only for option) The delta value for the option |
| >> gamma | string | (Only for option) The gamma value for the option |
| >> rho | string | (Only for option) The rho value for the option |
| >> theta | string | (Only for option) The theta value for the option |
| >> vega | string | (Only for option) The vega value for the option |
| > indexPrice | string | Current index price |
| > instrumentName | string | Unique instrument identifier |
| > markPrice | string | The mark price for the instrument |
| > markIv | string | (Only for option) implied volatility for mark price |
| > timestamp | long | The timestamp (milliseconds since the Unix epoch) |