user.order

CHANNEL 
wss://stream.crypto.com/fcm/v1/user
user.orderPrivate

Order updates for the user. Subscribe with channel ["user.order"]. Initial response with same id contains current open orders; subsequent messages (id -1) are live updates.

Request

Body

required

id integerrequired

Request id

method stringrequired

Possible values: [subscribe]

params objectrequired

channels string[]required

e.g. ["user.order"]

nonce integerrequired

Current timestamp in milliseconds

WebSocket response

Schema

id int64
method string
code int32
result object
instrument_name string
subscription string
channel string
data object[]
Array [
account_id string
Account ID.
order_id int64
Order ID.
client_oid string
Client Order ID.
order_type string
Possible values: [LIMIT, MARKET, STOP, STOP_LIMIT]
Order type:
• ➖ LIMIT, MARKET
• ➖ STOP, STOP_LIMIT: Trigger orders
time_in_force WsTimeInForce (string)
Possible values: [IMMEDIATE_OR_CANCEL]
Time in force. Only IMMEDIATE_OR_CANCEL (IOC) is accepted for Combo orders.
side WsOrderSide (string)
Possible values: [BUY, SELL]
BUY or SELL
exec_inst WsExecInstOrderDetail (string)[]
Possible values: [POST_ONLY, REDUCE_ONLY, SMART_POST_ONLY]
Execution instructions.
quantity decimal
Quantity specified in the order.
limit_price decimal
Limit price specified in the order.
order_value decimal
Order value.
avg_price decimal
Average price.
cumulative_quantity decimal
Cumulative executed quantity.
cumulative_value decimal
Cumulative executed value.
cumulative_fee decimal
Cumulative executed fee.
status WsOrderStatus (string)
Possible values: [PENDING, NEW, ACTIVE, FILLED, CANCELED, REJECTED, EXPIRED]
Order status
update_user_id string
Updated user.
order_date string
Order creation date.
instrument_name string
E.g. BTCUSD-PERP.
fee_instrument_name string
Currency used for the fees.
create_time int64
Order creation timestamp (ms), e.g. "1771761038000".
create_time_ns int64
Order creation timestamp (nanosecond), e.g. "1771761038000000000".
update_time int64
Order update timestamp (ms), e.g. "1771761038000".
reason string
Rejection reason code; present for get-order-detail and get-order-history.
ref_price decimal
Trigger reference price (trigger legs only).
ref_price_type string
Possible values: [MARK_PRICE, INDEX_PRICE, LAST_PRICE]
Price source used for ref_price: MARK_PRICE, INDEX_PRICE, or LAST_PRICE (trigger legs only).
transaction_time_ns int64
Transaction timestamp in nanoseconds.
]