rust-okx 0.6.4

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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334

use crate::model::NumberString;
use serde::Deserialize;

/// Currency-level investment data returned by the Staking/DeFi offers endpoint.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct StakingDefiInvestData {
    /// Investment currency, e.g. `BTC`.
    #[serde(default)]
    pub ccy: String,
    /// Available balance to invest.
    #[serde(default)]
    pub bal: NumberString,
    /// Minimum subscription amount.
    #[serde(default)]
    pub min_amt: NumberString,
    /// Maximum available subscription amount.
    #[serde(default)]
    pub max_amt: NumberString,
}

/// Earning data returned by the Staking/DeFi offers endpoint.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct StakingDefiEarningData {
    /// Earning currency, e.g. `BTC`.
    #[serde(default)]
    pub ccy: String,
    /// Earning type.
    ///
    /// `0`: Estimated earning, `1`: Cumulative earning.
    #[serde(default)]
    pub earning_type: String,
}

/// Staking/DeFi offer row.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct StakingDefiOffer {
    /// Currency type, e.g. `BTC`.
    #[serde(default)]
    pub ccy: String,
    /// Value returned by OKX in the `productId` field.
    #[serde(default)]
    pub product_id: String,
    /// Protocol name.
    #[serde(default)]
    pub protocol: String,
    /// Protocol type.
    ///
    /// `defi`: on-chain earn.
    #[serde(default)]
    pub protocol_type: String,
    /// Protocol term.
    ///
    /// Returns the days of a fixed term, or `0` for a flexible product.
    #[serde(default)]
    pub term: String,
    /// Estimated annualization. `0.07` represents 7%.
    #[serde(default)]
    pub apy: NumberString,
    /// Whether the protocol supports early redemption.
    #[serde(default)]
    pub early_redeem: bool,
    /// Current target currency information available for investment.
    #[serde(default)]
    pub invest_data: Vec<StakingDefiInvestData>,
    /// Earning data.
    #[serde(default)]
    pub earning_data: Vec<StakingDefiEarningData>,
    /// Product state.
    ///
    /// `purchasable`: Purchasable, `sold_out`: Sold out,
    /// `Stop`: Suspension of subscription.
    #[serde(default)]
    pub state: String,
    /// Redemption period, format `[min time, max time]` where `H`: Hour, `D`: Day.
    ///
    /// e.g. `["1H","24H"]` or `["14D","14D"]`.
    #[serde(default)]
    pub redeem_period: Vec<String>,
    /// Fast redemption daily limit.
    ///
    /// Returns `''` if fast redemption is not supported.
    #[serde(default)]
    pub fast_redemption_daily_limit: NumberString,
}

/// Currency-level investment data returned by the Staking/DeFi order endpoints
/// (active orders and order history).
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct StakingDefiOrderInvestData {
    /// Investment currency, e.g. `BTC`.
    #[serde(default)]
    pub ccy: String,
    /// Invested amount.
    #[serde(default)]
    pub amt: NumberString,
}

/// Earning data returned by the Staking/DeFi order endpoints.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct StakingDefiOrderEarningData {
    /// Earning currency, e.g. `BTC`.
    #[serde(default)]
    pub ccy: String,
    /// Earning type.
    ///
    /// `0`: Estimated earning, `1`: Cumulative earning.
    #[serde(default)]
    pub earning_type: String,
    /// Earning amount. Returned by the active-orders endpoint.
    #[serde(default)]
    pub earnings: NumberString,
    /// Cumulative earning of redeemed orders. Returned by the order-history
    /// endpoint; only valid when the order is in a redemption state.
    #[serde(default)]
    pub realized_earnings: NumberString,
}

/// Fast redemption data returned by the Staking/DeFi active-orders endpoint.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct StakingDefiFastRedemptionData {
    /// Currency, e.g. `BTC`.
    #[serde(default)]
    pub ccy: String,
    /// Redeeming amount.
    #[serde(default)]
    pub redeeming_amt: NumberString,
}

/// Staking/DeFi order row, returned by both the active-orders and order-history
/// endpoints.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct StakingDefiOrder {
    /// Currency, e.g. `BTC`.
    #[serde(default)]
    pub ccy: String,
    /// Order ID.
    #[serde(default)]
    pub ord_id: String,
    /// Product ID.
    #[serde(default)]
    pub product_id: String,
    /// Order state.
    ///
    /// Active orders: `8`: Pending, `13`: Cancelling, `9`: Onchain,
    /// `1`: Earning, `2`: Redeeming.
    /// Order history: `3`: Completed (including canceled and redeemed).
    #[serde(default)]
    pub state: String,
    /// Protocol.
    #[serde(default)]
    pub protocol: String,
    /// Protocol type.
    ///
    /// `defi`: on-chain earn.
    #[serde(default)]
    pub protocol_type: String,
    /// Protocol term.
    ///
    /// Returns the days of a fixed term, or `0` for a flexible product.
    #[serde(default)]
    pub term: String,
    /// Estimated APY. `0.07` represents 7%. Retained to 4 decimal places
    /// (truncated).
    #[serde(default)]
    pub apy: NumberString,
    /// Investment data.
    #[serde(default)]
    pub invest_data: Vec<StakingDefiOrderInvestData>,
    /// Earning data.
    #[serde(default)]
    pub earning_data: Vec<StakingDefiOrderEarningData>,
    /// Fast redemption data. Only returned by the active-orders endpoint.
    #[serde(default)]
    pub fast_redemption_data: Vec<StakingDefiFastRedemptionData>,
    /// Order purchased time, Unix timestamp in milliseconds, e.g.
    /// `1597026383085`.
    #[serde(default)]
    pub purchased_time: NumberString,
    /// Estimated redemption settlement time. Only returned by the active-orders
    /// endpoint.
    #[serde(default)]
    pub est_settlement_time: NumberString,
    /// Deadline for cancellation of a redemption application. Only returned by
    /// the active-orders endpoint.
    #[serde(default)]
    pub cancel_redemption_deadline: NumberString,
    /// Order redeemed time. Only returned by the order-history endpoint.
    #[serde(default)]
    pub redeemed_time: NumberString,
    /// Order tag.
    #[serde(default)]
    pub tag: String,
}

/// Staking product-info row.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct StakingProductInfo {
    /// Fast redemption daily limit.
    /// The master account and sub-accounts share the same limit.
    #[serde(default)]
    pub fast_redemption_daily_limit: NumberString,
    /// The latest rate for checking crypto.
    #[serde(default)]
    pub rate: NumberString,
    /// Redemption days of crypto.
    #[serde(default)]
    pub redempt_days: NumberString,
    /// Minimum subscription amount of crypto.
    #[serde(default)]
    pub min_amt: NumberString,
    /// urrently fast redemption max available amount
    /// Only for `SOL_PRODUCT_INFO`
    #[serde(default)]
    pub fast_redemption_avail: Option<NumberString>,
}

/// Staking order row.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct StakingOrder {
    /// Value returned by OKX in the `ordId` field.
    #[serde(default)]
    pub ord_id: String,
    /// Value returned by OKX in the `ccy` field.
    #[serde(default)]
    pub ccy: String,
    /// Value returned by OKX in the `amt` field.
    #[serde(default)]
    pub amt: NumberString,
    /// Value returned by OKX in the `state` field.
    #[serde(default)]
    pub state: String,
    /// Value returned by OKX in the `type` field.
    #[serde(default, rename = "type")]
    pub order_type: String,
    /// Value returned by OKX in the `cTime` field.
    #[serde(default)]
    pub c_time: NumberString,
}

/// Cancel redeem ETH
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct CancelRedeem {
    /// Value returned by OKX in the `ordId` field
    #[serde(default)]
    pub ord_id: String,
}

/// Staking balance row.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct StakingBalance {
    /// Value returned by OKX in the `ccy` field.
    #[serde(default)]
    pub ccy: String,
    /// Value returned by OKX in the `amt` field.
    #[serde(default)]
    pub amt: NumberString,
    /// Value returned by OKX in the `latestInterestAccrual` field.
    #[serde(default)]
    pub latest_interest_accrual: NumberString,
    /// Value returned by OKX in the `totalInterestAccrual` field.
    #[serde(default)]
    pub total_interest_accrual: NumberString,
    /// Value returned by OKX in the `ts` field. Present for ETH balance;
    /// absent for SOL balance.
    #[serde(default)]
    pub ts: NumberString,
}

/// Staking purchase/redeem history row.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct StakingHistory {
    /// Value returned by OKX in the `type` field.
    #[serde(default, rename = "type")]
    pub event_type: String,
    /// Value returned by OKX in the `amt` field.
    #[serde(default)]
    pub amt: NumberString,
    /// Value returned by OKX in the `redeemingAmt` field.
    #[serde(default)]
    pub redeeming_amt: NumberString,
    /// Value returned by OKX in the `status` field.
    #[serde(default)]
    pub status: String,
    /// Value returned by OKX in the `ordId` field. Present for ETH history;
    /// absent for SOL history.
    #[serde(default)]
    pub ord_id: String,
    /// Value returned by OKX in the `requestTime` field.
    #[serde(default)]
    pub request_time: NumberString,
    /// Value returned by OKX in the `completedTime` field.
    #[serde(default)]
    pub completed_time: NumberString,
    /// Value returned by OKX in the `estCompletedTime` field.
    #[serde(default)]
    pub est_completed_time: NumberString,
}

/// Staking APY-history row.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct StakingApyHistory {
    /// Value returned by OKX in the `rate` field.
    #[serde(default)]
    pub rate: NumberString,
    /// Value returned by OKX in the `ts` field.
    #[serde(default)]
    pub ts: NumberString,
}