Skip to main content
WSS
HmacApiKey
type:userPassword

L2 HMAC API key triplet (apiKey, secret, passphrase) delivered inside the /ws/user subscribe message body, not in the HTTP upgrade headers. The triplet is created or derived via the L1 ClobAuth EIP-712 flow described in Smart accounts.

Subscribed ack
type:object

Acknowledges successful subscription with the resolved market id list.

order_accepted
type:object

XO-native order accepted ack.

order_filled
type:object

XO-native order fully filled.

order_cancelled
type:object

XO-native order cancellation ack.

fill (XO-native)
type:object

XO-native fill emitted on /ws.

market_status_changed
type:object

Market status transition with count of auto-cancelled orders.

book
type:object

Full L2 snapshot for a market. Sent on subscribe (when initial_dump=true), after order placement / cancellation, and after fills.

price_change
type:object

Order-level price/size delta(s) for a market.

last_trade_price
type:object

Fill execution at the taker's effective price.

best_bid_ask
type:object

Top-of-book update. Requires custom_feature_enabled=true.

order
type:object

Order lifecycle event (PLACEMENT, UPDATE, CANCELLATION, REJECTED). Only the affected user receives this.

trade (MATCHED)
type:object

Fill executed. Both maker and taker receive this event with their own trader_side.

trade (settlement status)
type:object

Status transition for a previously-emitted trade (MINED, CONFIRMED, RETRYING, FAILED).

orders_rebalanced
type:object

Emitted when the user's orders are auto-cancelled due to a balance change (withdrawal, AMM trade, etc.).

trading_state_changed
type:object

Global trading-state change broadcast to every connection.

Error
type:object

Generic error reply.

Subscribe (XO-native, action-based)
type:object

XO-native action-based subscribe; only honored on the combined feed.

Subscribe (market channel)
type:object

Subscribe to public market events for one or more token IDs.

Subscribe (user channel)
type:object

Authenticate and subscribe to user events. Empty markets subscribes to all of the user's markets.

Place order (inline)
type:object

Submit an EIP-712-signed CTF order over the combined feed.

Cancel order (inline)
type:object

Cancel a resting order over the combined feed.