Expand description
Request parameter structures for the OKX v5 REST API.
Each struct corresponds 1-to-1 with an OKX REST endpoint and is annotated
using serde so that it can be serialized directly into the query string
or request body expected by the exchange.
The inline documentation repeats the required/optional fields described in the official OKX documentation and, where beneficial, links to the exact endpoint section. All links point to the English version.
Parameter structs are built using the builder pattern and then passed to
OKXHttpClient::get/post where they are automatically serialized.
Structs§
- GetAlgo
Orders Params - Parameters for the GET /api/v5/trade/order-algo-* endpoints.
- GetAlgo
Orders Params Builder - Builder for
GetAlgoOrdersParams. - GetCandlesticks
Params - Parameters for the GET /api/v5/market/history-candles endpoint.
- GetCandlesticks
Params Builder - Builder for GetCandlesticksParams with validation.
- GetEvent
Contract Events Params - Parameters for the GET /api/v5/public/event-contract/events endpoint.
- GetEvent
Contract Events Params Builder - Builder for
GetEventContractEventsParams. - GetEvent
Contract Markets Params - Parameters for the GET /api/v5/public/event-contract/markets endpoint.
- GetEvent
Contract Markets Params Builder - Builder for
GetEventContractMarketsParams. - GetEvent
Contract Series Params - Parameters for the GET /api/v5/public/event-contract/series endpoint.
- GetEvent
Contract Series Params Builder - Builder for
GetEventContractSeriesParams. - GetFunding
Rate History Params - Parameters for the GET /api/v5/public/funding-rate-history endpoint.
- GetFunding
Rate History Params Builder - Builder for
GetFundingRateHistoryParams. - GetIndex
Ticker Params - Parameters for the GET /api/v5/market/index-tickers.
- GetIndex
Ticker Params Builder - Builder for
GetIndexTickerParams. - GetInstruments
Params - Parameters for the GET /api/v5/public/instruments endpoint.
- GetInstruments
Params Builder - Builder for
GetInstrumentsParams. - GetMark
Price Params - Parameters for the GET /api/v5/public/mark-price.
- GetMark
Price Params Builder - Builder for
GetMarkPriceParams. - GetOption
Summary Params - Parameters for the GET /api/v5/public/opt-summary endpoint.
- GetOption
Summary Params Builder - Builder for
GetOptionSummaryParams. - GetOrder
Book Params - Parameters for the GET /api/v5/market/books endpoint.
- GetOrder
Book Params Builder - Builder for
GetOrderBookParams. - GetOrder
History Params - Parameters for the GET /api/v5/trade/order-history endpoint.
- GetOrder
History Params Builder - Builder for
GetOrderHistoryParams. - GetOrder
List Params - Parameters for the GET /api/v5/trade/orders-pending endpoint.
- GetOrder
List Params Builder - Builder for
GetOrderListParams. - GetOrder
Params - Parameters for the GET /api/v5/trade/order endpoint (fetch order details).
- GetOrder
Params Builder - Builder for
GetOrderParams. - GetPosition
Tiers Params - Parameters for the GET /api/v5/public/position-tiers endpoint.
- GetPosition
Tiers Params Builder - Builder for
GetPositionTiersParams. - GetPositions
History Params - Parameters for the GET /api/v5/account/positions-history endpoint.
- GetPositions
History Params Builder - Builder for
GetPositionsHistoryParams. - GetPositions
Params - Parameters for the GET /api/v5/public/positions endpoint.
- GetPositions
Params Builder - Builder for
GetPositionsParams. - GetSpread
Order Params - Parameters for the GET /api/v5/sprd/order endpoint.
- GetSpread
Order Params Builder - Builder for
GetSpreadOrderParams. - GetSpread
Orders Params - Parameters for the GET /api/v5/sprd/orders-pending and orders-history endpoints.
- GetSpread
Orders Params Builder - Builder for
GetSpreadOrdersParams. - GetSpread
Trades Params - Parameters for the GET /api/v5/sprd/trades endpoint.
- GetSpread
Trades Params Builder - Builder for
GetSpreadTradesParams. - GetSpreads
Params - Parameters for the GET /api/v5/sprd/spreads endpoint.
- GetSpreads
Params Builder - Builder for
GetSpreadsParams. - GetTrade
FeeParams - Parameters for the GET /api/v5/account/trade-fee endpoint.
- GetTrade
FeeParams Builder - Builder for
GetTradeFeeParams. - GetTrades
Params - Parameters for the GET /api/v5/market/history-trades endpoint.
- GetTrades
Params Builder - Builder for
GetTradesParams. - GetTransaction
Details Params - Parameters for the GET /api/v5/trade/fills endpoint (transaction details).
- GetTransaction
Details Params Builder - Builder for
GetTransactionDetailsParams. - SetPosition
Mode Params - Parameters for the POST /api/v5/account/set-position-mode endpoint.
- SetPosition
Mode Params Builder - Builder for
SetPositionModeParams.
Enums§
- GetAlgo
Orders Params Builder Error - Error type for GetAlgoOrdersParamsBuilder
- GetEvent
Contract Events Params Builder Error - Error type for GetEventContractEventsParamsBuilder
- GetEvent
Contract Markets Params Builder Error - Error type for GetEventContractMarketsParamsBuilder
- GetEvent
Contract Series Params Builder Error - Error type for GetEventContractSeriesParamsBuilder
- GetFunding
Rate History Params Builder Error - Error type for GetFundingRateHistoryParamsBuilder
- GetIndex
Ticker Params Builder Error - Error type for GetIndexTickerParamsBuilder
- GetInstruments
Params Builder Error - Error type for GetInstrumentsParamsBuilder
- GetMark
Price Params Builder Error - Error type for GetMarkPriceParamsBuilder
- GetOption
Summary Params Builder Error - Error type for GetOptionSummaryParamsBuilder
- GetOrder
Book Params Builder Error - Error type for GetOrderBookParamsBuilder
- GetOrder
History Params Builder Error - Error type for GetOrderHistoryParamsBuilder
- GetOrder
List Params Builder Error - Error type for GetOrderListParamsBuilder
- GetOrder
Params Builder Error - Error type for GetOrderParamsBuilder
- GetPosition
Tiers Params Builder Error - Error type for GetPositionTiersParamsBuilder
- GetPositions
History Params Builder Error - Error type for GetPositionsHistoryParamsBuilder
- GetPositions
Params Builder Error - Error type for GetPositionsParamsBuilder
- GetSpread
Order Params Builder Error - Error type for GetSpreadOrderParamsBuilder
- GetSpread
Orders Params Builder Error - Error type for GetSpreadOrdersParamsBuilder
- GetSpread
Trades Params Builder Error - Error type for GetSpreadTradesParamsBuilder
- GetSpreads
Params Builder Error - Error type for GetSpreadsParamsBuilder
- GetTrade
FeeParams Builder Error - Error type for GetTradeFeeParamsBuilder
- GetTrades
Params Builder Error - Error type for GetTradesParamsBuilder
- GetTransaction
Details Params Builder Error - Error type for GetTransactionDetailsParamsBuilder
- SetPosition
Mode Params Builder Error - Error type for SetPositionModeParamsBuilder