HomeDocumentationAPI Reference
Log In
API Reference

(Subaccount Id) Quotes

Channel Name Schema

{subaccount_id}.quotes

Subscribe to quote state for a given subaccount ID.
This will notify the usser about the state change of the quotes they have sent.

Channel Parameters

subaccount_idintegerrequired
Subaccount ID to get quote state updates for

Notification Data

channelstringrequired
Subscribed channel name
dataarray of objectsrequired
data[].cancel_reasonstringrequired
Cancel reason, if any
enum user_requestinsufficient_marginsigned_max_fee_too_lowmmp_triggercancel_on_disconnectsession_key_deregisteredsubaccount_withdrawnrfq_no_longer_opencompliance
data[].creation_timestampintegerrequired
Creation timestamp in ms since Unix epoch
data[].directionstringrequired
Quote direction
enum buysell
data[].feestringrequired
Fee paid for this quote (if executed)
data[].fill_pctstringrequired
Percentage of the RFQ that this quote would fill, from 0 to 1.
data[].is_transferbooleanrequired
Whether the order was generated through private/transfer_position
data[].labelstringrequired
User-defined label, if any
data[].last_update_timestampintegerrequired
Last update timestamp in ms since Unix epoch
data[].legs_hashstringrequired
Hash of the legs of the best quote to be signed by the taker.
data[].liquidity_rolestringrequired
Liquidity role
enum makertaker
data[].max_feestringrequired
Signed max fee
data[].mmpbooleanrequired
Whether the quote is tagged for market maker protections (default false)
data[].nonceintegerrequired
Nonce
data[].quote_idstringrequired
Quote ID
data[].rfq_idstringrequired
RFQ ID
data[].signaturestringrequired
Ethereum signature of the quote
data[].signature_expiry_secintegerrequired
Unix timestamp in seconds
data[].signerstringrequired
Owner wallet address or registered session key that signed the quote
data[].statusstringrequired
Status
enum openfilledcancelledexpired
data[].subaccount_idintegerrequired
Subaccount ID
data[].tx_hashstring or nullrequired
Blockchain transaction hash (only for executed quotes)
data[].tx_statusstring or nullrequired
Blockchain transaction status (only for executed quotes)
enum requestedpendingsettledrevertedignoredtimed_out
data[].legsarray of objectsrequired
Quote legs
data[].legs[].amountstringrequired
Amount in units of the base
data[].legs[].directionstringrequired
Leg direction
enum buysell
data[].legs[].instrument_namestringrequired
Instrument name
data[].legs[].pricestringrequired
Leg price

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}