rust-okx 0.4.0

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

//! Trade channel models (`orders`, `fills`) and order-operation result rows.
//!
//! Private channels; login required.

use serde::Deserialize;
use serde_json::Value;

use crate::model::NumberString;
use super::ExtraFields;

ws_object! {
    /// Private `orders` channel row.
    ///
    /// OKX docs: <https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-order-channel>
    OrderUpdate {
        inst_type: String,
        inst_id: String,
        tgt_ccy: String,
        ccy: String,
        ord_id: String,
        cl_ord_id: String,
        tag: String,
        px: NumberString,
        sz: NumberString,
        ord_type: String,
        side: String,
        pos_side: String,
        td_mode: String,
        acc_fill_sz: NumberString,
        fill_px: NumberString,
        trade_id: String,
        fill_sz: NumberString,
        fill_time: NumberString,
        fill_pnl: NumberString,
        fill_fee: NumberString,
        fill_fee_ccy: String,
        exec_type: String,
        avg_px: NumberString,
        state: String,
        lever: NumberString,
        attach_algo_cl_ord_id: String,
        tp_trigger_px: NumberString,
        tp_trigger_px_type: String,
        tp_ord_px: NumberString,
        sl_trigger_px: NumberString,
        sl_trigger_px_type: String,
        sl_ord_px: NumberString,
        fee_ccy: String,
        fee: NumberString,
        rebate_ccy: String,
        rebate: NumberString,
        pnl: NumberString,
        source: String,
        category: String,
        reduce_only: String,
        cancel_source: String,
        cancel_source_reason: String,
        quick_mgn_type: String,
        algo_cl_ord_id: String,
        algo_id: String,
        amend_source: String,
        req_id: String,
        code: String,
        msg: String,
        px_type: String,
        px_usd: NumberString,
        px_vol: NumberString,
        linked_algo_ord: Value,
        attach_algo_ords: Vec<Value>,
        stp_id: String,
        stp_mode: String,
        trade_quote_ccy: String,
        outcome: String,
        is_elp_taker_access: bool,
        c_time: NumberString,
        u_time: NumberString,
        p_time: NumberString
    }
}

ws_object! {
    /// Private `fills` channel row.
    ///
    /// OKX docs: <https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-fills-channel>
    FillUpdate {
        inst_id: String,
        inst_type: String,
        trade_id: String,
        ord_id: String,
        cl_ord_id: String,
        bill_id: String,
        tag: String,
        fill_px: NumberString,
        fill_sz: NumberString,
        side: String,
        pos_side: String,
        exec_type: String,
        fee: NumberString,
        fee_ccy: String,
        fee_rate: NumberString,
        fill_pnl: NumberString,
        fill_px_vol: NumberString,
        fill_px_usd: NumberString,
        fill_mark_vol: NumberString,
        fill_fwd_px: NumberString,
        fill_mark_px: NumberString,
        fill_idx_px: NumberString,
        trade_quote_ccy: String,
        fill_time: NumberString,
        ts: NumberString
    }
}

ws_object! {
    /// Result row returned by regular order/place/cancel/amend operations.
    ///
    /// OKX docs: <https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-order>
    OrderOperationResult {
        ord_id: String,
        cl_ord_id: String,
        tag: String,
        ts: NumberString,
        req_id: String,
        s_code: String,
        s_msg: String,
        sub_code: String
    }
}

ws_object! {
    /// Result row returned by `mass-cancel` and `sprd-mass-cancel`.
    ///
    /// OKX docs: <https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-mass-cancel-order>
    MassCancelOperationResult {
        result: bool
    }
}