okx-client 0.1.2

Async Rust client for the OKX exchange API v5
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
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
use serde::Deserialize;

#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct Instrument {
    #[serde(default)]
    pub inst_type: String,
    #[serde(default)]
    pub series_id: Option<String>,
    #[serde(default)]
    pub inst_id: String,
    #[serde(default)]
    pub uly: String,
    #[serde(default)]
    pub inst_family: String,
    #[serde(default)]
    pub category: String,
    #[serde(default)]
    pub base_ccy: String,
    #[serde(default)]
    pub quote_ccy: String,
    #[serde(default)]
    pub settle_ccy: String,
    #[serde(default)]
    pub ct_val: String,
    #[serde(default)]
    pub ct_mult: String,
    #[serde(default)]
    pub ct_val_ccy: String,
    #[serde(default)]
    pub opt_type: String,
    #[serde(default)]
    pub stk: String,
    #[serde(default)]
    pub list_time: String,
    #[serde(default)]
    pub exp_time: String,
    #[serde(default)]
    pub lever: String,
    #[serde(default)]
    pub tick_sz: String,
    #[serde(default)]
    pub lot_sz: String,
    #[serde(default)]
    pub min_sz: String,
    #[serde(default)]
    pub ct_type: String,
    #[serde(default)]
    pub alias: String,
    #[serde(default)]
    pub state: String,
    #[serde(default)]
    pub max_lmt_sz: String,
    #[serde(default)]
    pub max_mkt_sz: String,
    #[serde(default)]
    pub max_twap_sz: String,
    #[serde(default)]
    pub max_iceberg_sz: String,
    #[serde(default)]
    pub max_trigger_sz: String,
    #[serde(default)]
    pub max_stop_sz: String,
    #[serde(default)]
    pub inst_id_code: Option<u64>,
    #[serde(default)]
    pub rpi_min_level: Option<String>,
    #[serde(default)]
    pub rpi_min_px_band: Option<String>,
}

#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct EventContractSettlement {
    pub method: String,
    pub close_early: bool,
    pub src_name: String,
    pub underlying: String,
}

#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct EventContractSeries {
    pub series_id: String,
    pub freq: String,
    pub title: String,
    pub category: String,
    pub settlement: EventContractSettlement,
}

#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct EventContractEvent {
    pub series_id: String,
    pub event_id: String,
    pub exp_time: String,
    pub state: String,
    #[serde(default)]
    pub fix_time: Option<String>,
}

#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct EventContractMarket {
    pub series_id: String,
    pub event_id: String,
    pub inst_id: String,
    pub list_time: String,
    pub exp_time: String,
    pub state: String,
    pub fix_time: String,
    pub outcome: String,
    pub floor_strike: String,
    #[serde(default)]
    pub cap_strike: Option<String>,
    #[serde(default)]
    pub hit_dir: Option<String>,
    pub settle_value: String,
    pub disputed: bool,
}

#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct FundingRate {
    #[serde(default)]
    pub inst_type: String,
    #[serde(default)]
    pub inst_id: String,
    #[serde(default)]
    pub funding_rate: String,
    #[serde(default)]
    pub realized_rate: String,
    #[serde(default)]
    pub funding_time: String,
    #[serde(default)]
    pub next_funding_rate: String,
    #[serde(default)]
    pub next_funding_time: String,
    #[serde(default)]
    pub min_funding_rate: String,
    #[serde(default)]
    pub max_funding_rate: String,
    #[serde(default)]
    pub method: String,
    #[serde(default)]
    pub premium: String,
    #[serde(default)]
    pub settle_state: String,
}

#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct MarkPrice {
    #[serde(default)]
    pub inst_type: String,
    #[serde(default)]
    pub inst_id: String,
    #[serde(default)]
    pub mark_px: String,
    #[serde(default)]
    pub ts: String,
}

#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct OpenInterest {
    #[serde(default)]
    pub inst_type: String,
    #[serde(default)]
    pub inst_id: String,
    #[serde(default)]
    pub oi: String,
    #[serde(default)]
    pub oi_ccy: String,
    #[serde(default)]
    pub ts: String,
}

#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct ServerTime {
    #[serde(default)]
    pub ts: String,
}

#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct PositionTier {
    #[serde(default)]
    pub uly: String,
    #[serde(default)]
    pub inst_id: String,
    #[serde(default)]
    pub tier: String,
    #[serde(default)]
    pub min_sz: String,
    #[serde(default)]
    pub max_sz: String,
    #[serde(default)]
    pub mmr: String,
    #[serde(default)]
    pub imr: String,
    #[serde(default)]
    pub max_lever: String,
    #[serde(default)]
    pub opt_mrgn_factor: String,
    #[serde(default)]
    pub quote_max_loan: String,
    #[serde(default)]
    pub base_max_loan: String,
}

#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct InsuranceFund {
    #[serde(default)]
    pub total: String,
    #[serde(default)]
    pub details: Vec<InsuranceFundDetail>,
}

#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct InsuranceFundDetail {
    #[serde(default)]
    pub amt: String,
    #[serde(default)]
    pub ccy: String,
    #[serde(default, rename = "type")]
    pub type_: String,
    #[serde(default)]
    pub ts: String,
}

#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct UnitConvertResult {
    #[serde(default, rename = "type")]
    pub type_: String,
    #[serde(default)]
    pub inst_id: String,
    #[serde(default)]
    pub px: String,
    #[serde(default)]
    pub sz: String,
    #[serde(default)]
    pub unit: String,
}

#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct DeliveryExerciseHistory {
    #[serde(default)]
    pub ts: String,
    #[serde(default)]
    pub details: Vec<DeliveryDetail>,
}

#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct DeliveryDetail {
    #[serde(default, rename = "type")]
    pub type_: String,
    #[serde(default)]
    pub inst_id: String,
    #[serde(default)]
    pub px: String,
}

#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct DiscountRate {
    #[serde(default)]
    pub ccy: String,
    #[serde(default)]
    pub amt: String,
    #[serde(default)]
    pub discount_lv: String,
    #[serde(default)]
    pub discount_info: Vec<DiscountInfo>,
}

#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct DiscountInfo {
    #[serde(default)]
    pub discount_rate: String,
    #[serde(default)]
    pub max_amt: String,
    #[serde(default)]
    pub min_amt: String,
}

#[derive(Debug, Clone, Deserialize, Default)]
#[serde(default, rename_all = "camelCase")]
#[non_exhaustive]
pub struct MarketDataHistoryFile {
    pub date_ts: String,
    pub filename: String,
    #[serde(rename = "sizeMB")]
    pub size_mb: String,
    pub url: String,
}

#[derive(Debug, Clone, Deserialize, Default)]
#[serde(default, rename_all = "camelCase")]
#[non_exhaustive]
pub struct MarketDataHistoryGroup {
    pub inst_id: String,
    pub inst_family: String,
    pub inst_type: String,
    pub date_range_start: String,
    pub date_range_end: String,
    #[serde(rename = "groupSizeMB")]
    pub group_size_mb: String,
    pub group_details: Vec<MarketDataHistoryFile>,
}

#[derive(Debug, Clone, Deserialize, Default)]
#[serde(default, rename_all = "camelCase")]
#[non_exhaustive]
pub struct MarketDataHistoryResult {
    pub date_aggr_type: String,
    pub details: Vec<MarketDataHistoryGroup>,
    #[serde(rename = "totalSizeMB")]
    pub total_size_mb: String,
    pub ts: String,
}

#[derive(Debug, Clone, Deserialize, Default)]
#[serde(default, rename_all = "camelCase")]
#[non_exhaustive]
pub struct MmInstrumentType {
    pub inst_id: String,
    pub inst_type: String,
    pub pair_type: String,
}

#[derive(Debug, Clone, Deserialize, Default)]
#[serde(default, rename_all = "camelCase")]
#[non_exhaustive]
pub struct Announcement {
    pub ann_type: String,
    pub ann_title: String,
    pub ann_url: String,
    pub p_time: String,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn event_contract_fields_deserialize() {
        let instrument: Instrument = serde_json::from_value(serde_json::json!({
            "instType": "EVENTS",
            "instId": "BTC-ABOVE-DAILY-1",
            "seriesId": "BTC-ABOVE-DAILY",
            "instIdCode": 42,
            "rpiMinLevel": "4",
            "rpiMinPxBand": "10"
        }))
        .unwrap();
        let series: EventContractSeries = serde_json::from_value(serde_json::json!({
            "seriesId": "BTC-ABOVE-DAILY",
            "freq": "daily",
            "title": "Bitcoin above",
            "category": "crypto",
            "settlement": {
                "method": "above",
                "closeEarly": false,
                "srcName": "OKX",
                "underlying": "BTC-USDT"
            }
        }))
        .unwrap();
        let market: EventContractMarket = serde_json::from_value(serde_json::json!({
            "seriesId": "BTC-ABOVE-DAILY",
            "eventId": "event-1",
            "instId": "BTC-ABOVE-DAILY-1",
            "listTime": "1",
            "expTime": "2",
            "state": "live",
            "fixTime": "",
            "outcome": "yes",
            "floorStrike": "100000",
            "capStrike": "INF",
            "hitDir": "up",
            "settleValue": "",
            "disputed": false
        }))
        .unwrap();

        assert_eq!(instrument.series_id.as_deref(), Some("BTC-ABOVE-DAILY"));
        assert_eq!(instrument.inst_id_code, Some(42));
        assert_eq!(instrument.rpi_min_level.as_deref(), Some("4"));
        assert_eq!(instrument.rpi_min_px_band.as_deref(), Some("10"));
        assert_eq!(series.settlement.method, "above");
        assert_eq!(market.outcome, "yes");
        assert_eq!(market.cap_strike.as_deref(), Some("INF"));
        assert_eq!(market.hit_dir.as_deref(), Some("up"));
    }
}