Module query 

Strongly-typed 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.

Example – building a request for historical trades:

use nautilus_okx::http::query::{GetTradesParams, GetTradesParamsBuilder};

let params = GetTradesParamsBuilder::default()
    .inst_id("BTC-USDT")
    .limit(200)
    .build()
    .unwrap();

Once built these parameter structs are passed to OKXHttpClient::get/post where they are automatically serialized.

Structs

GetCandlesticksParams

Parameters for the GET /api/v5/market/history-candles endpoint.

GetCandlesticksParamsBuilder

Builder for GetCandlesticksParams with validation.

GetIndexTickerParams

Parameters for the GET /api/v5/market/index-tickers.

GetIndexTickerParamsBuilder

Builder for GetIndexTickerParams.

GetInstrumentsParams

Parameters for the GET /api/v5/public/instruments endpoint.

GetInstrumentsParamsBuilder

Builder for GetInstrumentsParams.

GetMarkPriceParams

Parameters for the GET /api/v5/public/mark-price.

GetMarkPriceParamsBuilder

Builder for GetMarkPriceParams.

GetOrderHistoryParams

Parameters for the GET /api/v5/trade/order-history endpoint.

GetOrderHistoryParamsBuilder

Builder for GetOrderHistoryParams.

GetOrderListParams

Parameters for the GET /api/v5/trade/orders-pending endpoint.

GetOrderListParamsBuilder

Builder for GetOrderListParams.

GetOrderParams

Parameters for the GET /api/v5/trade/order endpoint (fetch order details).

GetOrderParamsBuilder

Builder for GetOrderParams.

GetPendingOrdersParams

Parameters for the GET /api/v5/trade/orders-pending endpoint.

GetPendingOrdersParamsBuilder

Builder for GetPendingOrdersParams.

GetPositionTiersParams

Parameters for the GET /api/v5/public/position-tiers endpoint.

GetPositionTiersParamsBuilder

Builder for GetPositionTiersParams.

GetPositionsHistoryParams

Parameters for the GET /api/v5/account/positions-history endpoint.

GetPositionsHistoryParamsBuilder

Builder for GetPositionsHistoryParams.

GetPositionsParams

Parameters for the GET /api/v5/public/positions endpoint.

GetPositionsParamsBuilder

Builder for GetPositionsParams.

GetTradesParams

Parameters for the GET /api/v5/market/history-trades endpoint.

GetTradesParamsBuilder

Builder for GetTradesParams.

GetTransactionDetailsParams

Parameters for the GET /api/v5/trade/fills endpoint (transaction details).

GetTransactionDetailsParamsBuilder

Builder for GetTransactionDetailsParams.

SetPositionModeParams

Parameters for the POST /api/v5/account/set-position-mode endpoint.

SetPositionModeParamsBuilder

Builder for SetPositionModeParams.

Enums

GetIndexTickerParamsBuilderError

Error type for GetIndexTickerParamsBuilder

GetInstrumentsParamsBuilderError

Error type for GetInstrumentsParamsBuilder

GetMarkPriceParamsBuilderError

Error type for GetMarkPriceParamsBuilder

GetOrderHistoryParamsBuilderError

Error type for GetOrderHistoryParamsBuilder

GetOrderListParamsBuilderError

Error type for GetOrderListParamsBuilder

GetOrderParamsBuilderError

Error type for GetOrderParamsBuilder

GetPendingOrdersParamsBuilderError

Error type for GetPendingOrdersParamsBuilder

GetPositionTiersParamsBuilderError

Error type for GetPositionTiersParamsBuilder

GetPositionsHistoryParamsBuilderError

Error type for GetPositionsHistoryParamsBuilder

GetPositionsParamsBuilderError

Error type for GetPositionsParamsBuilder

GetTradesParamsBuilderError

Error type for GetTradesParamsBuilder

GetTransactionDetailsParamsBuilderError

Error type for GetTransactionDetailsParamsBuilder

SetPositionModeParamsBuilderError

Error type for SetPositionModeParamsBuilder