HomeDocumentationAPI Reference
Log In
API Reference

Trades (Instrument Type) (Currency)

Channel Name Schema

trades.{instrument_type}.{currency}

Subscribe to trades (order executions) for a given instrument type and currency.

Channel Parameters

currencystringrequired
Currency
instrument_typestringrequired
Instrument type
enum erc20optionperp

Notification Data

channelstringrequired
Subscribed channel name
dataarray of objectsrequired
data[].directionstringrequired
Direction of the taker order
enum buysell
data[].index_pricestringrequired
Index price of the underlying at the time of the trade
data[].instrument_namestringrequired
Instrument name
data[].mark_pricestringrequired
Mark price of the instrument at the time of the trade
data[].quote_idstring or nullrequired
Quote ID if the trade was executed via RFQ
data[].timestampintegerrequired
Trade timestamp (in ms since Unix epoch)
data[].trade_amountstringrequired
Amount filled in this trade
data[].trade_idstringrequired
Trade ID
data[].trade_pricestringrequired
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}