rust-okx 0.6.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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161

//! Funding account channel models (`deposit-info`, `withdrawal-info`).
//!
//! Private channels; login required.

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

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

/// Funding-account `deposit-info` channel row.
///
/// OKX docs: <https://www.okx.com/docs-v5/en/#funding-account-websocket-deposit-info-channel>
#[derive(Debug, Clone, Default, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct DepositInfoUpdate {
    /// User identifier of the message producer.
    #[serde(default)]
    pub uid: String,
    /// Sub-account name; empty string for the master account.
    #[serde(default)]
    pub sub_acct: String,
    /// Push time (Unix milliseconds).
    #[serde(default)]
    pub p_time: NumberString,
    /// Currency being deposited, e.g., `USDT`.
    #[serde(default)]
    pub ccy: String,
    /// Chain identifier for the deposit, e.g., `USDT-TRC20`.
    #[serde(default)]
    pub chain: String,
    /// Deposit amount.
    #[serde(default)]
    pub amt: NumberString,
    /// Sending address; may be empty for internal transfers.
    #[serde(default)]
    pub from: String,
    /// Country calling code for the sending address (phone-number deposits only).
    #[serde(default)]
    pub area_code_from: String,
    /// Receiving OKX deposit address.
    #[serde(default)]
    pub to: String,
    /// On-chain transaction hash; empty before broadcast.
    #[serde(default)]
    pub tx_id: String,
    /// Event timestamp when the deposit record was created (Unix milliseconds).
    #[serde(default)]
    pub ts: NumberString,
    /// Deposit state.
    ///
    /// Documented values: `0` waiting for confirmation, `1` deposit credited,
    /// `2` deposit successful, `8` pending review, `11` address blacklist,
    /// `12` account or deposit frozen, `13` sub-account deposit interception,
    /// `14` KYC limit.
    #[serde(default)]
    pub state: String,
    /// OKX-assigned deposit ID.
    #[serde(default)]
    pub dep_id: String,
    /// Withdrawal ID of the originating internal transfer; empty otherwise.
    #[serde(default)]
    pub from_wd_id: String,
    /// Number of on-chain confirmations received so far.
    #[serde(default)]
    pub actual_dep_blk_confirm: NumberString,
    /// Unrecognized fields retained for forward compatibility.
    #[serde(flatten, default)]
    pub extra: ExtraFields,
}

/// Funding-account `withdrawal-info` channel row.
///
/// OKX docs: <https://www.okx.com/docs-v5/en/#funding-account-websocket-withdrawal-info-channel>
#[derive(Debug, Clone, Default, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct WithdrawalInfoUpdate {
    /// User identifier of the message producer.
    #[serde(default)]
    pub uid: String,
    /// Sub-account name; empty string for the master account.
    #[serde(default)]
    pub sub_acct: String,
    /// Push time (Unix milliseconds).
    #[serde(default)]
    pub p_time: NumberString,
    /// Currency being withdrawn, e.g., `USDT`.
    #[serde(default)]
    pub ccy: String,
    /// Chain identifier for the withdrawal, e.g., `USDT-TRC20`.
    #[serde(default)]
    pub chain: String,
    /// Whether this currency is non-tradable.
    #[serde(default)]
    pub non_tradable_asset: bool,
    /// Withdrawal amount.
    #[serde(default)]
    pub amt: NumberString,
    /// Event timestamp when the withdrawal request was submitted (Unix milliseconds).
    #[serde(default)]
    pub ts: NumberString,
    /// Source address or account; may be empty for internal transfers.
    #[serde(default)]
    pub from: String,
    /// Country calling code for the source address (phone-number withdrawals only).
    #[serde(default)]
    pub area_code_from: String,
    /// Destination withdrawal address.
    #[serde(default)]
    pub to: String,
    /// Country calling code for the destination address (phone-number withdrawals only).
    #[serde(default)]
    pub area_code_to: String,
    /// Address type: `1` wallet/email/phone/login, `2` UID.
    #[serde(default)]
    pub to_addr_type: String,
    /// Address tag (for currencies that require a tag, e.g., XRP).
    #[serde(default)]
    pub tag: String,
    /// Payment ID (for currencies that use a payment ID, e.g., Monero).
    #[serde(default)]
    pub pmt_id: String,
    /// Memo (for currencies that use a memo, e.g., EOS).
    #[serde(default)]
    pub memo: String,
    /// Withdrawal address attachment (structure varies by chain; `null` when absent).
    #[serde(default)]
    pub addr_ex: Value,
    /// On-chain transaction hash; empty before broadcast or for internal transfers.
    #[serde(default)]
    pub tx_id: String,
    /// Network fee charged for the withdrawal.
    #[serde(default)]
    pub fee: NumberString,
    /// Fee currency.
    #[serde(default)]
    pub fee_ccy: String,
    /// Withdrawal state.
    ///
    /// Documented values: `17` pending Travel Rule, `10` waiting transfer,
    /// `0` waiting withdrawal, `4`/`5`/`6`/`8`/`9`/`12` waiting manual review,
    /// `7` approved, `1` broadcasting to chain, `15` pending validation,
    /// `16` may take up to 24 h, `-3` canceling, `-2` canceled, `-1` failed,
    /// `2` success.
    #[serde(default)]
    pub state: String,
    /// OKX-assigned withdrawal ID.
    #[serde(default)]
    pub wd_id: String,
    /// Client-supplied withdrawal ID, if any.
    #[serde(default)]
    pub client_id: String,
    /// Withdrawal note.
    #[serde(default)]
    pub note: String,
    /// Unrecognized fields retained for forward compatibility.
    #[serde(flatten, default)]
    pub extra: ExtraFields,
}