(Subaccount Id) Orders

Channel Name Schema

{subaccount_id}.orders

Subscribe to changes in user's orders for a given subaccount ID.

Channel Parameters

subaccount_id integer required
Subaccount ID

Notification Data

channel string required
Subscribed channel name
data array of objects required
data[].amount string required
Order amount in units of the base
data[].average_price string required
Average fill price
data[].cancel_reason string required
If cancelled, reason behind order cancellation
enum user_request mmp_trigger insufficient_margin signed_max_fee_too_low cancel_on_disconnect ioc_or_market_partial_fill session_key_deregistered subaccount_withdrawn compliance
data[].creation_timestamp integer required
Creation timestamp (in ms since Unix epoch)
data[].direction string required
Order direction
enum buy sell
data[].filled_amount string required
Total filled amount for the order
data[].instrument_name string required
Instrument name
data[].is_transfer boolean required
Whether the order was generated through private/transfer_position
data[].label string required
Optional user-defined label for the order
data[].last_update_timestamp integer required
Last update timestamp (in ms since Unix epoch)
data[].limit_price string required
Limit price in quote currency
data[].max_fee string required
Max fee in units of the quote currency
data[].mmp boolean required
Whether the order is tagged for market maker protections
data[].nonce integer required
Unique nonce defined as (e.g. 1695836058725001, where 001 is the random number)
data[].order_fee string required
Total order fee paid so far
data[].order_id string required
Order ID
data[].order_status string required
Order status
enum open filled rejected cancelled expired
data[].order_type string required
Order type
enum limit market
data[].quote_id string or null required
Quote ID if the trade was executed via RFQ
data[].signature string required
Ethereum signature of the order
data[].signature_expiry_sec integer required
Signature expiry timestamp
data[].signer string required
Owner wallet address or registered session key that signed order
data[].subaccount_id integer required
Subaccount ID
data[].time_in_force string required
Time in force
enum gtc post_only fok ioc
data[].replaced_order_id string or null
If replaced, ID of the order that was replaced

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}