Skip to main content

Module messages

Module messages 

Source
Expand description

WebSocket message types for the Coinbase Advanced Trade API.

All incoming messages share an envelope with channel, timestamp, sequence_num, and a channel-specific events array. Outgoing subscription messages use a flat format with type, product_ids, channel, and jwt.

Structs§

CoinbaseWsSubscription
Subscribe or unsubscribe request sent to the WebSocket.
WsCandle
A single candle from the candles channel.
WsCandlesEvent
Candles event.
WsFcmBalanceSummary
Futures balance summary snapshot.
WsFuturesBalanceSummaryEvent
Futures balance summary event.
WsHeartbeatEvent
Heartbeat event.
WsL2DataEvent
L2 data event containing book updates.
WsL2Update
A single order book level update.
WsMarginWindowMeasure
Margin window summary inside a futures balance snapshot.
WsMarketTradesEvent
Market trades event.
WsOrderUpdate
Order status update from the user channel.
WsStatusEvent
Status channel event.
WsStatusProduct
Status channel product snapshot.
WsSubscriptionsEvent
Subscription confirmation event.
WsTicker
Ticker data for a single product.
WsTickerEvent
Ticker event.
WsTrade
A single trade from the market_trades channel.
WsUserEvent
User event containing order status updates.

Enums§

CoinbaseWsAction
WebSocket subscription action type.
CoinbaseWsMessage
Top-level WebSocket message dispatched by channel.
WsBookSide
Book side in L2 data messages.
WsEventType
Event type discriminator for snapshot vs incremental update.