trades.{instrument_name}.{interval}
Description
Get notifications about trades for an instrument.
New since 2025-10-14
Request Path And Method
wss path:
/ws/public
method:
public/subscribe
Request Example
{
"method": "public/subscribe",
"rid": 8,
"params": {
"channels": [
"trades.BTC-PERPETUAL.100ms"
]
}
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| instrument_name | string | true | Instrument name |
| interval | string | true | Frequency of notifications. Events will be aggregated over this interval. 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 trades |
| result | array | Array of trade objects |
| > quantity | string | Trade amount. For perpetual and inverse futures the amount is in USD units. For options and linear futures and it is the underlying base currency coin |
| > blocRfqId | string | ID of the Block RFQ - when trade was part of the Block RFQ |
| > blockTradeId | string | Block trade id - when trade was part of a block trade |
| > blockTradeLegCount | integer | Block trade leg count - when trade was part of a block trade |
| > comboId | string | Optional field containing combo instrument name if the trade is a combo trade |
| > comboTradeId | string | Optional field containing combo trade identifier if the trade is a combo trade |
| > contracts | string | Trade size in contract units (optional, may be absent in historical trades) |
| > direction | string | Direction: buy, or sell |
| > indexPrice | string | Index Price at the moment of trade |
| > instrumentName | string | Unique instrument identifier |
| > iv | string | Option implied volatility for the price (Option only) |
| > liquidation | string | Optional field (only for trades caused by liquidation): "M" when maker side of trade was under liquidation, "T" when taker side was under liquidation, "MT" when both sides of trade were under liquidation |
| > markPrice | string | Mark Price at the moment of trade |
| > price | string | Price in base currency |
| > tickDirection | integer | Direction of the "tick" (0 = Plus Tick, 1 = Zero-Plus Tick, 2 = Minus Tick, 3 = Zero-Minus Tick) |
| > timestamp | long | The timestamp of the trade (milliseconds since the UNIX epoch) |
| > tradeId | string | Unique (per currency) trade identifier |
| > tradeSeq | integer | The sequence number of the trade within instrument |