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_id  integer required
Subaccount ID to get quote state updates for

Notification Data

channel  string required
Subscribed channel name

data  array of objects required

data[]. cancel_reason  string required
Cancel reason, if any
enum user_request insufficient_margin signed_max_fee_too_low mmp_trigger cancel_on_disconnect session_key_deregistered subaccount_withdrawn rfq_no_longer_open compliance

data[]. creation_timestamp  integer required
Creation timestamp in ms since Unix epoch

data[]. direction  string required
Quote direction
enum buy sell

data[]. fee  string required
Fee paid for this quote (if executed)

data[]. fill_pct  string required
Percentage of the RFQ that this quote would fill, from 0 to 1.

data[]. is_transfer  boolean required
Whether the order was generated through private/transfer_position

data[]. label  string required
User-defined label, if any

data[]. last_update_timestamp  integer required
Last update timestamp in ms since Unix epoch

data[]. legs_hash  string required
Hash of the legs of the best quote to be signed by the taker.

data[]. liquidity_role  string required
Liquidity role
enum maker taker

data[]. max_fee  string required
Signed max fee

data[]. mmp  boolean required
Whether the quote is tagged for market maker protections (default false)

data[]. nonce  integer required
Nonce

data[]. quote_id  string required
Quote ID

data[]. rfq_id  string required
RFQ ID

data[]. signature  string required
Ethereum signature of the quote

data[]. signature_expiry_sec  integer required
Unix timestamp in seconds

data[]. signer  string required
Owner wallet address or registered session key that signed the quote

data[]. status  string required
Status
enum open filled cancelled expired

data[]. subaccount_id  integer required
Subaccount ID

data[]. tx_hash  string or null required
Blockchain transaction hash (only for executed quotes)

data[]. tx_status  string or null required
Blockchain transaction status (only for executed quotes)
enum requested pending settled reverted ignored timed_out

data[]. legs  array of objects required
Quote legs

data[].legs[]. amount  string required
Amount in units of the base

data[].legs[]. direction  string required
Leg direction
enum buy sell

data[].legs[]. instrument_name  string required
Instrument name

data[].legs[]. price  string required
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}