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
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

use serde::Deserialize;

use crate::NumberString;

/// A sub-account entry (list, create, entrust-list, set-transfer-out).
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct SubAccountEntry {
    /// Sub-account name.
    #[serde(default)]
    pub sub_acct: String,
    /// Sub-account label.
    #[serde(default)]
    pub label: String,
    /// UID of the sub-account.
    #[serde(default)]
    pub uid: String,
    /// Creation timestamp (Unix milliseconds).
    #[serde(default)]
    pub ts: NumberString,
    /// Whether the sub-account is enabled.
    #[serde(default)]
    pub enable: bool,
    /// Whether transfers out are permitted.
    #[serde(default)]
    pub can_trans_out: bool,
    /// Whether Google Authenticator is enabled.
    #[serde(default)]
    pub g_auth: bool,
    /// Mobile number bound to the sub-account.
    #[serde(default)]
    pub mobile: String,
    /// Sub-account type (`"1"` = standard).
    #[serde(default, rename = "type")]
    pub sub_type: String,
    /// Sub-account level.
    #[serde(default)]
    pub sub_acct_lv: String,
    /// First-level sub-account name.
    #[serde(default)]
    pub first_lv_sub_acct: String,
    /// Whether DMA is enabled.
    #[serde(default)]
    pub if_dma: bool,
    /// List of frozen functions.
    #[serde(default)]
    pub frozen_func: Vec<String>,
}

/// An API key for a sub-account (create, list, modify, delete responses).
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct SubAccountApiKey {
    /// Sub-account name.
    #[serde(default)]
    pub sub_acct: String,
    /// API key label.
    #[serde(default)]
    pub label: String,
    /// API key value.
    #[serde(default)]
    pub api_key: String,
    /// Secret key (only returned on creation).
    #[serde(default)]
    pub secret_key: String,
    /// Passphrase (only returned on creation).
    #[serde(default)]
    pub passphrase: String,
    /// Permissions (comma-separated, e.g. `"read_only,trade"`).
    #[serde(default)]
    pub perm: String,
    /// Allowed IP addresses (comma-separated).
    #[serde(default)]
    pub ip: String,
    /// Creation timestamp (Unix milliseconds).
    #[serde(default)]
    pub ts: NumberString,
}

/// Per-currency balance detail within a sub-account trading balance.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct SubAccountTradingBalanceDetail {
    /// Currency.
    #[serde(default)]
    pub ccy: String,
    /// Available balance.
    #[serde(default)]
    pub avail_bal: NumberString,
    /// Available equity.
    #[serde(default)]
    pub avail_eq: NumberString,
    /// Cash balance.
    #[serde(default)]
    pub cash_bal: NumberString,
    /// Equity of the currency.
    #[serde(default)]
    pub eq: NumberString,
    /// Equity in USD.
    #[serde(default)]
    pub eq_usd: NumberString,
    /// Discount equity in USD.
    #[serde(default)]
    pub dis_eq: NumberString,
    /// Frozen balance.
    #[serde(default)]
    pub frozen_bal: NumberString,
    /// Quantity of pending orders frozen.
    #[serde(default)]
    pub ord_frozen: NumberString,
    /// Unrealized profit and loss.
    #[serde(default)]
    pub upl: NumberString,
    /// Interest.
    #[serde(default)]
    pub interest: NumberString,
    /// Liabilities.
    #[serde(default)]
    pub liab: NumberString,
    /// Cross-mode liabilities.
    #[serde(default)]
    pub cross_liab: NumberString,
    /// Isolated equity.
    #[serde(default)]
    pub iso_eq: NumberString,
    /// Isolated liabilities.
    #[serde(default)]
    pub iso_liab: NumberString,
    /// Update time (Unix milliseconds).
    #[serde(default)]
    pub u_time: NumberString,
}

/// Full trading-account balance for a sub-account.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct SubAccountTradingBalance {
    /// Per-currency details.
    #[serde(default)]
    pub details: Vec<SubAccountTradingBalanceDetail>,
    /// Adjusted equity in USD.
    #[serde(default)]
    pub adj_eq: NumberString,
    /// Total equity in USD.
    #[serde(default)]
    pub total_eq: NumberString,
    /// Initial margin requirement in USD.
    #[serde(default)]
    pub imr: NumberString,
    /// Maintenance margin requirement in USD.
    #[serde(default)]
    pub mmr: NumberString,
    /// Margin ratio.
    #[serde(default)]
    pub mgn_ratio: NumberString,
    /// Isolated equity in USD.
    #[serde(default)]
    pub iso_eq: NumberString,
    /// Quantity of pending orders frozen (USD).
    #[serde(default)]
    pub ord_froz: NumberString,
    /// Notional value in USD.
    #[serde(default)]
    pub notional_usd: NumberString,
    /// Unrealized profit and loss in USD.
    #[serde(default)]
    pub upl: NumberString,
    /// Update time (Unix milliseconds).
    #[serde(default)]
    pub u_time: NumberString,
}

/// Funding-account balance for a sub-account.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct SubAccountFundingBalance {
    /// Currency.
    #[serde(default)]
    pub ccy: String,
    /// Available balance.
    #[serde(default)]
    pub avail_bal: NumberString,
    /// Total balance.
    #[serde(default)]
    pub bal: NumberString,
    /// Frozen balance.
    #[serde(default)]
    pub frozen_bal: NumberString,
}

/// Maximum withdrawal amount for a sub-account.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct SubAccountMaxWithdrawal {
    /// Currency.
    #[serde(default)]
    pub ccy: String,
    /// Maximum withdrawal amount.
    #[serde(default)]
    pub max_wd: NumberString,
    /// Maximum withdrawal amount (cross margin with borrowing).
    #[serde(default)]
    pub max_wd_ex: NumberString,
    /// Maximum spot-offset withdrawal amount.
    #[serde(default)]
    pub spot_offset_max_wd: NumberString,
    /// Maximum spot-offset withdrawal (cross margin with borrowing).
    #[serde(default)]
    pub spot_offset_max_wd_ex: NumberString,
}

/// An asset bill for a sub-account.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct SubAccountBill {
    /// Bill ID.
    #[serde(default)]
    pub bill_id: String,
    /// Bill type.
    #[serde(default, rename = "type")]
    pub bill_type: String,
    /// Currency.
    #[serde(default)]
    pub ccy: String,
    /// Transfer amount.
    #[serde(default)]
    pub amt: NumberString,
    /// Sub-account name.
    #[serde(default)]
    pub sub_acct: String,
    /// Timestamp (Unix milliseconds).
    #[serde(default)]
    pub ts: NumberString,
}

/// An asset bill for a managed sub-account.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct ManagedSubAccountBill {
    /// Bill ID.
    #[serde(default)]
    pub bill_id: String,
    /// Bill type.
    #[serde(default, rename = "type")]
    pub bill_type: String,
    /// Currency.
    #[serde(default)]
    pub ccy: String,
    /// Transfer amount.
    #[serde(default)]
    pub amt: NumberString,
    /// Sub-account name.
    #[serde(default)]
    pub sub_acct: String,
    /// Sub-account UID.
    #[serde(default)]
    pub sub_uid: String,
    /// Timestamp (Unix milliseconds).
    #[serde(default)]
    pub ts: NumberString,
}

/// Result of an asset transfer between sub-accounts.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct SubAccountTransferResult {
    /// Transfer ID.
    #[serde(default)]
    pub trans_id: String,
}

/// Result of setting transfer-out permission for a sub-account.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct SetTransferOutResult {
    /// Sub-account name.
    #[serde(default)]
    pub sub_acct: String,
    /// Whether transfers out are now permitted.
    #[serde(default)]
    pub can_trans_out: bool,
}

/// An entrusted sub-account entry.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct EntrustSubAccount {
    /// Sub-account name.
    #[serde(default)]
    pub sub_acct: String,
}