rust-okx 0.4.1

Async Rust client for the OKX v5 REST API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

use crate::client::OkxClient;
use crate::error::Error;
use crate::model::ValidateRequest;
use crate::transport::Transport;

use super::requests::{
    ConvertCurrenciesRequest, ConvertCurrencyPairRequest, ConvertHistoryRequest,
    ConvertQuoteRequest, ConvertTradeRequest,
};
use super::responses::{
    ConvertCurrency, ConvertCurrencyPair, ConvertHistory, ConvertQuote, ConvertTradeResult,
};

const CURRENCIES: &str = "/api/v5/asset/convert/currencies";
const CURRENCY_PAIR: &str = "/api/v5/asset/convert/currency-pair";
const ESTIMATE_QUOTE: &str = "/api/v5/asset/convert/estimate-quote";
const TRADE: &str = "/api/v5/asset/convert/trade";
const HISTORY: &str = "/api/v5/asset/convert/history";

/// Accessor for OKX Convert endpoints.
///
/// Obtain one via [`OkxClient::convert`](crate::OkxClient::convert). All
/// methods require credentials.
pub struct Convert<'a, T> {
    client: &'a OkxClient<T>,
}

impl<'a, T: Transport> Convert<'a, T> {
    pub(crate) fn new(client: &'a OkxClient<T>) -> Self {
        Self { client }
    }

    /// 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.
    pub async fn get_currencies(&self) -> Result<Vec<ConvertCurrency>, Error> {
        let request = ConvertCurrenciesRequest::new();
        request.validate()?;
        self.client.get(CURRENCIES, &request, true).await
    }

    /// 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`](Self::get_currencies) for transport and API errors.
    pub async fn get_currency_pair(
        &self,
        request: &ConvertCurrencyPairRequest,
    ) -> Result<Vec<ConvertCurrencyPair>, Error> {
        request.validate()?;
        self.client.get(CURRENCY_PAIR, request, true).await
    }

    /// 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`](Self::get_currencies)
    /// for transport and API errors.
    pub async fn estimate_quote(
        &self,
        request: &ConvertQuoteRequest,
    ) -> Result<Vec<ConvertQuote>, Error> {
        request.validate()?;
        self.client.post(ESTIMATE_QUOTE, request, true).await
    }

    /// 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`](Self::get_currencies)
    /// for transport and API errors.
    pub async fn convert_trade(
        &self,
        request: &ConvertTradeRequest,
    ) -> Result<Vec<ConvertTradeResult>, Error> {
        request.validate()?;
        self.client.post(TRADE, request, true).await
    }

    /// 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`](Self::get_currencies) for transport and
    /// API errors.
    pub async fn get_convert_history(
        &self,
        request: &ConvertHistoryRequest,
    ) -> Result<Vec<ConvertHistory>, Error> {
        request.validate()?;
        self.client.get(HISTORY, request, true).await
    }
}