Module messages

Module messages 

Source
Expand description

Data structures modelling OKX WebSocket request and response payloads.

Structs§

OKXAlgoOrderMsg
Represents an algo order message from WebSocket updates.
OKXAuthentication
OKX WebSocket authentication message.
OKXAuthenticationArg
OKX WebSocket authentication arguments.
OKXBookMsg
Order book data for an instrument.
OKXCandleMsg
Candlestick data for an instrument.
OKXEstimatedPriceMsg
Estimated delivery/exercise price data.
OKXFundingRateMsg
Funding rate data for perpetual swaps.
OKXIndexPriceMsg
Index price data.
OKXMarkPriceMsg
Mark price data for perpetual swaps.
OKXOpenInterestMsg
Open interest data.
OKXOptionSummaryMsg
Option market data summary.
OKXOrderMsg
Order update message from WebSocket orders channel.
OKXPriceLimitMsg
Price limit data (upper and lower limits).
OKXStatusMsg
Platform status updates.
OKXSubscription
OKXSubscriptionArg
OKXTickerMsg
Ticker data for an instrument.
OKXTradeMsg
Trade data for an instrument.
OKXWebSocketArg
OKXWebSocketError
Represents an OKX WebSocket error.
OKXWsRequest
Generic WebSocket request for OKX trading commands.
OrderBookEntry
Represents a single order in the order book.
WsAmendOrderParams
Parameters for WebSocket amend order operation (instType not included).
WsAmendOrderParamsBuilder
Builder for WsAmendOrderParams.
WsCancelAlgoOrderParams
Parameters for WebSocket cancel algo order operation.
WsCancelAlgoOrderParamsBuilder
Builder for WsCancelAlgoOrderParams.
WsCancelOrderParams
Parameters for WebSocket cancel order operation (instType not included).
WsCancelOrderParamsBuilder
Builder for WsCancelOrderParams.
WsMassCancelParams
Parameters for WebSocket mass cancel operation.
WsMassCancelParamsBuilder
Builder for WsMassCancelParams.
WsPostAlgoOrderParams
Parameters for WebSocket algo order placement.
WsPostAlgoOrderParamsBuilder
Builder for WsPostAlgoOrderParams.
WsPostOrderParams
Parameters for WebSocket place order operation.
WsPostOrderParamsBuilder
Builder for WsPostOrderParams.

Enums§

ExecutionReport
NautilusWsMessage
OKXWebSocketEvent
WsAmendOrderParamsBuilderError
Error type for WsAmendOrderParamsBuilder
WsCancelAlgoOrderParamsBuilderError
Error type for WsCancelAlgoOrderParamsBuilder
WsCancelOrderParamsBuilderError
Error type for WsCancelOrderParamsBuilder
WsMassCancelParamsBuilderError
Error type for WsMassCancelParamsBuilder
WsPostAlgoOrderParamsBuilderError
Error type for WsPostAlgoOrderParamsBuilder
WsPostOrderParamsBuilderError
Error type for WsPostOrderParamsBuilder