pub struct Convert<'a, T> { /* private fields */ }Expand description
Accessor for OKX Convert endpoints.
Obtain one via OkxClient::convert. All
methods require credentials.
Implementations§
Source§impl<'a, T: Transport> Convert<'a, T>
impl<'a, T: Transport> Convert<'a, T>
Sourcepub async fn get_currencies(&self) -> Result<Vec<ConvertCurrency>, Error>
pub async fn get_currencies(&self) -> Result<Vec<ConvertCurrency>, Error>
Retrieve currencies supported by Convert.
GET /api/v5/asset/convert/currencies. Authenticated.
§Errors
Returns [Error::Configuration] without credentials, [Error::Api] on a
non-zero OKX code, or transport/decode errors.
Sourcepub async fn get_currency_pair(
&self,
request: &ConvertCurrencyPairRequest,
) -> Result<Vec<ConvertCurrencyPair>, Error>
pub async fn get_currency_pair( &self, request: &ConvertCurrencyPairRequest, ) -> Result<Vec<ConvertCurrencyPair>, Error>
Retrieve limits and metadata for a Convert currency pair.
GET /api/v5/asset/convert/currency-pair. Authenticated.
§Errors
Returns [Error::InvalidRequest] when a required request field is empty.
See get_currencies for transport and API errors.
Sourcepub async fn estimate_quote(
&self,
request: &ConvertQuoteRequest,
) -> Result<Vec<ConvertQuote>, Error>
pub async fn estimate_quote( &self, request: &ConvertQuoteRequest, ) -> Result<Vec<ConvertQuote>, Error>
Estimate a Convert quote.
POST /api/v5/asset/convert/estimate-quote. Authenticated.
§Errors
Returns [Error::InvalidRequest] when required fields are empty or a
client request ID is invalid. See get_currencies
for transport and API errors.
Sourcepub async fn convert_trade(
&self,
request: &ConvertTradeRequest,
) -> Result<Vec<ConvertTradeResult>, Error>
pub async fn convert_trade( &self, request: &ConvertTradeRequest, ) -> Result<Vec<ConvertTradeResult>, Error>
Execute a Convert trade.
POST /api/v5/asset/convert/trade. Authenticated.
§Errors
Returns [Error::InvalidRequest] when required fields are empty or a
client request ID is invalid. See get_currencies
for transport and API errors.
Sourcepub async fn get_convert_history(
&self,
request: &ConvertHistoryRequest,
) -> Result<Vec<ConvertHistory>, Error>
pub async fn get_convert_history( &self, request: &ConvertHistoryRequest, ) -> Result<Vec<ConvertHistory>, Error>
Retrieve Convert trade history.
GET /api/v5/asset/convert/history. Authenticated.
§Errors
Returns [Error::InvalidRequest] when the limit or client request ID is
invalid. See get_currencies for transport and
API errors.