HomeDocumentationAPI Reference
Log In
API Reference

Trades (Instrument Name)

Channel Name Schema

trades.{instrument_name}

Subscribe to trades (order executions) for a given instrument name.

Channel Parameters

instrument_name  string required
Instrument name

Notification Data

channel  string required
Subscribed channel name

data  array of objects required

data[]. direction  string required
Direction of the taker order
enum buy sell

data[]. index_price  string required
Index price of the underlying at the time of the trade

data[]. instrument_name  string required
Instrument name

data[]. mark_price  string required
Mark price of the instrument at the time of the trade

data[]. quote_id  string or null required
Quote ID if the trade was executed via RFQ

data[]. timestamp  integer required
Trade timestamp (in ms since Unix epoch)

data[]. trade_amount  string required
Amount filled in this trade

data[]. trade_id  string required
Trade ID

data[]. trade_price  string required
Price at which the trade was filled

Example

Subscriptions are only available via websockets.

{request_example_javascript}
{request_example_python}

Notification messages on this channel will look like this:

{response_example_json}