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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279

use serde::Serialize;

use crate::model::{
    OrderSide, RequestValidationError, ValidateRequest, non_empty, range_u64,
    validate_client_request_id, validate_side,
};

/// Convert mode used by currency-pair, quote, and trade requests.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize)]
#[non_exhaustive]
pub enum ConvertMode {
    /// Standard Convert flow.
    #[serde(rename = "0")]
    Standard,
    /// Large-order Convert flow for eligible VIP users.
    #[serde(rename = "1")]
    LargeOrderVip,
}

/// Empty query for [`Convert::get_currencies`](super::Convert::get_currencies).
#[derive(Debug, Clone, Copy, Default, Serialize)]
pub struct ConvertCurrenciesRequest {}

impl ConvertCurrenciesRequest {
    /// Create the empty currencies request.
    pub const fn new() -> Self {
        Self {}
    }
}

impl ValidateRequest for ConvertCurrenciesRequest {
    fn validate(&self) -> Result<(), RequestValidationError> {
        Ok(())
    }
}

/// Query parameters for [`Convert::get_currency_pair`](super::Convert::get_currency_pair).
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct ConvertCurrencyPairRequest {
    from_ccy: String,
    to_ccy: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    convert_mode: Option<ConvertMode>,
}

impl ConvertCurrencyPairRequest {
    /// Create a currency-pair request with the required source and destination currencies.
    pub fn new(from_ccy: impl Into<String>, to_ccy: impl Into<String>) -> Self {
        Self {
            from_ccy: from_ccy.into(),
            to_ccy: to_ccy.into(),
            convert_mode: None,
        }
    }

    /// Select the standard or VIP large-order Convert mode.
    pub fn convert_mode(mut self, convert_mode: ConvertMode) -> Self {
        self.convert_mode = Some(convert_mode);
        self
    }
}

impl ValidateRequest for ConvertCurrencyPairRequest {
    fn validate(&self) -> Result<(), RequestValidationError> {
        non_empty("fromCcy", &self.from_ccy)?;
        non_empty("toCcy", &self.to_ccy)
    }
}

/// Request body for [`Convert::estimate_quote`](super::Convert::estimate_quote).
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct ConvertQuoteRequest {
    base_ccy: String,
    quote_ccy: String,
    side: OrderSide,
    rfq_sz: String,
    rfq_sz_ccy: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    cl_q_req_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    tag: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    convert_mode: Option<ConvertMode>,
}

impl ConvertQuoteRequest {
    /// Create an estimate-quote request with all fields required by OKX.
    pub fn new(
        base_ccy: impl Into<String>,
        quote_ccy: impl Into<String>,
        side: OrderSide,
        rfq_sz: impl Into<String>,
        rfq_sz_ccy: impl Into<String>,
    ) -> Self {
        Self {
            base_ccy: base_ccy.into(),
            quote_ccy: quote_ccy.into(),
            side,
            rfq_sz: rfq_sz.into(),
            rfq_sz_ccy: rfq_sz_ccy.into(),
            cl_q_req_id: None,
            tag: None,
            convert_mode: None,
        }
    }

    /// Set the client quote request ID (`clQReqId`).
    pub fn client_quote_request_id(mut self, id: impl Into<String>) -> Self {
        self.cl_q_req_id = Some(id.into());
        self
    }

    /// Set the broker order tag.
    pub fn tag(mut self, tag: impl Into<String>) -> Self {
        self.tag = Some(tag.into());
        self
    }

    /// Select the standard or VIP large-order Convert mode.
    pub fn convert_mode(mut self, convert_mode: ConvertMode) -> Self {
        self.convert_mode = Some(convert_mode);
        self
    }
}

impl ValidateRequest for ConvertQuoteRequest {
    fn validate(&self) -> Result<(), RequestValidationError> {
        non_empty("baseCcy", &self.base_ccy)?;
        non_empty("quoteCcy", &self.quote_ccy)?;
        validate_side(&self.side)?;
        non_empty("rfqSz", &self.rfq_sz)?;
        non_empty("rfqSzCcy", &self.rfq_sz_ccy)?;
        validate_client_request_id("clQReqId", self.cl_q_req_id.as_deref())
    }
}

/// Request body for [`Convert::convert_trade`](super::Convert::convert_trade).
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct ConvertTradeRequest {
    quote_id: String,
    base_ccy: String,
    quote_ccy: String,
    side: OrderSide,
    sz: String,
    sz_ccy: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    cl_t_req_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    tag: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    convert_mode: Option<ConvertMode>,
}

impl ConvertTradeRequest {
    /// Create a Convert trade request with all fields required by OKX.
    pub fn new(
        quote_id: impl Into<String>,
        base_ccy: impl Into<String>,
        quote_ccy: impl Into<String>,
        side: OrderSide,
        sz: impl Into<String>,
        sz_ccy: impl Into<String>,
    ) -> Self {
        Self {
            quote_id: quote_id.into(),
            base_ccy: base_ccy.into(),
            quote_ccy: quote_ccy.into(),
            side,
            sz: sz.into(),
            sz_ccy: sz_ccy.into(),
            cl_t_req_id: None,
            tag: None,
            convert_mode: None,
        }
    }

    /// Set the client trade request ID (`clTReqId`).
    pub fn client_trade_request_id(mut self, id: impl Into<String>) -> Self {
        self.cl_t_req_id = Some(id.into());
        self
    }

    /// Set the broker order tag.
    pub fn tag(mut self, tag: impl Into<String>) -> Self {
        self.tag = Some(tag.into());
        self
    }

    /// Select the standard or VIP large-order Convert mode.
    pub fn convert_mode(mut self, convert_mode: ConvertMode) -> Self {
        self.convert_mode = Some(convert_mode);
        self
    }
}

impl ValidateRequest for ConvertTradeRequest {
    fn validate(&self) -> Result<(), RequestValidationError> {
        non_empty("quoteId", &self.quote_id)?;
        non_empty("baseCcy", &self.base_ccy)?;
        non_empty("quoteCcy", &self.quote_ccy)?;
        validate_side(&self.side)?;
        non_empty("sz", &self.sz)?;
        non_empty("szCcy", &self.sz_ccy)?;
        validate_client_request_id("clTReqId", self.cl_t_req_id.as_deref())
    }
}

/// Query parameters for [`Convert::get_convert_history`](super::Convert::get_convert_history).
#[derive(Debug, Clone, Default, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct ConvertHistoryRequest {
    #[serde(skip_serializing_if = "Option::is_none")]
    cl_t_req_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    after: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    before: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    limit: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    tag: Option<String>,
}

impl ConvertHistoryRequest {
    /// Create an empty history query.
    pub fn new() -> Self {
        Self::default()
    }

    /// Filter by the client trade request ID (`clTReqId`).
    pub fn client_trade_request_id(mut self, id: impl Into<String>) -> Self {
        self.cl_t_req_id = Some(id.into());
        self
    }

    /// Return records earlier than this millisecond timestamp.
    pub fn after(mut self, timestamp_ms: u64) -> Self {
        self.after = Some(timestamp_ms.to_string());
        self
    }

    /// Return records newer than this millisecond timestamp.
    pub fn before(mut self, timestamp_ms: u64) -> Self {
        self.before = Some(timestamp_ms.to_string());
        self
    }

    /// Set the maximum number of returned rows. OKX accepts values from 1 to 100.
    pub fn limit(mut self, limit: u8) -> Self {
        self.limit = Some(limit.to_string());
        self
    }

    /// Filter by the broker order tag used by the original Convert trade.
    pub fn tag(mut self, tag: impl Into<String>) -> Self {
        self.tag = Some(tag.into());
        self
    }
}

impl ValidateRequest for ConvertHistoryRequest {
    fn validate(&self) -> Result<(), RequestValidationError> {
        validate_client_request_id("clTReqId", self.cl_t_req_id.as_deref())?;

        match &self.limit {
            Some(limit) => {
                let parsed = limit
                    .parse::<u64>()
                    .expect("ConvertHistoryRequest::limit stores a u8 as decimal text");

                range_u64("limit", parsed, 1, 100)
            }
            None => Ok(()),
        }
    }
}