bybit-api 0.1.2

A Rust SDK for the Bybit V5 API - async, type-safe, zero-panic
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
use serde::{Deserialize, Serialize};

use crate::models::common::RedactedString;

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AffiliateSubItem {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sub_aff_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub user_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub email: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub commissions_vol: Option<std::collections::HashMap<String, String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub commissions_for_usdt: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub became_aff_time: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub start_date: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub end_date: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AffiliateSubListResult {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub list: Option<Vec<AffiliateSubItem>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub next_page_cursor: Option<String>,
}

pub type GetAffiliateSubListResponse = AffiliateSubListResult;

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct GatewayError {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ret_code: Option<i32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ret_msg: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AffiliateUserItem {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub user_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub register_time: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub source: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub remarks: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub is_kyc: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub taker_vol_30_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub maker_vol_30_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub trade_vol_30_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tradfi_trade_vol_30_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub commissions_30_day: Option<std::collections::HashMap<String, String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub deposit_amount_30_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub deposit_amount_365_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub taker_vol_365_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub maker_vol_365_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub trade_vol_365_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tradfi_trade_vol_365_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub commissions_365_day: Option<std::collections::HashMap<String, String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub taker_vol: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub maker_vol: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub trade_vol: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tradfi_trade_vol: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub commissions_vol: Option<std::collections::HashMap<String, String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub start_date: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub end_date: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AffiliateUserListResult {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub list: Option<Vec<AffiliateUserItem>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub next_page_cursor: Option<String>,
}

pub type GetAffiliateUserListResponse = AffiliateUserListResult;

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AffiliateUserInfoResult {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub uid: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub vip_level: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub taker_vol_30_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub maker_vol_30_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub trade_vol_30_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub deposit_amount_30_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub taker_vol_365_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub maker_vol_365_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub trade_vol_365_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub deposit_amount_365_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub total_wallet_balance: Option<String>,
    #[serde(rename = "KycLevel", skip_serializing_if = "Option::is_none")]
    pub kyc_level: Option<i32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub commissions_30_day: Option<std::collections::HashMap<String, String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub commissions_365_day: Option<std::collections::HashMap<String, String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub deposit_update_time: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub vol_update_time: Option<String>,
}

pub type GetAffiliateUserInfoResponse = AffiliateUserInfoResult;

pub type GetAffiliateCustomOpenInfoV5Response = AffiliateCustomOpenInfoResult;

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AffiliateCustomOpenInfoResult {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub uid: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub vip_level: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub taker_vol_30_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub maker_vol_30_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub trade_vol_30_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub deposit_amount_30_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub taker_vol_365_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub maker_vol_365_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub trade_vol_365_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub deposit_amount_365_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub total_wallet_balance: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub deposit_update_time: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub vol_update_time: Option<String>,
    #[serde(rename = "KycLevel", skip_serializing_if = "Option::is_none")]
    pub kyc_level: Option<i32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tradfi_trade_vol_30_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tradfi_trade_vol_365_day: Option<String>,
    // FIXME(typed-field): falls back to `serde_json::Value` because the Bybit
    // spec did not provide a matching inner type at generation time. Replace
    // with a typed struct in a follow-up PR after consulting the V5 docs.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub commissions_30_day: Option<serde_json::Value>,
    // FIXME(typed-field): falls back to `serde_json::Value` because the Bybit
    // spec did not provide a matching inner type at generation time. Replace
    // with a typed struct in a follow-up PR after consulting the V5 docs.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub commissions_365_day: Option<serde_json::Value>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub pay_send_amount_30_day: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub pay_ftt: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub card_ftt: Option<String>,
}

pub type ErrorResponse = serde_json::Value;

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CreateSubApiKeyParams {
    pub subuid: i64,
    pub read_only: i32,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ips: Option<String>,
    pub permissions: serde_json::Value,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub note: Option<String>,
}

pub type CreateSubApiKeyResponse = serde_json::Value;

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CreateSubMemberParams {
    pub username: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub password: Option<RedactedString>,
    pub member_type: i32,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub switch: Option<i32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub is_uta: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub note: Option<String>,
}

pub type CreateSubMemberResponse = serde_json::Value;

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct DeleteApiKeyParams {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub apikey: Option<String>,
}

pub type DeleteApiKeyResponse = serde_json::Value;

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct DeleteSubApiKeyParams {
    pub subuid: i64,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub apikey: Option<String>,
}

pub type DeleteSubApiKeyResponse = serde_json::Value;

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct DeleteSubMemberV5Params {
    pub subuid: i64,
}

pub type DeleteSubMemberV5Response = serde_json::Value;

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct FrozenSubMemberParams {
    pub subuid: i64,
    pub frozen: i32,
}

pub type FrozenSubMemberResponse = serde_json::Value;

pub type ListSubApiKeysV5Response = serde_json::Value;

pub type QueryApiKeyResponse = serde_json::Value;

pub type QueryEscrowSubMembersV5Response = serde_json::Value;

pub type QueryReferralsResponse = serde_json::Value;

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ReferralRecord {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<i64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub invitee_uid: Option<i64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub status: Option<i32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub created_at: Option<i64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub updated_at: Option<i64>,
}

pub type QuerySubMembersV5Response = serde_json::Value;

pub type QuerySubMembersResponse = serde_json::Value;

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct SignAgreementParams {
    pub category: i32,
    pub agree: bool,
}

pub type SignAgreementResponse = serde_json::Value;

pub type UpdateAPIKeyResponse = serde_json::Value;

pub type UpdateSubAPIKeyResponse = serde_json::Value;

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct UpdateApiKeyParams {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub read_only: Option<i32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ips: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub permissions: Option<ApiKeyPermissions>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct UpdateApiKeyResponse {
    #[serde(default)]
    pub id: String,
    #[serde(default)]
    pub note: String,
    #[serde(default)]
    pub api_key: String,
    #[serde(default)]
    pub read_only: i32,
    /// API secret. Wrapped in [`RedactedString`] so it never appears in
    /// `Debug` / log output.
    #[serde(default)]
    pub secret: RedactedString,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub permissions: Option<ApiKeyPermissions>,
    #[serde(default)]
    pub ips: Vec<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct UpdateSubApiKeyParams {
    pub subuid: i64,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub apikey: Option<String>,
    pub read_only: i32,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ips: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub permissions: Option<ApiKeyPermissions>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub note: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct UpdateSubApiKeyResponse {
    #[serde(default)]
    pub id: String,
    #[serde(default)]
    pub note: String,
    #[serde(default)]
    pub api_key: String,
    #[serde(default)]
    pub read_only: i32,
    /// API secret. Wrapped in [`RedactedString`] so it never appears in
    /// `Debug` / log output.
    #[serde(default)]
    pub secret: RedactedString,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub permissions: Option<ApiKeyPermissions>,
    #[serde(default)]
    pub ips: Vec<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ApiKeyPermissions {
    #[serde(rename = "ContractTrade", skip_serializing_if = "Option::is_none")]
    pub contract_trade: Option<Vec<String>>,
    #[serde(rename = "Spot", skip_serializing_if = "Option::is_none")]
    pub spot: Option<Vec<String>>,
    #[serde(rename = "Wallet", skip_serializing_if = "Option::is_none")]
    pub wallet: Option<Vec<String>>,
    #[serde(rename = "Options", skip_serializing_if = "Option::is_none")]
    pub options: Option<Vec<String>>,
    #[serde(rename = "Derivatives", skip_serializing_if = "Option::is_none")]
    pub derivatives: Option<Vec<String>>,
    #[serde(rename = "CopyTrading", skip_serializing_if = "Option::is_none")]
    pub copy_trading: Option<Vec<String>>,
    #[serde(rename = "BlockTrade", skip_serializing_if = "Option::is_none")]
    pub block_trade: Option<Vec<String>>,
    #[serde(rename = "Exchange", skip_serializing_if = "Option::is_none")]
    pub exchange: Option<Vec<String>>,
    #[serde(rename = "NFT", skip_serializing_if = "Option::is_none")]
    pub nft: Option<Vec<String>>,
    #[serde(rename = "Affiliate", skip_serializing_if = "Option::is_none")]
    pub affiliate: Option<Vec<String>>,
}