Skip to main content

Module model

Module model 

Source
Expand description

Typed response rows for OKX WebSocket channels.

Every channel exposed by crate::ws::channels has a corresponding model below. OKX occasionally adds fields without a version bump, so object rows keep unrecognized fields in extra while still exposing the documented fields as first-class Rust members.

Models are organised by OKX’s own API documentation categories:

SubmoduleCategoryAuth
marketMarket DataPublic
public_dataPublic DataPublic
statusStatusPublic
accountTrading AccountPrivate
tradeTradePrivate
algoAlgo TradingPrivate
gridTrading BotsPrivate
blockBlock TradingMixed
spreadSpread TradingMixed
fundingFundingPrivate

Re-exports§

pub use account::AccountBalanceUpdate;
pub use account::AccountGreeksUpdate;
pub use account::AccountUpdate;
pub use account::BalData;
pub use account::BalanceAndPositionUpdate;
pub use account::CloseOrderAlgo;
pub use account::LiquidationWarningUpdate;
pub use account::PosData;
pub use account::PositionUpdate;
pub use account::Trade;
pub use algo::AdvancedAlgoOrderUpdate;
pub use algo::AlgoOrderUpdate;
pub use algo::LinkedOrder;
pub use block::BlockLeg;
pub use block::BlockQuoteUpdate;
pub use block::BlockRfqUpdate;
pub use block::BlockTickerUpdate;
pub use block::PublicBlockTradeUpdate;
pub use block::PublicStructureBlockTradeUpdate;
pub use block::StructureBlockTradeUpdate;
pub use funding::DepositInfoUpdate;
pub use funding::WithdrawalInfoUpdate;
pub use grid::CopyTradingNotification;
pub use grid::GridOrderUpdate;
pub use grid::GridPositionUpdate;
pub use grid::GridSubOrderUpdate;
pub use grid::RebateTrans;
pub use grid::RecurringBuyAllocation;
pub use grid::RecurringBuyOrderUpdate;
pub use grid::TradingBotUpdate;
pub use grid::TriggerParam;
pub use market::AllTradeUpdate;
pub use market::BookLevel;
pub use market::CallAuctionDetailsUpdate;
pub use market::CandleUpdate;
pub use market::OptionTradeUpdate;
pub use market::OrderBookUpdate;
pub use market::TickerUpdate;
pub use market::TradeUpdate;
pub use public_data::AdlWarningUpdate;
pub use public_data::EconomicCalendarUpdate;
pub use public_data::EstimatedPriceUpdate;
pub use public_data::EventContractMarketUpdate;
pub use public_data::FundingRateUpdate;
pub use public_data::IndexCandleUpdate;
pub use public_data::IndexTickerUpdate;
pub use public_data::InstrumentUpcomingParamChange;
pub use public_data::InstrumentUpdate;
pub use public_data::LiquidationOrderDetail;
pub use public_data::LiquidationOrderUpdate;
pub use public_data::MarkPriceCandleUpdate;
pub use public_data::MarkPriceUpdate;
pub use public_data::OpenInterestUpdate;
pub use public_data::OptionSummaryUpdate;
pub use public_data::PriceLimitUpdate;
pub use spread::SpreadAmendOrderResult;
pub use spread::SpreadCancelOrderResult;
pub use spread::SpreadMassCancelResult;
pub use spread::SpreadOrderUpdate;
pub use spread::SpreadPlaceOrderResult;
pub use spread::SpreadPublicTradeUpdate;
pub use spread::SpreadTickerUpdate;
pub use spread::SpreadTradeLeg;
pub use spread::SpreadTradeUpdate;
pub use status::StatusUpdate;
pub use trade::AmendOrderResult;
pub use trade::CancelOrderResult;
pub use trade::FillUpdate;
pub use trade::MassCancelOperationResult;
pub use trade::OrderUpdate;
pub use trade::PlaceOrderResult;

Modules§

account
Trading account channel models (account, positions, balance_and_position, etc.).
algo
Algo trading channel models (orders-algo, algo-advance).
block
Block trading channel models (rfqs, quotes, struc-block-trades, block-tickers).
funding
Funding account channel models (deposit-info, withdrawal-info).
grid
Trading bot channel models (grid-orders-*, grid-positions, recurring-buy, etc.).
market
Market data channel models (tickers, candles, trades, books, etc.).
public_data
Public reference data channel models (instruments, funding-rate, open-interest, etc.).
spread
Spread trading channel models (sprd-orders, sprd-trades) and spread-operation result rows.
status
System status channel model (status).
trade
Trade channel models (orders, fills) and order-operation result rows.

Structs§

WsRow
Generic object row for custom/future channels.

Type Aliases§

ExtraFields
Fields added by OKX after this crate was released.