pub struct Trade<'a, T> { /* private fields */ }Expand description
Accessor for the authenticated trading endpoints.
Obtain one via OkxClient::trade. All methods
require credentials.
Implementations§
Source§impl<'a, T: Transport> Trade<'a, T>
impl<'a, T: Transport> Trade<'a, T>
Sourcepub async fn place_order(
&self,
request: &PlaceOrderRequest<'_>,
) -> Result<Vec<PlaceOrderResult>, Error>
pub async fn place_order( &self, request: &PlaceOrderRequest<'_>, ) -> Result<Vec<PlaceOrderResult>, Error>
Place an order.
POST /api/v5/trade/order. Authenticated. Build the request with
PlaceOrderRequest::new plus optional setters. The returned vector
contains one PlaceOrderResult; inspect its
s_code to confirm acceptance ("0").
§Errors
Returns RestError::Configuration without credentials, RestError::Okx on a
non-zero top-level OKX code, or transport/decode errors.
Sourcepub async fn place_multiple_orders(
&self,
requests: &[PlaceOrderRequest<'_>],
) -> Result<Vec<PlaceOrderResult>, Error>
pub async fn place_multiple_orders( &self, requests: &[PlaceOrderRequest<'_>], ) -> Result<Vec<PlaceOrderResult>, Error>
Sourcepub async fn cancel_order(
&self,
request: &CancelOrderRequest<'_>,
) -> Result<Vec<CancelOrderResult>, Error>
pub async fn cancel_order( &self, request: &CancelOrderRequest<'_>, ) -> Result<Vec<CancelOrderResult>, Error>
Cancel an order by its OKX order ID.
POST /api/v5/trade/cancel-order. Authenticated.
§Errors
See place_order.
Sourcepub async fn cancel_multiple_orders(
&self,
requests: &[CancelOrderRequest<'_>],
) -> Result<Vec<CancelOrderResult>, Error>
pub async fn cancel_multiple_orders( &self, requests: &[CancelOrderRequest<'_>], ) -> Result<Vec<CancelOrderResult>, Error>
Cancel multiple orders.
POST /api/v5/trade/cancel-batch-orders. Authenticated.
§Errors
See place_order.
Sourcepub async fn amend_order(
&self,
request: &AmendOrderRequest<'_>,
) -> Result<Vec<AmendOrderResult>, Error>
pub async fn amend_order( &self, request: &AmendOrderRequest<'_>, ) -> Result<Vec<AmendOrderResult>, Error>
Sourcepub async fn amend_multiple_orders(
&self,
requests: &[AmendOrderRequest<'_>],
) -> Result<Vec<AmendOrderResult>, Error>
pub async fn amend_multiple_orders( &self, requests: &[AmendOrderRequest<'_>], ) -> Result<Vec<AmendOrderResult>, Error>
Amend multiple existing orders.
POST /api/v5/trade/amend-batch-orders. Authenticated.
§Errors
See place_order.
Sourcepub async fn close_positions(
&self,
request: &ClosePositionRequest<'_>,
) -> Result<Vec<ClosePositionResult>, Error>
pub async fn close_positions( &self, request: &ClosePositionRequest<'_>, ) -> Result<Vec<ClosePositionResult>, Error>
Close positions for an instrument.
POST /api/v5/trade/close-position. Authenticated.
§Errors
See place_order.
Sourcepub async fn get_order(
&self,
request: &GetOrderRequest<'_>,
) -> Result<Vec<Order>, Error>
pub async fn get_order( &self, request: &GetOrderRequest<'_>, ) -> Result<Vec<Order>, Error>
Retrieve the details of a single order by its OKX order ID.
GET /api/v5/trade/order. Authenticated.
§Errors
See place_order.
Sourcepub async fn get_order_list(
&self,
request: &OrderListRequest<'_>,
) -> Result<Vec<Order>, Error>
pub async fn get_order_list( &self, request: &OrderListRequest<'_>, ) -> Result<Vec<Order>, Error>
Sourcepub async fn get_orders_history(
&self,
request: &OrderHistoryRequest<'_>,
) -> Result<Vec<Order>, Error>
pub async fn get_orders_history( &self, request: &OrderHistoryRequest<'_>, ) -> Result<Vec<Order>, Error>
Retrieve order history for the recent window.
GET /api/v5/trade/orders-history. Authenticated.
§Errors
See place_order.
Sourcepub async fn get_orders_history_archive(
&self,
request: &OrderHistoryRequest<'_>,
) -> Result<Vec<Order>, Error>
pub async fn get_orders_history_archive( &self, request: &OrderHistoryRequest<'_>, ) -> Result<Vec<Order>, Error>
Retrieve archived order history.
GET /api/v5/trade/orders-history-archive. Authenticated.
§Errors
See place_order.
Sourcepub async fn get_fills_history(
&self,
request: &FillHistoryRequest<'_>,
) -> Result<Vec<FillHistory>, Error>
pub async fn get_fills_history( &self, request: &FillHistoryRequest<'_>, ) -> Result<Vec<FillHistory>, Error>
Sourcepub async fn place_algo_order(
&self,
request: &AlgoOrderRequest,
) -> Result<Vec<AlgoOrderResult>, Error>
pub async fn place_algo_order( &self, request: &AlgoOrderRequest, ) -> Result<Vec<AlgoOrderResult>, Error>
Sourcepub async fn cancel_algo_orders(
&self,
requests: &[CancelAlgoOrderRequest<'_>],
) -> Result<Vec<AlgoOrderResult>, Error>
pub async fn cancel_algo_orders( &self, requests: &[CancelAlgoOrderRequest<'_>], ) -> Result<Vec<AlgoOrderResult>, Error>
Sourcepub async fn amend_algo_order(
&self,
request: &AmendAlgoOrderRequest<'_>,
) -> Result<Vec<AlgoOrderResult>, Error>
pub async fn amend_algo_order( &self, request: &AmendAlgoOrderRequest<'_>, ) -> Result<Vec<AlgoOrderResult>, Error>
Sourcepub async fn get_algo_order_list(
&self,
request: &AlgoOrderListRequest<'_>,
) -> Result<Vec<AlgoOrder>, Error>
pub async fn get_algo_order_list( &self, request: &AlgoOrderListRequest<'_>, ) -> Result<Vec<AlgoOrder>, Error>
Retrieve pending algo orders.
GET /api/v5/trade/orders-algo-pending. Authenticated.
§Errors
See place_order.
Sourcepub async fn get_algo_orders_history(
&self,
request: &AlgoOrderHistoryRequest<'_>,
) -> Result<Vec<AlgoOrder>, Error>
pub async fn get_algo_orders_history( &self, request: &AlgoOrderHistoryRequest<'_>, ) -> Result<Vec<AlgoOrder>, Error>
Retrieve algo order history.
GET /api/v5/trade/orders-algo-history. Authenticated.
§Errors
See place_order.
Sourcepub async fn get_algo_order_details(
&self,
request: &AlgoOrderDetailsRequest<'_>,
) -> Result<Vec<AlgoOrder>, Error>
pub async fn get_algo_order_details( &self, request: &AlgoOrderDetailsRequest<'_>, ) -> Result<Vec<AlgoOrder>, Error>
Retrieve details for an algo order.
GET /api/v5/trade/order-algo. Authenticated.
§Errors
See place_order.
Sourcepub async fn get_easy_convert_currency_list(
&self,
) -> Result<Vec<EasyConvertCurrency>, Error>
pub async fn get_easy_convert_currency_list( &self, ) -> Result<Vec<EasyConvertCurrency>, Error>
Retrieve the easy-convert currency list.
GET /api/v5/trade/easy-convert-currency-list. Authenticated.
§Errors
See place_order.
Sourcepub async fn easy_convert(
&self,
request: &EasyConvertRequest<'_>,
) -> Result<Vec<EasyConvertResult>, Error>
pub async fn easy_convert( &self, request: &EasyConvertRequest<'_>, ) -> Result<Vec<EasyConvertResult>, Error>
Execute an easy-convert request.
POST /api/v5/trade/easy-convert. Authenticated.
§Errors
See place_order.
Sourcepub async fn get_easy_convert_history(
&self,
request: &EasyConvertHistoryRequest<'_>,
) -> Result<Vec<EasyConvertHistory>, Error>
pub async fn get_easy_convert_history( &self, request: &EasyConvertHistoryRequest<'_>, ) -> Result<Vec<EasyConvertHistory>, Error>
Retrieve easy-convert history.
GET /api/v5/trade/easy-convert-history. Authenticated.
§Errors
See place_order.
Sourcepub async fn get_one_click_repay_currency_list(
&self,
request: &OneClickRepayCurrencyListRequest<'_>,
) -> Result<Vec<OneClickRepayCurrency>, Error>
pub async fn get_one_click_repay_currency_list( &self, request: &OneClickRepayCurrencyListRequest<'_>, ) -> Result<Vec<OneClickRepayCurrency>, Error>
Retrieve one-click-repay currency pairs.
GET /api/v5/trade/one-click-repay-currency-list. Authenticated.
§Errors
See place_order.
Sourcepub async fn one_click_repay(
&self,
request: &OneClickRepayRequest<'_>,
) -> Result<Vec<OneClickRepayResult>, Error>
pub async fn one_click_repay( &self, request: &OneClickRepayRequest<'_>, ) -> Result<Vec<OneClickRepayResult>, Error>
Execute one-click repay.
POST /api/v5/trade/one-click-repay. Authenticated.
§Errors
See place_order.
Sourcepub async fn get_one_click_repay_history(
&self,
request: &OneClickRepayHistoryRequest<'_>,
) -> Result<Vec<OneClickRepayHistory>, Error>
pub async fn get_one_click_repay_history( &self, request: &OneClickRepayHistoryRequest<'_>, ) -> Result<Vec<OneClickRepayHistory>, Error>
Retrieve one-click-repay history.
GET /api/v5/trade/one-click-repay-history. Authenticated.
§Errors
See place_order.
Sourcepub async fn get_one_click_repay_currency_list_v2(
&self,
request: &OneClickRepayCurrencyListRequest<'_>,
) -> Result<Vec<OneClickRepayCurrency>, Error>
pub async fn get_one_click_repay_currency_list_v2( &self, request: &OneClickRepayCurrencyListRequest<'_>, ) -> Result<Vec<OneClickRepayCurrency>, Error>
Retrieve one-click-repay v2 currency pairs.
GET /api/v5/trade/one-click-repay-currency-list-v2. Authenticated.
§Errors
See place_order.
Sourcepub async fn one_click_repay_v2(
&self,
request: &OneClickRepayRequest<'_>,
) -> Result<Vec<OneClickRepayResult>, Error>
pub async fn one_click_repay_v2( &self, request: &OneClickRepayRequest<'_>, ) -> Result<Vec<OneClickRepayResult>, Error>
Execute one-click repay v2.
POST /api/v5/trade/one-click-repay-v2. Authenticated.
§Errors
See place_order.
Sourcepub async fn get_one_click_repay_history_v2(
&self,
request: &OneClickRepayHistoryRequest<'_>,
) -> Result<Vec<OneClickRepayHistory>, Error>
pub async fn get_one_click_repay_history_v2( &self, request: &OneClickRepayHistoryRequest<'_>, ) -> Result<Vec<OneClickRepayHistory>, Error>
Retrieve one-click-repay v2 history.
GET /api/v5/trade/one-click-repay-history-v2. Authenticated.
§Errors
See place_order.