gateio-api 1.0.4 → 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/RestClient.d.ts +507 -507
- package/dist/cjs/RestClient.js +271 -271
- package/dist/cjs/RestClient.js.map +1 -1
- package/dist/mjs/RestClient.d.ts +507 -507
- package/dist/mjs/RestClient.js +271 -271
- package/dist/mjs/RestClient.js.map +1 -1
- package/package.json +1 -1
package/dist/cjs/RestClient.js
CHANGED
|
@@ -26,7 +26,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
26
26
|
* Withdrawals to Gate addresses do not incur transaction fees.
|
|
27
27
|
*
|
|
28
28
|
* @param params Withdrawal parameters
|
|
29
|
-
* @returns Promise<
|
|
29
|
+
* @returns Promise<Withdraw>
|
|
30
30
|
*/
|
|
31
31
|
submitWithdrawal(params) {
|
|
32
32
|
return this.postPrivate('/withdrawals', { query: params });
|
|
@@ -35,7 +35,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
35
35
|
* Cancel withdrawal with specified ID
|
|
36
36
|
*
|
|
37
37
|
* @param params Parameters containing the withdrawal ID
|
|
38
|
-
* @returns Promise<
|
|
38
|
+
* @returns Promise<Withdraw>
|
|
39
39
|
*/
|
|
40
40
|
cancelWithdrawal(params) {
|
|
41
41
|
return this.deletePrivate(`/withdrawals/${params.withdrawal_id}`);
|
|
@@ -48,7 +48,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
48
48
|
* List chains supported for specified currency
|
|
49
49
|
*
|
|
50
50
|
* @param params Parameters containing the currency name
|
|
51
|
-
* @returns Promise<
|
|
51
|
+
* @returns Promise< GetCurrencyChainsResp[][]>
|
|
52
52
|
*/
|
|
53
53
|
getCurrencyChains(params) {
|
|
54
54
|
return this.get('/wallet/currency_chains', params);
|
|
@@ -57,7 +57,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
57
57
|
* Generate currency deposit address
|
|
58
58
|
*
|
|
59
59
|
* @param params Parameters containing the currency name
|
|
60
|
-
* @returns Promise<
|
|
60
|
+
* @returns Promise<CreateDepositAddressResp>
|
|
61
61
|
*/
|
|
62
62
|
createDepositAddress(params) {
|
|
63
63
|
return this.getPrivate('/wallet/deposit_address', params);
|
|
@@ -68,7 +68,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
68
68
|
* Record time range cannot exceed 30 days
|
|
69
69
|
*
|
|
70
70
|
* @param params Parameters for filtering withdrawal records
|
|
71
|
-
* @returns Promise<
|
|
71
|
+
* @returns Promise<Withdraw[]>
|
|
72
72
|
*/
|
|
73
73
|
getWithdrawalRecords(params) {
|
|
74
74
|
return this.getPrivate('/wallet/withdrawals', params);
|
|
@@ -79,7 +79,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
79
79
|
* Record time range cannot exceed 30 days
|
|
80
80
|
*
|
|
81
81
|
* @param params Parameters for filtering deposit records
|
|
82
|
-
* @returns Promise<
|
|
82
|
+
* @returns Promise<Withdraw[]>
|
|
83
83
|
*/
|
|
84
84
|
getDepositRecords(params) {
|
|
85
85
|
return this.getPrivate('/wallet/deposits', params);
|
|
@@ -95,7 +95,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
95
95
|
* - spot - options
|
|
96
96
|
*
|
|
97
97
|
* @param params Transfer parameters
|
|
98
|
-
* @returns Promise<
|
|
98
|
+
* @returns Promise<TransferResponse>
|
|
99
99
|
*/
|
|
100
100
|
submitTransfer(params) {
|
|
101
101
|
return this.postPrivate('/wallet/transfers', { body: params });
|
|
@@ -106,7 +106,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
106
106
|
* Support transferring with sub user's spot or futures account. Note that only main user's spot account is used no matter which sub user's account is operated.
|
|
107
107
|
*
|
|
108
108
|
* @param params Transfer parameters
|
|
109
|
-
* @returns Promise<
|
|
109
|
+
* @returns Promise<any>
|
|
110
110
|
*/
|
|
111
111
|
submitMainSubTransfer(params) {
|
|
112
112
|
return this.postPrivate('/wallet/sub_account_transfers', { body: params });
|
|
@@ -119,7 +119,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
119
119
|
* Note: only records after 2020-04-10 can be retrieved
|
|
120
120
|
*
|
|
121
121
|
* @param params Parameters for filtering transfer records
|
|
122
|
-
* @returns Promise<
|
|
122
|
+
* @returns Promise<SubAccountTransferRecordResp[]>
|
|
123
123
|
*/
|
|
124
124
|
getMainSubTransfers(params) {
|
|
125
125
|
return this.getPrivate('/wallet/sub_account_transfers', params);
|
|
@@ -130,7 +130,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
130
130
|
* It is possible to perform balance transfers between two sub-accounts under the same main account. You can use either the API Key of the main account or the API Key of the sub-account to initiate the transfer.
|
|
131
131
|
*
|
|
132
132
|
* @param params Transfer parameters
|
|
133
|
-
* @returns Promise<
|
|
133
|
+
* @returns Promise<any>
|
|
134
134
|
*/
|
|
135
135
|
submitSubToSubTransfer(params) {
|
|
136
136
|
return this.postPrivate('/wallet/sub_account_to_sub_account', {
|
|
@@ -141,7 +141,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
141
141
|
* Retrieve withdrawal status
|
|
142
142
|
*
|
|
143
143
|
* @param params Parameters for retrieving withdrawal status
|
|
144
|
-
* @returns Promise<
|
|
144
|
+
* @returns Promise<GetWithdrawalStatusResp[]>
|
|
145
145
|
*/
|
|
146
146
|
getWithdrawalStatus(params) {
|
|
147
147
|
return this.getPrivate('/wallet/withdraw_status', params);
|
|
@@ -150,10 +150,10 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
150
150
|
* Retrieve sub account balances
|
|
151
151
|
*
|
|
152
152
|
* @param params Parameters for retrieving sub account balances
|
|
153
|
-
* @returns Promise<
|
|
153
|
+
* @returns Promise<{
|
|
154
154
|
uid: string;
|
|
155
155
|
available: { [key: string]: string };
|
|
156
|
-
}[]
|
|
156
|
+
}[]>
|
|
157
157
|
*/
|
|
158
158
|
getSubBalance(params) {
|
|
159
159
|
return this.getPrivate('/wallet/sub_account_balances', params);
|
|
@@ -162,7 +162,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
162
162
|
* Query sub accounts' margin balances
|
|
163
163
|
*
|
|
164
164
|
* @param params Parameters for querying sub accounts' margin balances
|
|
165
|
-
* @returns Promise<
|
|
165
|
+
* @returns Promise<SubAccountMarginBalancesResp[]>
|
|
166
166
|
*/
|
|
167
167
|
getSubMarginBalances(params) {
|
|
168
168
|
return this.getPrivate('/wallet/sub_account_margin_balances', params);
|
|
@@ -171,7 +171,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
171
171
|
* Query sub accounts' futures account balances
|
|
172
172
|
*
|
|
173
173
|
* @param params Parameters for querying sub accounts' futures account balances
|
|
174
|
-
* @returns Promise<
|
|
174
|
+
* @returns Promise<SubAccountFuturesBalancesResp[]>
|
|
175
175
|
*/
|
|
176
176
|
getSubFuturesBalances(params) {
|
|
177
177
|
return this.getPrivate('/wallet/sub_account_futures_balances', params);
|
|
@@ -180,7 +180,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
180
180
|
* Query subaccount's cross_margin account info
|
|
181
181
|
*
|
|
182
182
|
* @param params Parameters for querying subaccount's cross_margin account info
|
|
183
|
-
* @returns Promise<
|
|
183
|
+
* @returns Promise<SubAccountCrossMarginBalancesResp[]>
|
|
184
184
|
*/
|
|
185
185
|
getSubCrossMarginBalances(params) {
|
|
186
186
|
return this.getPrivate('/wallet/sub_account_cross_margin_balances', params);
|
|
@@ -189,7 +189,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
189
189
|
* Query saved addresses
|
|
190
190
|
*
|
|
191
191
|
* @param params Parameters for querying saved address
|
|
192
|
-
* @returns Promise<
|
|
192
|
+
* @returns Promise<GetSavedAddressResp[]>
|
|
193
193
|
*/
|
|
194
194
|
getSavedAddresses(params) {
|
|
195
195
|
return this.getPrivate('/wallet/saved_address', params);
|
|
@@ -198,7 +198,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
198
198
|
* Retrieve personal trading fee
|
|
199
199
|
*
|
|
200
200
|
* @param params Parameters for retrieving personal trading fee
|
|
201
|
-
* @returns Promise<
|
|
201
|
+
* @returns Promise<GetTradingFeesResp>
|
|
202
202
|
*/
|
|
203
203
|
getTradingFees(params) {
|
|
204
204
|
return this.getPrivate('/wallet/fee', params);
|
|
@@ -215,7 +215,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
215
215
|
* - GET /futures/{settle}/accounts to query futures account balance
|
|
216
216
|
*
|
|
217
217
|
* @param params Parameters for retrieving total balances
|
|
218
|
-
* @returns Promise<
|
|
218
|
+
* @returns Promise<GetBalancesResp>
|
|
219
219
|
*/
|
|
220
220
|
getBalances(params) {
|
|
221
221
|
return this.getPrivate('/wallet/total_balance', params);
|
|
@@ -223,7 +223,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
223
223
|
/**
|
|
224
224
|
* List small balance
|
|
225
225
|
*
|
|
226
|
-
* @returns Promise<
|
|
226
|
+
* @returns Promise<GetSmallBalancesResp>
|
|
227
227
|
*/
|
|
228
228
|
getSmallBalances() {
|
|
229
229
|
return this.getPrivate('/wallet/small_balance');
|
|
@@ -232,7 +232,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
232
232
|
* Convert small balance
|
|
233
233
|
*
|
|
234
234
|
* @param params Parameters for converting small balance
|
|
235
|
-
* @returns Promise<
|
|
235
|
+
* @returns Promise<any>
|
|
236
236
|
*/
|
|
237
237
|
convertSmallBalance(params) {
|
|
238
238
|
return this.postPrivate('/wallet/small_balance', { body: params });
|
|
@@ -241,7 +241,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
241
241
|
* List small balance history
|
|
242
242
|
*
|
|
243
243
|
* @param params Parameters for listing small balance history
|
|
244
|
-
* @returns Promise<
|
|
244
|
+
* @returns Promise<GetSmallBalanceHistoryResp[]>
|
|
245
245
|
*/
|
|
246
246
|
getSmallBalanceHistory(params) {
|
|
247
247
|
return this.getPrivate('/wallet/small_balance_history', params);
|
|
@@ -254,7 +254,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
254
254
|
* Create a new sub-account
|
|
255
255
|
*
|
|
256
256
|
* @param params Parameters for creating a new sub-account
|
|
257
|
-
* @returns Promise<
|
|
257
|
+
* @returns Promise<CreateSubAccountResp>
|
|
258
258
|
*/
|
|
259
259
|
createSubAccount(params) {
|
|
260
260
|
return this.postPrivate('/sub_accounts', { body: params });
|
|
@@ -263,7 +263,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
263
263
|
* List sub-accounts
|
|
264
264
|
*
|
|
265
265
|
* @param params Parameters for listing sub-accounts
|
|
266
|
-
* @returns Promise<
|
|
266
|
+
* @returns Promise<GetSubAccountsResp[]>
|
|
267
267
|
*/
|
|
268
268
|
getSubAccounts(params) {
|
|
269
269
|
return this.getPrivate('/sub_accounts', params);
|
|
@@ -272,7 +272,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
272
272
|
* Get the sub-account
|
|
273
273
|
*
|
|
274
274
|
* @param params Parameters containing the sub-account user ID
|
|
275
|
-
* @returns Promise<
|
|
275
|
+
* @returns Promise<SubAccountResp>
|
|
276
276
|
*/
|
|
277
277
|
getSubAccount(params) {
|
|
278
278
|
return this.getPrivate(`/sub_accounts/${params.user_id}`);
|
|
@@ -281,7 +281,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
281
281
|
* Create API Key of the sub-account
|
|
282
282
|
*
|
|
283
283
|
* @param params Parameters for creating API Key of the sub-account
|
|
284
|
-
* @returns Promise<
|
|
284
|
+
* @returns Promise<CreateSubAccountApiKeyResp>
|
|
285
285
|
*/
|
|
286
286
|
createSubAccountApiKey(params) {
|
|
287
287
|
const { user_id, ...body } = params;
|
|
@@ -291,7 +291,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
291
291
|
* List all API Key of the sub-account
|
|
292
292
|
*
|
|
293
293
|
* @param params Parameters containing the sub-account user ID
|
|
294
|
-
* @returns Promise<
|
|
294
|
+
* @returns Promise<SubAccountKey[]>
|
|
295
295
|
*/
|
|
296
296
|
getSubAccountApiKeys(params) {
|
|
297
297
|
return this.getPrivate(`/sub_accounts/${params.user_id}/keys`);
|
|
@@ -300,7 +300,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
300
300
|
* Update API key of the sub-account
|
|
301
301
|
*
|
|
302
302
|
* @param params Parameters for updating API key of the sub-account
|
|
303
|
-
* @returns Promise<
|
|
303
|
+
* @returns Promise<any>
|
|
304
304
|
*/
|
|
305
305
|
updateSubAccountApiKey(params) {
|
|
306
306
|
const { user_id, key, ...body } = params;
|
|
@@ -310,7 +310,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
310
310
|
* Delete API key of the sub-account
|
|
311
311
|
*
|
|
312
312
|
* @param params Parameters for deleting API key of the sub-account
|
|
313
|
-
* @returns Promise<
|
|
313
|
+
* @returns Promise<any>
|
|
314
314
|
*/
|
|
315
315
|
deleteSubAccountApiKey(params) {
|
|
316
316
|
return this.deletePrivate(`/sub_accounts/${params.user_id}/keys/${params.key}`);
|
|
@@ -319,7 +319,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
319
319
|
* Get the API Key of the sub-account
|
|
320
320
|
*
|
|
321
321
|
* @param params Parameters containing the sub-account user ID and API key
|
|
322
|
-
* @returns Promise<
|
|
322
|
+
* @returns Promise<SubAccountKey>
|
|
323
323
|
*/
|
|
324
324
|
getSubAccountApiKey(params) {
|
|
325
325
|
return this.getPrivate(`/sub_accounts/${params.user_id}/keys/${params.key}`);
|
|
@@ -328,7 +328,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
328
328
|
* Lock the sub-account
|
|
329
329
|
*
|
|
330
330
|
* @param params Parameters containing the sub-account user ID
|
|
331
|
-
* @returns Promise<
|
|
331
|
+
* @returns Promise<any>
|
|
332
332
|
*/
|
|
333
333
|
lockSubAccount(params) {
|
|
334
334
|
return this.postPrivate(`/sub_accounts/${params.user_id}/lock`);
|
|
@@ -337,7 +337,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
337
337
|
* Unlock the sub-account
|
|
338
338
|
*
|
|
339
339
|
* @param params Parameters containing the sub-account user ID
|
|
340
|
-
* @returns Promise<
|
|
340
|
+
* @returns Promise<any>
|
|
341
341
|
*/
|
|
342
342
|
unlockSubAccount(params) {
|
|
343
343
|
return this.postPrivate(`/sub_accounts/${params.user_id}/unlock`);
|
|
@@ -352,7 +352,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
352
352
|
* The assets of each currency in the account will be adjusted according to their liquidity, defined by corresponding adjustment coefficients, and then uniformly converted to USD to calculate the total asset value and position value of the account.
|
|
353
353
|
*
|
|
354
354
|
* @param params Parameters for retrieving unified account information
|
|
355
|
-
* @returns Promise<
|
|
355
|
+
* @returns Promise<GetUnifiedAccountInfoResp>
|
|
356
356
|
*/
|
|
357
357
|
getUnifiedAccountInfo(params) {
|
|
358
358
|
return this.getPrivate('/unified/accounts', params);
|
|
@@ -361,10 +361,10 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
361
361
|
* Query about the maximum borrowing for the unified account
|
|
362
362
|
*
|
|
363
363
|
* @param params Parameters for querying the maximum borrowing for the unified account
|
|
364
|
-
* @returns Promise<
|
|
364
|
+
* @returns Promise<{
|
|
365
365
|
* currency: string;
|
|
366
366
|
* amount: string;
|
|
367
|
-
* }
|
|
367
|
+
* }>
|
|
368
368
|
*/
|
|
369
369
|
getUnifiedMaxBorrow(params) {
|
|
370
370
|
return this.getPrivate('/unified/borrowable', params);
|
|
@@ -373,10 +373,10 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
373
373
|
* Query about the maximum transferable for the unified account
|
|
374
374
|
*
|
|
375
375
|
* @param params Parameters for querying the maximum transferable for the unified account
|
|
376
|
-
* @returns Promise<
|
|
376
|
+
* @returns Promise<{
|
|
377
377
|
* currency: string;
|
|
378
378
|
* amount: string;
|
|
379
|
-
* }
|
|
379
|
+
* }>
|
|
380
380
|
*/
|
|
381
381
|
getUnifiedMaxTransferable(params) {
|
|
382
382
|
return this.getPrivate('/unified/transferable', params);
|
|
@@ -391,7 +391,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
391
391
|
* For repayment, the option to repay the entire borrowed amount is available by setting the parameter repaid_all=true
|
|
392
392
|
*
|
|
393
393
|
* @param params Parameters for borrowing or repaying
|
|
394
|
-
* @returns Promise<
|
|
394
|
+
* @returns Promise<any>
|
|
395
395
|
*/
|
|
396
396
|
submitUnifiedBorrowOrRepay(params) {
|
|
397
397
|
return this.postPrivate('/unified/loans', { body: params });
|
|
@@ -400,7 +400,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
400
400
|
* List loans
|
|
401
401
|
*
|
|
402
402
|
* @param params Parameters for listing loans
|
|
403
|
-
* @returns Promise<
|
|
403
|
+
* @returns Promise<GetUnifiedLoansResp[]>
|
|
404
404
|
*/
|
|
405
405
|
getUnifiedLoans(params) {
|
|
406
406
|
return this.getPrivate('/unified/loans', params);
|
|
@@ -409,7 +409,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
409
409
|
* Get loan records
|
|
410
410
|
*
|
|
411
411
|
* @param params Parameters for getting loan records
|
|
412
|
-
* @returns Promise<
|
|
412
|
+
* @returns Promise<GetUnifiedLoanRecordsResp[]>
|
|
413
413
|
*/
|
|
414
414
|
getUnifiedLoanRecords(params) {
|
|
415
415
|
return this.getPrivate('/unified/loan_records', params);
|
|
@@ -418,7 +418,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
418
418
|
* List interest records
|
|
419
419
|
*
|
|
420
420
|
* @param params Parameters for listing interest records
|
|
421
|
-
* @returns Promise<
|
|
421
|
+
* @returns Promise<GetUnifiedInterestRecordsResp[]>
|
|
422
422
|
*/
|
|
423
423
|
getUnifiedInterestRecords(params) {
|
|
424
424
|
return this.getPrivate('/unified/interest_records', params);
|
|
@@ -426,7 +426,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
426
426
|
/**
|
|
427
427
|
* Retrieve user risk unit details, only valid in portfolio margin mode
|
|
428
428
|
*
|
|
429
|
-
* @returns Promise<
|
|
429
|
+
* @returns Promise<GetUnifiedRiskUnitDetailsResp>
|
|
430
430
|
*/
|
|
431
431
|
getUnifiedRiskUnitDetails() {
|
|
432
432
|
return this.getPrivate('/unified/risk_units');
|
|
@@ -437,7 +437,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
437
437
|
* Switching between different account modes requires only passing the parameters corresponding to the target account mode. It also supports opening or closing configuration switches for the corresponding account mode when switching.
|
|
438
438
|
*
|
|
439
439
|
* @param params Parameters for setting the mode of the unified account
|
|
440
|
-
* @returns Promise<
|
|
440
|
+
* @returns Promise<any>
|
|
441
441
|
*/
|
|
442
442
|
setUnifiedAccountMode(params) {
|
|
443
443
|
return this.putPrivate('/unified/unified_mode', { body: params });
|
|
@@ -445,13 +445,13 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
445
445
|
/**
|
|
446
446
|
* Query mode of the unified account
|
|
447
447
|
*
|
|
448
|
-
* @returns Promise<
|
|
448
|
+
* @returns Promise<{
|
|
449
449
|
* mode: 'classic' | 'multi_currency' | 'portfolio';
|
|
450
450
|
* settings: {
|
|
451
451
|
* usdt_futures?: boolean;
|
|
452
452
|
* spot_hedge?: boolean;
|
|
453
453
|
* };
|
|
454
|
-
* }
|
|
454
|
+
* }>
|
|
455
455
|
*/
|
|
456
456
|
getUnifiedAccountMode() {
|
|
457
457
|
return this.getPrivate('/unified/unified_mode');
|
|
@@ -462,7 +462,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
462
462
|
* Due to fluctuations in lending depth, hourly interest rates may vary, and thus, I cannot provide exact rates. When a currency is not supported, the interest rate returned will be an empty string.
|
|
463
463
|
*
|
|
464
464
|
* @param params Parameters for querying estimate rates
|
|
465
|
-
* @returns Promise<
|
|
465
|
+
* @returns Promise<{ [key: string]: string }>
|
|
466
466
|
*/
|
|
467
467
|
getUnifiedEstimateRate(params) {
|
|
468
468
|
return this.getPrivate('/unified/estimate_rate', params);
|
|
@@ -470,7 +470,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
470
470
|
/**
|
|
471
471
|
* List currency discount tiers
|
|
472
472
|
*
|
|
473
|
-
* @returns Promise<
|
|
473
|
+
* @returns Promise<GetUnifiedCurrencyDiscountTiersResp[]>
|
|
474
474
|
*/
|
|
475
475
|
getUnifiedCurrencyDiscountTiers() {
|
|
476
476
|
return this.get('/unified/currency_discount_tiers');
|
|
@@ -481,7 +481,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
481
481
|
* Portfolio Margin Calculator When inputting a simulated position portfolio, each position includes the position name and quantity held, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. When inputting simulated orders, each order includes the market identifier, order price, and order quantity, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. Market orders are not included.
|
|
482
482
|
*
|
|
483
483
|
* @param params Parameters for portfolio margin calculator
|
|
484
|
-
* @returns Promise<
|
|
484
|
+
* @returns Promise<PortfolioMarginCalculatorResp>
|
|
485
485
|
*/
|
|
486
486
|
portfolioMarginCalculate(params) {
|
|
487
487
|
return this.post('/unified/portfolio_calculator', { body: params });
|
|
@@ -499,7 +499,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
499
499
|
*
|
|
500
500
|
* The latter one occurs when one currency has multiple chains. Currency detail contains a chain field whatever the form is. To retrieve all chains of one currency, you can use all the details which have the name of the currency or name starting with <currency>_.
|
|
501
501
|
*
|
|
502
|
-
* @returns Promise<
|
|
502
|
+
* @returns Promise<GetSpotCurrenciesResp[]>
|
|
503
503
|
*/
|
|
504
504
|
getSpotCurrencies() {
|
|
505
505
|
return this.get('/spot/currencies');
|
|
@@ -508,7 +508,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
508
508
|
* Get details of a specific currency
|
|
509
509
|
*
|
|
510
510
|
* @param params Parameters for retrieving details of a specific currency
|
|
511
|
-
* @returns Promise<
|
|
511
|
+
* @returns Promise<GetSpotCurrenciesResp>
|
|
512
512
|
*/
|
|
513
513
|
getSpotCurrency(params) {
|
|
514
514
|
return this.get(`/spot/currencies/${params.currency}`);
|
|
@@ -516,7 +516,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
516
516
|
/**
|
|
517
517
|
* List all currency pairs supported
|
|
518
518
|
*
|
|
519
|
-
* @returns Promise<
|
|
519
|
+
* @returns Promise<CurrencyPair[]>
|
|
520
520
|
*/
|
|
521
521
|
getSpotCurrencyPairs() {
|
|
522
522
|
return this.get('/spot/currency_pairs');
|
|
@@ -525,7 +525,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
525
525
|
* Get details of a specific currency pair
|
|
526
526
|
*
|
|
527
527
|
* @param params Parameters for retrieving details of a specific currency pair
|
|
528
|
-
* @returns Promise<
|
|
528
|
+
* @returns Promise<CurrencyPair>
|
|
529
529
|
*/
|
|
530
530
|
getSpotCurrencyPair(params) {
|
|
531
531
|
return this.get(`/spot/currency_pairs/${params.currency_pair}`);
|
|
@@ -536,7 +536,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
536
536
|
* Return only related data if currency_pair is specified; otherwise return all of them.
|
|
537
537
|
*
|
|
538
538
|
* @param params Parameters for retrieving ticker information
|
|
539
|
-
* @returns Promise<
|
|
539
|
+
* @returns Promise<GetSpotTickerResp[]>
|
|
540
540
|
*/
|
|
541
541
|
getSpotTicker(params) {
|
|
542
542
|
return this.get('/spot/tickers', params);
|
|
@@ -547,7 +547,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
547
547
|
* Order book will be sorted by price from high to low on bids; low to high on asks.
|
|
548
548
|
*
|
|
549
549
|
* @param params Parameters for retrieving order book
|
|
550
|
-
* @returns Promise<
|
|
550
|
+
* @returns Promise<GetSpotOrderBookResp>
|
|
551
551
|
*/
|
|
552
552
|
getSpotOrderBook(params) {
|
|
553
553
|
return this.get('/spot/order_book', params);
|
|
@@ -559,7 +559,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
559
559
|
* Scrolling query using last_id is not recommended any more. If last_id is specified, time range query parameters will be ignored.
|
|
560
560
|
*
|
|
561
561
|
* @param params Parameters for retrieving market trades
|
|
562
|
-
* @returns Promise<
|
|
562
|
+
* @returns Promise<GetSpotTradesResp[]>
|
|
563
563
|
*/
|
|
564
564
|
getSpotTrades(params) {
|
|
565
565
|
return this.get('/spot/trades', params);
|
|
@@ -570,7 +570,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
570
570
|
* Maximum of 1000 points can be returned in a query. Be sure not to exceed the limit when specifying from, to and interval.
|
|
571
571
|
*
|
|
572
572
|
* @param params Parameters for retrieving market Candles
|
|
573
|
-
* @returns Promise<
|
|
573
|
+
* @returns Promise<GetSpotCandlesResp>
|
|
574
574
|
*/
|
|
575
575
|
getSpotCandles(params) {
|
|
576
576
|
return this.get('/spot/Candles', params);
|
|
@@ -581,7 +581,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
581
581
|
* This API is deprecated in favour of new fee retrieving API /wallet/fee.
|
|
582
582
|
*
|
|
583
583
|
* @param params Parameters for querying user trading fee rates
|
|
584
|
-
* @returns Promise<
|
|
584
|
+
* @returns Promise<GetSpotFeeRatesResp>
|
|
585
585
|
*/
|
|
586
586
|
getSpotFeeRates(params) {
|
|
587
587
|
return this.getPrivate('/spot/fee', params);
|
|
@@ -598,7 +598,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
598
598
|
* List spot accounts
|
|
599
599
|
*
|
|
600
600
|
* @param params Parameters for listing spot accounts
|
|
601
|
-
* @returns Promise<
|
|
601
|
+
* @returns Promise<GetSpotAccountsResp[]>
|
|
602
602
|
*/
|
|
603
603
|
getSpotAccounts(params) {
|
|
604
604
|
return this.getPrivate('/spot/accounts', params);
|
|
@@ -609,7 +609,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
609
609
|
* Record time range cannot exceed 30 days.
|
|
610
610
|
*
|
|
611
611
|
* @param params Parameters for querying account book
|
|
612
|
-
* @returns Promise<
|
|
612
|
+
* @returns Promise<GetSpotAccountBookResp[]>
|
|
613
613
|
*/
|
|
614
614
|
getSpotAccountBook(params) {
|
|
615
615
|
return this.getPrivate('/spot/account_book', params);
|
|
@@ -623,7 +623,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
623
623
|
* - No mixture of spot orders and margin orders, i.e. account must be identical for all orders
|
|
624
624
|
*
|
|
625
625
|
* @param params Parameters for creating a batch of orders
|
|
626
|
-
* @returns Promise<
|
|
626
|
+
* @returns Promise<SubmitSpotBatchOrdersResp[]>
|
|
627
627
|
*/
|
|
628
628
|
submitSpotBatchOrders(params) {
|
|
629
629
|
return this.postPrivate('/spot/batch_orders', { body: params });
|
|
@@ -636,7 +636,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
636
636
|
* Spot, portfolio, and margin orders are returned by default. To list cross margin orders, account must be set to cross_margin.
|
|
637
637
|
*
|
|
638
638
|
* @param params Parameters for listing all open orders
|
|
639
|
-
* @returns Promise<
|
|
639
|
+
* @returns Promise<GetSpotOpenOrdersResp[]>
|
|
640
640
|
*/
|
|
641
641
|
getSpotOpenOrders(params) {
|
|
642
642
|
return this.getPrivate('/spot/open_orders', params);
|
|
@@ -647,7 +647,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
647
647
|
* Currently, only cross-margin accounts are supported to close position when cross currencies are disabled. Maximum buy quantity = (unpaid principal and interest - currency balance - the amount of the currency in the order book) / 0.998
|
|
648
648
|
*
|
|
649
649
|
* @param params Parameters for closing position when cross-currency is disabled
|
|
650
|
-
* @returns Promise<
|
|
650
|
+
* @returns Promise<Order>
|
|
651
651
|
*/
|
|
652
652
|
submitSpotClosePosCrossDisabled(params) {
|
|
653
653
|
return this.postPrivate('/spot/cross_liquidate_orders', { body: params });
|
|
@@ -658,7 +658,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
658
658
|
* You can place orders with spot, portfolio, margin or cross margin account through setting the account field. It defaults to spot, which means spot account is used to place orders. If the user is using unified account, it defaults to the unified account.
|
|
659
659
|
*
|
|
660
660
|
* @param params Parameters for creating an order
|
|
661
|
-
* @returns Promise<
|
|
661
|
+
* @returns Promise<Order>
|
|
662
662
|
*/
|
|
663
663
|
submitSpotOrder(params) {
|
|
664
664
|
return this.postPrivate('/spot/orders', { body: params });
|
|
@@ -669,7 +669,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
669
669
|
* Spot, portfolio and margin orders are returned by default. If cross margin orders are needed, account must be set to cross_margin.
|
|
670
670
|
*
|
|
671
671
|
* @param params Parameters for listing orders
|
|
672
|
-
* @returns Promise<
|
|
672
|
+
* @returns Promise<Order[]>
|
|
673
673
|
*/
|
|
674
674
|
getSpotOrders(params) {
|
|
675
675
|
return this.getPrivate('/spot/orders', params);
|
|
@@ -681,7 +681,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
681
681
|
* You can set account to cancel only orders within the specified account.
|
|
682
682
|
*
|
|
683
683
|
* @param params Parameters for cancelling all open orders in specified currency pair
|
|
684
|
-
* @returns Promise<
|
|
684
|
+
* @returns Promise<Order[]>
|
|
685
685
|
*/
|
|
686
686
|
cancelSpotOpenOrders(params) {
|
|
687
687
|
return this.deletePrivate('/spot/orders', { query: params });
|
|
@@ -692,7 +692,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
692
692
|
* Multiple currency pairs can be specified, but maximum 20 orders are allowed per request.
|
|
693
693
|
*
|
|
694
694
|
* @param params Parameters for cancelling a batch of orders
|
|
695
|
-
* @returns Promise<
|
|
695
|
+
* @returns Promise<DeleteSpotBatchOrdersResp[]>
|
|
696
696
|
*/
|
|
697
697
|
batchCancelSpotOrders(params) {
|
|
698
698
|
return this.postPrivate('/spot/cancel_batch_orders', { body: params });
|
|
@@ -703,7 +703,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
703
703
|
* Spot, portfolio and margin orders are queried by default. If cross margin orders are needed or portfolio margin account are used, account must be set to cross_margin.
|
|
704
704
|
*
|
|
705
705
|
* @param params Parameters for getting a single order
|
|
706
|
-
* @returns Promise<
|
|
706
|
+
* @returns Promise<Order>
|
|
707
707
|
*/
|
|
708
708
|
getSpotOrder(params) {
|
|
709
709
|
const { order_id, ...query } = params;
|
|
@@ -717,7 +717,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
717
717
|
* Currently, only supports modification of price or amount fields.
|
|
718
718
|
*
|
|
719
719
|
* @param params Parameters for amending an order
|
|
720
|
-
* @returns Promise<
|
|
720
|
+
* @returns Promise<Order>
|
|
721
721
|
*/
|
|
722
722
|
updateSpotOrder(params) {
|
|
723
723
|
const { order_id, currency_pair, account, ...body } = params;
|
|
@@ -736,7 +736,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
736
736
|
* Spot, portfolio and margin orders are cancelled by default. If trying to cancel cross margin orders or portfolio margin account are used, account must be set to cross_margin.
|
|
737
737
|
*
|
|
738
738
|
* @param params Parameters for cancelling a single order
|
|
739
|
-
* @returns Promise<
|
|
739
|
+
* @returns Promise<Order>
|
|
740
740
|
*/
|
|
741
741
|
cancelSpotOrder(params) {
|
|
742
742
|
const { order_id, ...query } = params;
|
|
@@ -752,7 +752,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
752
752
|
* You can also set from and/or to to query by time range. If you don't specify from and/or to parameters, only the last 7 days of data will be returned. The range of from and to is not allowed to exceed 30 days. Time range parameters are handled as order finish time.
|
|
753
753
|
*
|
|
754
754
|
* @param params Parameters for listing personal trading history
|
|
755
|
-
* @returns Promise<
|
|
755
|
+
* @returns Promise<GetSpotTradingHistoryResp[]>
|
|
756
756
|
*/
|
|
757
757
|
getSpotTradingHistory(params) {
|
|
758
758
|
return this.getPrivate('/spot/my_trades', params);
|
|
@@ -760,9 +760,9 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
760
760
|
/**
|
|
761
761
|
* Get server current time
|
|
762
762
|
*
|
|
763
|
-
* @returns Promise<
|
|
763
|
+
* @returns Promise<{
|
|
764
764
|
* server_time: number;
|
|
765
|
-
* }
|
|
765
|
+
* }>
|
|
766
766
|
*/
|
|
767
767
|
getServerTime() {
|
|
768
768
|
return this.get('/spot/time');
|
|
@@ -773,9 +773,9 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
773
773
|
* When the timeout set by the user is reached, if there is no cancel or set a new countdown, the related pending orders will be automatically cancelled. This endpoint can be called repeatedly to set a new countdown or cancel the countdown.
|
|
774
774
|
*
|
|
775
775
|
* @param params Parameters for setting countdown cancel orders
|
|
776
|
-
* @returns Promise<
|
|
776
|
+
* @returns Promise<{
|
|
777
777
|
* triggerTime: number;
|
|
778
|
-
* }
|
|
778
|
+
* }>
|
|
779
779
|
*/
|
|
780
780
|
submitSpotCountdownOrders(params) {
|
|
781
781
|
return this.postPrivate('/spot/countdown_cancel_all', { body: params });
|
|
@@ -786,7 +786,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
786
786
|
* Default modification of orders for spot, portfolio, and margin accounts. To modify orders for a cross margin account, the account parameter must be specified as cross_margin. For portfolio margin accounts, the account parameter can only be specified as cross_margin. Currently, only modifications to price or quantity (choose one) are supported.
|
|
787
787
|
*
|
|
788
788
|
* @param params Parameters for batch modification of orders
|
|
789
|
-
* @returns Promise<
|
|
789
|
+
* @returns Promise<Order[]>
|
|
790
790
|
*/
|
|
791
791
|
batchUpdateSpotOrders(params) {
|
|
792
792
|
return this.postPrivate('/spot/amend_batch_orders', { body: params });
|
|
@@ -795,9 +795,9 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
795
795
|
* Create a price-triggered order
|
|
796
796
|
*
|
|
797
797
|
* @param params Parameters for creating a price-triggered order
|
|
798
|
-
* @returns Promise<
|
|
798
|
+
* @returns Promise<{
|
|
799
799
|
* id: number;
|
|
800
|
-
* }
|
|
800
|
+
* }>
|
|
801
801
|
*/
|
|
802
802
|
submitSpotPriceTriggerOrder(params) {
|
|
803
803
|
return this.postPrivate('/spot/price_orders', { body: params });
|
|
@@ -806,7 +806,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
806
806
|
* Retrieve running auto order list
|
|
807
807
|
*
|
|
808
808
|
* @param params Parameters for retrieving running auto order list
|
|
809
|
-
* @returns Promise<
|
|
809
|
+
* @returns Promise<SpotPriceTriggeredOrder[]>
|
|
810
810
|
*/
|
|
811
811
|
getSpotAutoOrders(params) {
|
|
812
812
|
return this.getPrivate('/spot/price_orders', params);
|
|
@@ -815,7 +815,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
815
815
|
* Cancel all open orders
|
|
816
816
|
*
|
|
817
817
|
* @param params Parameters for cancelling all open orders
|
|
818
|
-
* @returns Promise<
|
|
818
|
+
* @returns Promise<SpotPriceTriggeredOrder[]>
|
|
819
819
|
*/
|
|
820
820
|
cancelAllOpenSpotOrders(params) {
|
|
821
821
|
return this.deletePrivate('/spot/price_orders', { query: params });
|
|
@@ -824,7 +824,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
824
824
|
* Get a price-triggered order
|
|
825
825
|
*
|
|
826
826
|
* @param params Parameters for getting a price-triggered order
|
|
827
|
-
* @returns Promise<
|
|
827
|
+
* @returns Promise<SpotPriceTriggeredOrder>
|
|
828
828
|
*/
|
|
829
829
|
getPriceTriggeredOrder(params) {
|
|
830
830
|
return this.getPrivate(`/spot/price_orders/${params.order_id}`);
|
|
@@ -833,7 +833,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
833
833
|
* Cancel a price-triggered order
|
|
834
834
|
*
|
|
835
835
|
* @param params Parameters for cancelling a price-triggered order
|
|
836
|
-
* @returns Promise<
|
|
836
|
+
* @returns Promise<SpotPriceTriggeredOrder>
|
|
837
837
|
*/
|
|
838
838
|
cancelSpotTriggeredOrder(params) {
|
|
839
839
|
return this.deletePrivate(`/spot/price_orders/${params.order_id}`);
|
|
@@ -846,7 +846,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
846
846
|
* Margin account list
|
|
847
847
|
*
|
|
848
848
|
* @param params Parameters for listing margin accounts
|
|
849
|
-
* @returns Promise<
|
|
849
|
+
* @returns Promise<GetMarginAccountsResp[]>
|
|
850
850
|
*/
|
|
851
851
|
getMarginAccounts(params) {
|
|
852
852
|
return this.getPrivate('/margin/accounts', params);
|
|
@@ -857,7 +857,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
857
857
|
* Only transferals from and to margin account are provided for now. Time range allows 30 days at most.
|
|
858
858
|
*
|
|
859
859
|
* @param params Parameters for listing margin account balance change history
|
|
860
|
-
* @returns Promise<
|
|
860
|
+
* @returns Promise<GetMarginBalanceHistoryResp[]>
|
|
861
861
|
*/
|
|
862
862
|
getMarginBalanceHistory(params) {
|
|
863
863
|
return this.getPrivate('/margin/account_book', params);
|
|
@@ -866,13 +866,13 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
866
866
|
* Funding account list
|
|
867
867
|
*
|
|
868
868
|
* @param params Parameters for listing funding accounts
|
|
869
|
-
* @returns Promise<
|
|
869
|
+
* @returns Promise<{
|
|
870
870
|
* currency: string;
|
|
871
871
|
* available: string;
|
|
872
872
|
* locked: string;
|
|
873
873
|
* lent: string;
|
|
874
874
|
* total_lent: string;
|
|
875
|
-
* }[]
|
|
875
|
+
* }[]>
|
|
876
876
|
*/
|
|
877
877
|
getFundingAccounts(params) {
|
|
878
878
|
return this.getPrivate('/margin/funding_accounts', params);
|
|
@@ -881,7 +881,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
881
881
|
* Update user's auto repayment setting
|
|
882
882
|
*
|
|
883
883
|
* @param params Parameters for updating auto repayment setting
|
|
884
|
-
* @returns Promise<
|
|
884
|
+
* @returns Promise<{ status: 'on' | 'off' }>
|
|
885
885
|
*/
|
|
886
886
|
updateAutoRepaymentSetting(params) {
|
|
887
887
|
return this.postPrivate('/margin/auto_repay', { query: params });
|
|
@@ -889,7 +889,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
889
889
|
/**
|
|
890
890
|
* Retrieve user auto repayment setting
|
|
891
891
|
*
|
|
892
|
-
* @returns Promise<
|
|
892
|
+
* @returns Promise<{ status: 'on' | 'off' }>
|
|
893
893
|
*/
|
|
894
894
|
getAutoRepaymentSetting() {
|
|
895
895
|
return this.getPrivate('/margin/auto_repay');
|
|
@@ -898,11 +898,11 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
898
898
|
* Get the max transferable amount for a specific margin currency
|
|
899
899
|
*
|
|
900
900
|
* @param params Parameters for retrieving the max transferable amount
|
|
901
|
-
* @returns Promise<
|
|
901
|
+
* @returns Promise<{
|
|
902
902
|
* currency: string;
|
|
903
903
|
* currency_pair?: string;
|
|
904
904
|
* amount: string;
|
|
905
|
-
* }
|
|
905
|
+
* }>
|
|
906
906
|
*/
|
|
907
907
|
getMarginTransferableAmount(params) {
|
|
908
908
|
return this.getPrivate('/margin/transferable', params);
|
|
@@ -910,7 +910,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
910
910
|
/**
|
|
911
911
|
* Currencies supported by cross margin
|
|
912
912
|
*
|
|
913
|
-
* @returns Promise<
|
|
913
|
+
* @returns Promise<GetCrossMarginCurrenciesResp[]>
|
|
914
914
|
*/
|
|
915
915
|
getCrossMarginCurrencies() {
|
|
916
916
|
return this.get('/margin/cross/currencies');
|
|
@@ -919,7 +919,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
919
919
|
* Retrieve detail of one single currency supported by cross margin
|
|
920
920
|
*
|
|
921
921
|
* @param params Parameters containing the currency name
|
|
922
|
-
* @returns Promise<
|
|
922
|
+
* @returns Promise<GetCrossMarginCurrenciesResp>
|
|
923
923
|
*/
|
|
924
924
|
getCrossMarginCurrency(params) {
|
|
925
925
|
return this.get(`/margin/cross/currencies/${params.currency}`);
|
|
@@ -927,7 +927,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
927
927
|
/**
|
|
928
928
|
* Retrieve cross margin account
|
|
929
929
|
*
|
|
930
|
-
* @returns Promise<
|
|
930
|
+
* @returns Promise<GetCrossMarginAccountResp>
|
|
931
931
|
*/
|
|
932
932
|
getCrossMarginAccount() {
|
|
933
933
|
return this.getPrivate('/margin/cross/accounts');
|
|
@@ -938,7 +938,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
938
938
|
* Record time range cannot exceed 30 days.
|
|
939
939
|
*
|
|
940
940
|
* @param params Parameters for retrieving cross margin account change history
|
|
941
|
-
* @returns Promise<
|
|
941
|
+
* @returns Promise<GetCrossMarginAccountHistoryResp[]>
|
|
942
942
|
*/
|
|
943
943
|
getCrossMarginAccountHistory(params) {
|
|
944
944
|
return this.getPrivate('/margin/cross/account_book', params);
|
|
@@ -949,7 +949,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
949
949
|
* Borrow amount cannot be less than currency minimum borrow amount.
|
|
950
950
|
*
|
|
951
951
|
* @param params Parameters for creating a cross margin borrow loan
|
|
952
|
-
* @returns Promise<
|
|
952
|
+
* @returns Promise<SubmitCrossMarginBorrowLoanResp>
|
|
953
953
|
*/
|
|
954
954
|
submitCrossMarginBorrowLoan(params) {
|
|
955
955
|
return this.postPrivate('/margin/cross/loans', { body: params });
|
|
@@ -960,7 +960,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
960
960
|
* Sort by creation time in descending order by default. Set reverse=false to return ascending results.
|
|
961
961
|
*
|
|
962
962
|
* @param params Parameters for listing cross margin borrow history
|
|
963
|
-
* @returns Promise<
|
|
963
|
+
* @returns Promise<SubmitCrossMarginBorrowLoanResp[]>
|
|
964
964
|
*/
|
|
965
965
|
getCrossMarginBorrowHistory(params) {
|
|
966
966
|
return this.getPrivate('/margin/cross/loans', params);
|
|
@@ -969,7 +969,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
969
969
|
* Retrieve single borrow loan detail
|
|
970
970
|
*
|
|
971
971
|
* @param params Parameters containing the borrow loan ID
|
|
972
|
-
* @returns Promise<
|
|
972
|
+
* @returns Promise<SubmitCrossMarginBorrowLoanResp>
|
|
973
973
|
*/
|
|
974
974
|
getCrossMarginBorrowLoan(params) {
|
|
975
975
|
return this.getPrivate(`/margin/cross/loans/${params.loan_id}`);
|
|
@@ -980,7 +980,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
980
980
|
* When the liquidity of the currency is insufficient and the transaction risk is high, the currency will be disabled, and funds cannot be transferred. When the available balance of cross-margin is insufficient, the balance of the spot account can be used for repayment. Please ensure that the balance of the spot account is sufficient, and system uses cross-margin account for repayment first.
|
|
981
981
|
*
|
|
982
982
|
* @param params Parameters for cross margin repayments
|
|
983
|
-
* @returns Promise<
|
|
983
|
+
* @returns Promise<SubmitCrossMarginBorrowLoanResp[]>
|
|
984
984
|
*/
|
|
985
985
|
submitCrossMarginRepayment(params) {
|
|
986
986
|
return this.postPrivate('/margin/cross/repayments', { body: params });
|
|
@@ -991,7 +991,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
991
991
|
* Sort by creation time in descending order by default. Set reverse=false to return ascending results.
|
|
992
992
|
*
|
|
993
993
|
* @param params Parameters for retrieving cross margin repayments
|
|
994
|
-
* @returns Promise<
|
|
994
|
+
* @returns Promise<GetCrossMarginRepaymentsResp[]>
|
|
995
995
|
*/
|
|
996
996
|
getCrossMarginRepayments(params) {
|
|
997
997
|
return this.getPrivate('/margin/cross/repayments', params);
|
|
@@ -1000,7 +1000,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1000
1000
|
* Interest records for the cross margin account
|
|
1001
1001
|
*
|
|
1002
1002
|
* @param params Parameters for retrieving interest records
|
|
1003
|
-
* @returns Promise<
|
|
1003
|
+
* @returns Promise<GetCrossMarginInterestRecordsResp[]>
|
|
1004
1004
|
*/
|
|
1005
1005
|
getCrossMarginInterestRecords(params) {
|
|
1006
1006
|
return this.getPrivate('/margin/cross/interest_records', params);
|
|
@@ -1009,10 +1009,10 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1009
1009
|
* Get the max transferable amount for a specific cross margin currency
|
|
1010
1010
|
*
|
|
1011
1011
|
* @param params Parameters for retrieving the max transferable amount
|
|
1012
|
-
* @returns Promise<
|
|
1012
|
+
* @returns Promise<{
|
|
1013
1013
|
* currency: string;
|
|
1014
1014
|
* amount: string;
|
|
1015
|
-
* }
|
|
1015
|
+
* }>
|
|
1016
1016
|
*/
|
|
1017
1017
|
getCrossMarginTransferableAmount(params) {
|
|
1018
1018
|
return this.getPrivate('/margin/cross/transferable', params);
|
|
@@ -1023,7 +1023,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1023
1023
|
* Please note that the interest rates are subject to change based on the borrowing and lending demand, and therefore, the provided rates may not be entirely accurate.
|
|
1024
1024
|
*
|
|
1025
1025
|
* @param params Parameters for retrieving estimated interest rates
|
|
1026
|
-
* @returns Promise<
|
|
1026
|
+
* @returns Promise<any>
|
|
1027
1027
|
*/
|
|
1028
1028
|
getEstimatedInterestRates(params) {
|
|
1029
1029
|
return this.getPrivate('/margin/cross/estimate_rate', params);
|
|
@@ -1032,10 +1032,10 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1032
1032
|
* Get the max borrowable amount for a specific cross margin currency
|
|
1033
1033
|
*
|
|
1034
1034
|
* @param params Parameters for retrieving the max borrowable amount
|
|
1035
|
-
* @returns Promise<
|
|
1035
|
+
* @returns Promise<{
|
|
1036
1036
|
* currency: string;
|
|
1037
1037
|
* amount: string;
|
|
1038
|
-
* }
|
|
1038
|
+
* }>
|
|
1039
1039
|
*/
|
|
1040
1040
|
getCrossMarginBorrowableAmount(params) {
|
|
1041
1041
|
return this.getPrivate('/margin/cross/borrowable', params);
|
|
@@ -1047,7 +1047,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1047
1047
|
/**
|
|
1048
1048
|
* List lending markets
|
|
1049
1049
|
*
|
|
1050
|
-
* @returns Promise<
|
|
1050
|
+
* @returns Promise<GetLendingMarketsResp[]>
|
|
1051
1051
|
*/
|
|
1052
1052
|
getLendingMarkets() {
|
|
1053
1053
|
return this.get('/margin/uni/currency_pairs');
|
|
@@ -1056,12 +1056,12 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1056
1056
|
* Get detail of lending market
|
|
1057
1057
|
*
|
|
1058
1058
|
* @param params Parameters containing the currency pair
|
|
1059
|
-
* @returns Promise<
|
|
1059
|
+
* @returns Promise<{
|
|
1060
1060
|
* currency_pair: string;
|
|
1061
1061
|
* base_min_borrow_amount: string;
|
|
1062
1062
|
* quote_min_borrow_amount: string;
|
|
1063
1063
|
* leverage: string;
|
|
1064
|
-
* }
|
|
1064
|
+
* }>
|
|
1065
1065
|
*/
|
|
1066
1066
|
getLendingMarket(params) {
|
|
1067
1067
|
return this.get(`/margin/uni/currency_pairs/${params.currency_pair}`);
|
|
@@ -1072,7 +1072,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1072
1072
|
* Please note that the interest rates are subject to change based on the borrowing and lending demand, and therefore, the provided rates may not be entirely accurate.
|
|
1073
1073
|
*
|
|
1074
1074
|
* @param params Parameters for retrieving estimated interest rates
|
|
1075
|
-
* @returns Promise<
|
|
1075
|
+
* @returns Promise<any>
|
|
1076
1076
|
*/
|
|
1077
1077
|
getEstimatedInterestRate(params) {
|
|
1078
1078
|
return this.getPrivate('/margin/uni/estimate_rate', params);
|
|
@@ -1090,7 +1090,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1090
1090
|
* List loans
|
|
1091
1091
|
*
|
|
1092
1092
|
* @param params Parameters for listing loans
|
|
1093
|
-
* @returns Promise<
|
|
1093
|
+
* @returns Promise<GetMarginUNILoansResp[]>
|
|
1094
1094
|
*/
|
|
1095
1095
|
getMarginUNILoans(params) {
|
|
1096
1096
|
return this.getPrivate('/margin/uni/loans', params);
|
|
@@ -1099,7 +1099,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1099
1099
|
* Get loan records
|
|
1100
1100
|
*
|
|
1101
1101
|
* @param params Parameters for retrieving loan records
|
|
1102
|
-
* @returns Promise<
|
|
1102
|
+
* @returns Promise<GetMarginUNILoanRecordsResp[]>
|
|
1103
1103
|
*/
|
|
1104
1104
|
getMarginUNILoanRecords(params) {
|
|
1105
1105
|
return this.getPrivate('/margin/uni/loan_records', params);
|
|
@@ -1108,7 +1108,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1108
1108
|
* List interest records
|
|
1109
1109
|
*
|
|
1110
1110
|
* @param params Parameters for listing interest records
|
|
1111
|
-
* @returns Promise<
|
|
1111
|
+
* @returns Promise<GetMarginUNIInterestRecordsResp[]>
|
|
1112
1112
|
*/
|
|
1113
1113
|
getMarginUNIInterestRecords(params) {
|
|
1114
1114
|
return this.getPrivate('/margin/uni/interest_records', params);
|
|
@@ -1117,7 +1117,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1117
1117
|
* Get maximum borrowable
|
|
1118
1118
|
*
|
|
1119
1119
|
* @param params Parameters for retrieving the maximum borrowable amount
|
|
1120
|
-
* @returns Promise<
|
|
1120
|
+
* @returns Promise<GetMarginUNIMaxBorrowResp>
|
|
1121
1121
|
*/
|
|
1122
1122
|
getMarginUNIMaxBorrow(params) {
|
|
1123
1123
|
return this.getPrivate('/margin/uni/borrowable', params);
|
|
@@ -1130,7 +1130,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1130
1130
|
* List All Supported Currency Pairs In Flash Swap
|
|
1131
1131
|
*
|
|
1132
1132
|
* @param params Parameters for retrieving data of the specified currency
|
|
1133
|
-
* @returns Promise<
|
|
1133
|
+
* @returns Promise<GetFlashSwapCurrencyPairsResp[]>
|
|
1134
1134
|
*/
|
|
1135
1135
|
getFlashSwapCurrencyPairs(params) {
|
|
1136
1136
|
return this.get('/flash_swap/currency_pairs', params);
|
|
@@ -1141,7 +1141,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1141
1141
|
* Initiate a flash swap preview in advance because order creation requires a preview result.
|
|
1142
1142
|
*
|
|
1143
1143
|
* @param params Parameters for creating a flash swap order
|
|
1144
|
-
* @returns Promise<
|
|
1144
|
+
* @returns Promise<SubmitFlashSwapOrderResp>
|
|
1145
1145
|
*/
|
|
1146
1146
|
submitFlashSwapOrder(params) {
|
|
1147
1147
|
return this.postPrivate('/flash_swap/orders', { body: params });
|
|
@@ -1150,7 +1150,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1150
1150
|
* List all flash swap orders
|
|
1151
1151
|
*
|
|
1152
1152
|
* @param params Parameters for listing flash swap orders
|
|
1153
|
-
* @returns Promise<
|
|
1153
|
+
* @returns Promise<GetFlashSwapOrdersResp[]>
|
|
1154
1154
|
*/
|
|
1155
1155
|
getFlashSwapOrders(params) {
|
|
1156
1156
|
return this.getPrivate('/flash_swap/orders', params);
|
|
@@ -1159,7 +1159,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1159
1159
|
* Get a single flash swap order's detail
|
|
1160
1160
|
*
|
|
1161
1161
|
* @param params Parameters containing the flash swap order ID
|
|
1162
|
-
* @returns Promise<
|
|
1162
|
+
* @returns Promise<GetFlashSwapOrderResp>
|
|
1163
1163
|
*/
|
|
1164
1164
|
getFlashSwapOrder(params) {
|
|
1165
1165
|
return this.getPrivate(`/flash_swap/orders/${params.order_id}`);
|
|
@@ -1168,7 +1168,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1168
1168
|
* Initiate a flash swap order preview
|
|
1169
1169
|
*
|
|
1170
1170
|
* @param params Parameters for initiating a flash swap order preview
|
|
1171
|
-
* @returns Promise<
|
|
1171
|
+
* @returns Promise<SubmitFlashSwapOrderPreviewResp>
|
|
1172
1172
|
*/
|
|
1173
1173
|
submitFlashSwapOrderPreview(params) {
|
|
1174
1174
|
return this.postPrivate('/flash_swap/orders/preview', { body: params });
|
|
@@ -1181,7 +1181,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1181
1181
|
* List all futures contracts
|
|
1182
1182
|
*
|
|
1183
1183
|
* @param params Parameters for listing futures contracts
|
|
1184
|
-
* @returns Promise<
|
|
1184
|
+
* @returns Promise<Contract[]>
|
|
1185
1185
|
*/
|
|
1186
1186
|
getFuturesContracts(params) {
|
|
1187
1187
|
const { settle, ...query } = params;
|
|
@@ -1191,7 +1191,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1191
1191
|
* Get a single contract
|
|
1192
1192
|
*
|
|
1193
1193
|
* @param params Parameters for retrieving a single contract
|
|
1194
|
-
* @returns Promise<
|
|
1194
|
+
* @returns Promise<Contract>
|
|
1195
1195
|
*/
|
|
1196
1196
|
getFuturesContract(params) {
|
|
1197
1197
|
return this.get(`/futures/${params.settle}/contracts/${params.contract}`);
|
|
@@ -1202,7 +1202,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1202
1202
|
* Bids will be sorted by price from high to low, while asks sorted reversely.
|
|
1203
1203
|
*
|
|
1204
1204
|
* @param params Parameters for retrieving the futures order book
|
|
1205
|
-
* @returns Promise<
|
|
1205
|
+
* @returns Promise<GetFuturesOrderBookResp>
|
|
1206
1206
|
*/
|
|
1207
1207
|
getFuturesOrderBook(params) {
|
|
1208
1208
|
const { settle, ...query } = params;
|
|
@@ -1212,7 +1212,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1212
1212
|
* Futures trading history
|
|
1213
1213
|
*
|
|
1214
1214
|
* @param params Parameters for retrieving futures trading history
|
|
1215
|
-
* @returns Promise<
|
|
1215
|
+
* @returns Promise<GetFuturesTradesResp[]>
|
|
1216
1216
|
*/
|
|
1217
1217
|
getFuturesTrades(params) {
|
|
1218
1218
|
const { settle, ...query } = params;
|
|
@@ -1226,7 +1226,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1226
1226
|
* Maximum of 2000 points are returned in one query. Be sure not to exceed the limit when specifying from, to and interval.
|
|
1227
1227
|
*
|
|
1228
1228
|
* @param params Parameters for retrieving futures Candles
|
|
1229
|
-
* @returns Promise<
|
|
1229
|
+
* @returns Promise<GetFuturesCandlesResp[]>
|
|
1230
1230
|
*/
|
|
1231
1231
|
getFuturesCandles(params) {
|
|
1232
1232
|
const { settle, ...query } = params;
|
|
@@ -1238,7 +1238,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1238
1238
|
* Maximum of 1000 points can be returned in a query. Be sure not to exceed the limit when specifying from, to and interval.
|
|
1239
1239
|
*
|
|
1240
1240
|
* @param params Parameters for retrieving premium index K-Line
|
|
1241
|
-
* @returns Promise<
|
|
1241
|
+
* @returns Promise<GetPremiumIndexKLineResp[]>
|
|
1242
1242
|
*/
|
|
1243
1243
|
getPremiumIndexKLines(params) {
|
|
1244
1244
|
const { settle, ...query } = params;
|
|
@@ -1248,7 +1248,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1248
1248
|
* List futures tickers
|
|
1249
1249
|
*
|
|
1250
1250
|
* @param params Parameters for listing futures tickers
|
|
1251
|
-
* @returns Promise<
|
|
1251
|
+
* @returns Promise<GetFuturesTickersResp[]>
|
|
1252
1252
|
*/
|
|
1253
1253
|
getFuturesTickers(params) {
|
|
1254
1254
|
const { settle, ...query } = params;
|
|
@@ -1258,10 +1258,10 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1258
1258
|
* Funding rate history
|
|
1259
1259
|
*
|
|
1260
1260
|
* @param params Parameters for retrieving funding rate history
|
|
1261
|
-
* @returns Promise<
|
|
1261
|
+
* @returns Promise<{
|
|
1262
1262
|
* t: number;
|
|
1263
1263
|
* r: string;
|
|
1264
|
-
* }[]
|
|
1264
|
+
* }[]>
|
|
1265
1265
|
*/
|
|
1266
1266
|
getFundingRates(params) {
|
|
1267
1267
|
const { settle, ...query } = params;
|
|
@@ -1271,10 +1271,10 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1271
1271
|
* Futures insurance balance history
|
|
1272
1272
|
*
|
|
1273
1273
|
* @param params Parameters for retrieving futures insurance balance history
|
|
1274
|
-
* @returns Promise<
|
|
1274
|
+
* @returns Promise<{
|
|
1275
1275
|
* t: number;
|
|
1276
1276
|
* b: string;
|
|
1277
|
-
* }[]
|
|
1277
|
+
* }[]>
|
|
1278
1278
|
*/
|
|
1279
1279
|
getFuturesInsuranceBalanceHistory(params) {
|
|
1280
1280
|
const { settle, ...query } = params;
|
|
@@ -1284,7 +1284,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1284
1284
|
* Futures stats
|
|
1285
1285
|
*
|
|
1286
1286
|
* @param params Parameters for retrieving futures stats
|
|
1287
|
-
* @returns Promise<
|
|
1287
|
+
* @returns Promise<GetFuturesStatsResp[]>
|
|
1288
1288
|
*/
|
|
1289
1289
|
getFuturesStats(params) {
|
|
1290
1290
|
const { settle, ...query } = params;
|
|
@@ -1294,7 +1294,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1294
1294
|
* Get index constituents
|
|
1295
1295
|
*
|
|
1296
1296
|
* @param params Parameters for retrieving index constituents
|
|
1297
|
-
* @returns Promise<
|
|
1297
|
+
* @returns Promise<GetIndexConstituentsResp>
|
|
1298
1298
|
*/
|
|
1299
1299
|
getIndexConstituents(params) {
|
|
1300
1300
|
return this.get(`/futures/${params.settle}/index_constituents/${params.index}`);
|
|
@@ -1305,7 +1305,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1305
1305
|
* Interval between from and to cannot exceed 3600. Some private fields will not be returned in public endpoints. Refer to field description for detail.
|
|
1306
1306
|
*
|
|
1307
1307
|
* @param params Parameters for retrieving liquidation history
|
|
1308
|
-
* @returns Promise<
|
|
1308
|
+
* @returns Promise<GetLiquidationHistoryResp[]>
|
|
1309
1309
|
*/
|
|
1310
1310
|
getLiquidationHistory(params) {
|
|
1311
1311
|
const { settle, ...query } = params;
|
|
@@ -1319,7 +1319,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1319
1319
|
* This only takes effect when the 'contract' parameter is empty.
|
|
1320
1320
|
*
|
|
1321
1321
|
* @param params Parameters for listing risk limit tiers
|
|
1322
|
-
* @returns Promise<
|
|
1322
|
+
* @returns Promise<GetRiskLimitTiersResp[]>
|
|
1323
1323
|
*/
|
|
1324
1324
|
getRiskLimitTiers(params) {
|
|
1325
1325
|
const { settle, ...query } = params;
|
|
@@ -1329,7 +1329,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1329
1329
|
* Query futures account
|
|
1330
1330
|
*
|
|
1331
1331
|
* @param params Parameters for querying futures account
|
|
1332
|
-
* @returns Promise<
|
|
1332
|
+
* @returns Promise<GetFuturesAccountResp>
|
|
1333
1333
|
*/
|
|
1334
1334
|
getFuturesAccount(params) {
|
|
1335
1335
|
return this.getPrivate(`/futures/${params.settle}/accounts`);
|
|
@@ -1340,7 +1340,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1340
1340
|
* If the contract field is provided, it can only filter records that include this field after 2023-10-30.
|
|
1341
1341
|
*
|
|
1342
1342
|
* @param params Parameters for querying account book
|
|
1343
|
-
* @returns Promise<
|
|
1343
|
+
* @returns Promise<GetFuturesAccountBookResp[]>
|
|
1344
1344
|
*/
|
|
1345
1345
|
getFuturesAccountBook(params) {
|
|
1346
1346
|
const { settle, ...query } = params;
|
|
@@ -1350,7 +1350,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1350
1350
|
* List all positions of a user
|
|
1351
1351
|
*
|
|
1352
1352
|
* @param params Parameters for listing all positions of a user
|
|
1353
|
-
* @returns Promise<
|
|
1353
|
+
* @returns Promise<Position[]>
|
|
1354
1354
|
*/
|
|
1355
1355
|
getFuturesPositions(params) {
|
|
1356
1356
|
const { settle, ...query } = params;
|
|
@@ -1360,7 +1360,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1360
1360
|
* Get single position
|
|
1361
1361
|
*
|
|
1362
1362
|
* @param params Parameters for retrieving a single position
|
|
1363
|
-
* @returns Promise<
|
|
1363
|
+
* @returns Promise<Position>
|
|
1364
1364
|
*/
|
|
1365
1365
|
getFuturesPosition(params) {
|
|
1366
1366
|
return this.getPrivate(`/futures/${params.settle}/positions/${params.contract}`);
|
|
@@ -1369,7 +1369,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1369
1369
|
* Update position margin
|
|
1370
1370
|
*
|
|
1371
1371
|
* @param params Parameters for updating position margin
|
|
1372
|
-
* @returns Promise<
|
|
1372
|
+
* @returns Promise<Position>
|
|
1373
1373
|
*/
|
|
1374
1374
|
updateFuturesMargin(params) {
|
|
1375
1375
|
const { settle, contract, ...query } = params;
|
|
@@ -1381,7 +1381,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1381
1381
|
* Update position leverage
|
|
1382
1382
|
*
|
|
1383
1383
|
* @param params Parameters for updating position leverage
|
|
1384
|
-
* @returns Promise<
|
|
1384
|
+
* @returns Promise<Position>
|
|
1385
1385
|
*/
|
|
1386
1386
|
updateFuturesLeverage(params) {
|
|
1387
1387
|
const { settle, contract, ...query } = params;
|
|
@@ -1391,7 +1391,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1391
1391
|
* Update position risk limit
|
|
1392
1392
|
*
|
|
1393
1393
|
* @param params Parameters for updating position risk limit
|
|
1394
|
-
* @returns Promise<
|
|
1394
|
+
* @returns Promise<Position>
|
|
1395
1395
|
*/
|
|
1396
1396
|
updatePositionRiskLimit(params) {
|
|
1397
1397
|
const { settle, contract, ...query } = params;
|
|
@@ -1403,7 +1403,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1403
1403
|
* Before setting dual mode, make sure all positions are closed and no orders are open.
|
|
1404
1404
|
*
|
|
1405
1405
|
* @param params Parameters for enabling or disabling dual mode
|
|
1406
|
-
* @returns Promise<
|
|
1406
|
+
* @returns Promise<ToggleFuturesDualModeResp>
|
|
1407
1407
|
*/
|
|
1408
1408
|
updateFuturesDualMode(params) {
|
|
1409
1409
|
const { settle, ...query } = params;
|
|
@@ -1415,7 +1415,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1415
1415
|
* Retrieve position detail in dual mode
|
|
1416
1416
|
*
|
|
1417
1417
|
* @param params Parameters for retrieving position detail in dual mode
|
|
1418
|
-
* @returns Promise<
|
|
1418
|
+
* @returns Promise<Position[]>
|
|
1419
1419
|
*/
|
|
1420
1420
|
getDualModePosition(params) {
|
|
1421
1421
|
return this.getPrivate(`/futures/${params.settle}/dual_comp/positions/${params.contract}`);
|
|
@@ -1424,7 +1424,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1424
1424
|
* Update position margin in dual mode
|
|
1425
1425
|
*
|
|
1426
1426
|
* @param params Parameters for updating position margin in dual mode
|
|
1427
|
-
* @returns Promise<
|
|
1427
|
+
* @returns Promise<Position[]>
|
|
1428
1428
|
*/
|
|
1429
1429
|
updateDualModePositionMargin(params) {
|
|
1430
1430
|
const { settle, contract, ...query } = params;
|
|
@@ -1434,7 +1434,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1434
1434
|
* Update position leverage in dual mode
|
|
1435
1435
|
*
|
|
1436
1436
|
* @param params Parameters for updating position leverage in dual mode
|
|
1437
|
-
* @returns Promise<
|
|
1437
|
+
* @returns Promise<Position[]>
|
|
1438
1438
|
*/
|
|
1439
1439
|
updateDualModePositionLeverage(params) {
|
|
1440
1440
|
const { settle, contract, ...query } = params;
|
|
@@ -1444,7 +1444,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1444
1444
|
* Update position risk limit in dual mode
|
|
1445
1445
|
*
|
|
1446
1446
|
* @param params Parameters for updating position risk limit in dual mode
|
|
1447
|
-
* @returns Promise<
|
|
1447
|
+
* @returns Promise<Position[]>
|
|
1448
1448
|
*/
|
|
1449
1449
|
updateDualModePositionRiskLimit(params) {
|
|
1450
1450
|
const { settle, contract, ...query } = params;
|
|
@@ -1461,7 +1461,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1461
1461
|
* Set stp_act to decide the strategy of self-trade prevention. For detailed usage, refer to the stp_act parameter in the request body.
|
|
1462
1462
|
*
|
|
1463
1463
|
* @param params Parameters for creating a futures order
|
|
1464
|
-
* @returns Promise<
|
|
1464
|
+
* @returns Promise<SubmitFuturesOrderReq>
|
|
1465
1465
|
*/
|
|
1466
1466
|
submitFuturesOrder(params) {
|
|
1467
1467
|
const { settle, ...body } = params;
|
|
@@ -1474,7 +1474,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1474
1474
|
* Historical orders, by default, only data within the past 6 months is supported. If you need to query data for a longer period, please use GET /futures/{settle}/orders_timerange.
|
|
1475
1475
|
*
|
|
1476
1476
|
* @param params Parameters for listing futures orders
|
|
1477
|
-
* @returns Promise<
|
|
1477
|
+
* @returns Promise<FuturesOrder[]>
|
|
1478
1478
|
*/
|
|
1479
1479
|
getFuturesOrders(params) {
|
|
1480
1480
|
const { settle, ...query } = params;
|
|
@@ -1486,7 +1486,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1486
1486
|
* Zero-filled order cannot be retrieved 10 minutes after order cancellation.
|
|
1487
1487
|
*
|
|
1488
1488
|
* @param params Parameters for cancelling all open orders matched
|
|
1489
|
-
* @returns Promise<
|
|
1489
|
+
* @returns Promise<FuturesOrder[]>
|
|
1490
1490
|
*/
|
|
1491
1491
|
cancelAllFuturesOrders(params) {
|
|
1492
1492
|
const { settle, ...query } = params;
|
|
@@ -1498,7 +1498,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1498
1498
|
* List Futures Orders By Time Range
|
|
1499
1499
|
*
|
|
1500
1500
|
* @param params Parameters for listing futures orders by time range
|
|
1501
|
-
* @returns Promise<
|
|
1501
|
+
* @returns Promise<FuturesOrder[]>
|
|
1502
1502
|
*/
|
|
1503
1503
|
getFuturesOrdersByTimeRange(params) {
|
|
1504
1504
|
const { settle, ...query } = params;
|
|
@@ -1516,7 +1516,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1516
1516
|
* In the rate limiting, each order is counted individually.
|
|
1517
1517
|
*
|
|
1518
1518
|
* @param params Parameters for creating a batch of futures orders
|
|
1519
|
-
* @returns Promise<
|
|
1519
|
+
* @returns Promise<FuturesOrder[]>
|
|
1520
1520
|
*/
|
|
1521
1521
|
submitFuturesBatchOrders(params) {
|
|
1522
1522
|
const { settle, orders } = params;
|
|
@@ -1531,7 +1531,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1531
1531
|
* Historical orders, by default, only data within the past 6 months is supported.
|
|
1532
1532
|
*
|
|
1533
1533
|
* @param params Parameters for retrieving a single order
|
|
1534
|
-
* @returns Promise<
|
|
1534
|
+
* @returns Promise<FuturesOrder>
|
|
1535
1535
|
*/
|
|
1536
1536
|
getFuturesOrder(params) {
|
|
1537
1537
|
return this.getPrivate(`/futures/${params.settle}/orders/${params.order_id}`);
|
|
@@ -1540,7 +1540,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1540
1540
|
* Cancel a single order
|
|
1541
1541
|
*
|
|
1542
1542
|
* @param params Parameters for cancelling a single order
|
|
1543
|
-
* @returns Promise<
|
|
1543
|
+
* @returns Promise<FuturesOrder>
|
|
1544
1544
|
*/
|
|
1545
1545
|
cancelFuturesOrder(params) {
|
|
1546
1546
|
return this.deletePrivate(`/futures/${params.settle}/orders/${params.order_id}`);
|
|
@@ -1549,7 +1549,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1549
1549
|
* Amend an order
|
|
1550
1550
|
*
|
|
1551
1551
|
* @param params Parameters for amending an order
|
|
1552
|
-
* @returns Promise<
|
|
1552
|
+
* @returns Promise<FuturesOrder>
|
|
1553
1553
|
*/
|
|
1554
1554
|
updateFuturesOrder(params) {
|
|
1555
1555
|
const { settle, order_id, ...body } = params;
|
|
@@ -1563,7 +1563,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1563
1563
|
* By default, only data within the past 6 months is supported. If you need to query data for a longer period, please use GET /futures/{settle}/my_trades_timerange.
|
|
1564
1564
|
*
|
|
1565
1565
|
* @param params Parameters for listing personal trading history
|
|
1566
|
-
* @returns Promise<
|
|
1566
|
+
* @returns Promise<GetFuturesTradingHistoryResp[]>
|
|
1567
1567
|
*/
|
|
1568
1568
|
getFuturesTradingHistory(params) {
|
|
1569
1569
|
const { settle, ...query } = params;
|
|
@@ -1573,7 +1573,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1573
1573
|
* List position close history
|
|
1574
1574
|
*
|
|
1575
1575
|
* @param params Parameters for listing position close history
|
|
1576
|
-
* @returns Promise<
|
|
1576
|
+
* @returns Promise<GetFuturesPositionHistoryResp[]>
|
|
1577
1577
|
*/
|
|
1578
1578
|
getFuturesPositionHistory(params) {
|
|
1579
1579
|
const { settle, ...query } = params;
|
|
@@ -1583,7 +1583,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1583
1583
|
* List liquidation history
|
|
1584
1584
|
*
|
|
1585
1585
|
* @param params Parameters for listing liquidation history
|
|
1586
|
-
* @returns Promise<
|
|
1586
|
+
* @returns Promise<GetFuturesLiquidationHistoryResp[]>
|
|
1587
1587
|
*/
|
|
1588
1588
|
getFuturesLiquidationHistory(params) {
|
|
1589
1589
|
const { settle, ...query } = params;
|
|
@@ -1593,7 +1593,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1593
1593
|
* List Auto-Deleveraging History
|
|
1594
1594
|
*
|
|
1595
1595
|
* @param params Parameters for listing auto-deleveraging history
|
|
1596
|
-
* @returns Promise<
|
|
1596
|
+
* @returns Promise<GetFuturesAutoDeleveragingHistoryResp[]>
|
|
1597
1597
|
*/
|
|
1598
1598
|
getFuturesAutoDeleveragingHistory(params) {
|
|
1599
1599
|
const { settle, ...query } = params;
|
|
@@ -1607,7 +1607,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1607
1607
|
* If the timeout is set to 0 within 30 seconds, the countdown timer will expire and the cancel function will be cancelled.
|
|
1608
1608
|
*
|
|
1609
1609
|
* @param params Parameters for setting countdown cancel orders
|
|
1610
|
-
* @returns Promise<
|
|
1610
|
+
* @returns Promise<{ triggerTime: number }>
|
|
1611
1611
|
*/
|
|
1612
1612
|
setFuturesOrderCancelCountdown(params) {
|
|
1613
1613
|
const { settle, ...body } = params;
|
|
@@ -1619,7 +1619,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1619
1619
|
* Query user trading fee rates
|
|
1620
1620
|
*
|
|
1621
1621
|
* @param params Parameters for querying user trading fee rates
|
|
1622
|
-
* @returns Promise<
|
|
1622
|
+
* @returns Promise<any>
|
|
1623
1623
|
*/
|
|
1624
1624
|
getFuturesUserTradingFees(params) {
|
|
1625
1625
|
const { settle, ...query } = params;
|
|
@@ -1631,7 +1631,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1631
1631
|
* Multiple distinct order ID list can be specified. Each request can cancel a maximum of 20 records.
|
|
1632
1632
|
*
|
|
1633
1633
|
* @param params Parameters for cancelling a batch of orders with an ID list
|
|
1634
|
-
* @returns Promise<
|
|
1634
|
+
* @returns Promise<DeleteFuturesBatchOrdersResp[]>
|
|
1635
1635
|
*/
|
|
1636
1636
|
batchCancelFuturesOrders(params) {
|
|
1637
1637
|
const { settle, ...orderIds } = params;
|
|
@@ -1643,7 +1643,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1643
1643
|
* Create a price-triggered order
|
|
1644
1644
|
*
|
|
1645
1645
|
* @param params Parameters for creating a price-triggered order
|
|
1646
|
-
* @returns Promise<
|
|
1646
|
+
* @returns Promise<{ id: number }>
|
|
1647
1647
|
*/
|
|
1648
1648
|
submitFuturesPriceTriggeredOrder(params) {
|
|
1649
1649
|
const { settle, ...body } = params;
|
|
@@ -1653,7 +1653,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1653
1653
|
* List all auto orders
|
|
1654
1654
|
*
|
|
1655
1655
|
* @param params Parameters for listing all auto orders
|
|
1656
|
-
* @returns Promise<
|
|
1656
|
+
* @returns Promise<FuturesPriceTriggeredOrder[]>
|
|
1657
1657
|
*/
|
|
1658
1658
|
getFuturesAutoOrders(params) {
|
|
1659
1659
|
const { settle, ...query } = params;
|
|
@@ -1663,7 +1663,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1663
1663
|
* Cancel all open orders
|
|
1664
1664
|
*
|
|
1665
1665
|
* @param params Parameters for cancelling all open orders
|
|
1666
|
-
* @returns Promise<
|
|
1666
|
+
* @returns Promise<FuturesPriceTriggeredOrder[]>
|
|
1667
1667
|
*/
|
|
1668
1668
|
cancelAllOpenFuturesOrders(params) {
|
|
1669
1669
|
const { settle, ...query } = params;
|
|
@@ -1675,7 +1675,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1675
1675
|
* Get a price-triggered order
|
|
1676
1676
|
*
|
|
1677
1677
|
* @param params Parameters for retrieving a price-triggered order
|
|
1678
|
-
* @returns Promise<
|
|
1678
|
+
* @returns Promise<FuturesPriceTriggeredOrder>
|
|
1679
1679
|
*/
|
|
1680
1680
|
getFuturesPriceTriggeredOrder(params) {
|
|
1681
1681
|
return this.getPrivate(`/futures/${params.settle}/price_orders/${params.order_id}`);
|
|
@@ -1684,7 +1684,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1684
1684
|
* Cancel a price-triggered order
|
|
1685
1685
|
*
|
|
1686
1686
|
* @param params Parameters for cancelling a price-triggered order
|
|
1687
|
-
* @returns Promise<
|
|
1687
|
+
* @returns Promise<FuturesPriceTriggeredOrder>
|
|
1688
1688
|
*/
|
|
1689
1689
|
cancelFuturesPriceTriggeredOrder(params) {
|
|
1690
1690
|
return this.deletePrivate(`/futures/${params.settle}/price_orders/${params.order_id}`);
|
|
@@ -1697,7 +1697,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1697
1697
|
* List all futures contracts
|
|
1698
1698
|
*
|
|
1699
1699
|
* @param params Parameters for listing all futures contracts
|
|
1700
|
-
* @returns Promise<
|
|
1700
|
+
* @returns Promise<DeliveryContract[]>
|
|
1701
1701
|
*/
|
|
1702
1702
|
getAllDeliveryContracts(params) {
|
|
1703
1703
|
return this.get(`/delivery/${params.settle}/contracts`);
|
|
@@ -1706,7 +1706,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1706
1706
|
* Get a single contract
|
|
1707
1707
|
*
|
|
1708
1708
|
* @param params Parameters for retrieving a single contract
|
|
1709
|
-
* @returns Promise<
|
|
1709
|
+
* @returns Promise<DeliveryContract>
|
|
1710
1710
|
*/
|
|
1711
1711
|
getDeliveryContract(params) {
|
|
1712
1712
|
return this.get(`/delivery/${params.settle}/contracts/${params.contract}`);
|
|
@@ -1717,7 +1717,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1717
1717
|
* Bids will be sorted by price from high to low, while asks sorted reversely
|
|
1718
1718
|
*
|
|
1719
1719
|
* @param params Parameters for retrieving the futures order book
|
|
1720
|
-
* @returns Promise<
|
|
1720
|
+
* @returns Promise<GetDeliveryOrderBookResp>
|
|
1721
1721
|
*/
|
|
1722
1722
|
getDeliveryOrderBook(params) {
|
|
1723
1723
|
const { settle, ...query } = params;
|
|
@@ -1727,7 +1727,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1727
1727
|
* Futures trading history
|
|
1728
1728
|
*
|
|
1729
1729
|
* @param params Parameters for retrieving the futures trading history
|
|
1730
|
-
* @returns Promise<
|
|
1730
|
+
* @returns Promise<GetDeliveryTradesResp[]>
|
|
1731
1731
|
*/
|
|
1732
1732
|
getDeliveryTrades(params) {
|
|
1733
1733
|
const { settle, ...query } = params;
|
|
@@ -1740,7 +1740,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1740
1740
|
* Maximum of 2000 points are returned in one query. Be sure not to exceed the limit when specifying from, to and interval.
|
|
1741
1741
|
*
|
|
1742
1742
|
* @param params Parameters for retrieving futures Candles
|
|
1743
|
-
* @returns Promise<
|
|
1743
|
+
* @returns Promise<GetDeliveryCandlesResp[]>
|
|
1744
1744
|
*/
|
|
1745
1745
|
getDeliveryCandles(params) {
|
|
1746
1746
|
const { settle, ...query } = params;
|
|
@@ -1750,7 +1750,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1750
1750
|
* List futures tickers
|
|
1751
1751
|
*
|
|
1752
1752
|
* @param params Parameters for listing futures tickers
|
|
1753
|
-
* @returns Promise<
|
|
1753
|
+
* @returns Promise<GetDeliveryTickersResp[]>
|
|
1754
1754
|
*/
|
|
1755
1755
|
getDeliveryTickers(params) {
|
|
1756
1756
|
const { settle, ...query } = params;
|
|
@@ -1760,10 +1760,10 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1760
1760
|
* Futures insurance balance history
|
|
1761
1761
|
*
|
|
1762
1762
|
* @param params Parameters for retrieving the futures insurance balance history
|
|
1763
|
-
* @returns Promise<
|
|
1763
|
+
* @returns Promise<{
|
|
1764
1764
|
* t: number;
|
|
1765
1765
|
* b: string;
|
|
1766
|
-
* }[]
|
|
1766
|
+
* }[]>
|
|
1767
1767
|
*/
|
|
1768
1768
|
getDeliveryInsuranceBalanceHistory(params) {
|
|
1769
1769
|
const { settle, ...query } = params;
|
|
@@ -1773,7 +1773,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1773
1773
|
* Query futures account
|
|
1774
1774
|
*
|
|
1775
1775
|
* @param params Parameters for querying futures account
|
|
1776
|
-
* @returns Promise<
|
|
1776
|
+
* @returns Promise<GetDeliveryAccountResp>
|
|
1777
1777
|
*/
|
|
1778
1778
|
getDeliveryAccount(params) {
|
|
1779
1779
|
const { settle, ...query } = params;
|
|
@@ -1783,7 +1783,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1783
1783
|
* Query account book
|
|
1784
1784
|
*
|
|
1785
1785
|
* @param params Parameters for querying account book
|
|
1786
|
-
* @returns Promise<
|
|
1786
|
+
* @returns Promise<GetDeliveryBookResp[]>
|
|
1787
1787
|
*/
|
|
1788
1788
|
getDeliveryBook(params) {
|
|
1789
1789
|
const { settle, ...query } = params;
|
|
@@ -1793,7 +1793,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1793
1793
|
* List all positions of a user
|
|
1794
1794
|
*
|
|
1795
1795
|
* @param params Parameters for listing all positions of a user
|
|
1796
|
-
* @returns Promise<
|
|
1796
|
+
* @returns Promise<Position[]>
|
|
1797
1797
|
*/
|
|
1798
1798
|
getDeliveryPositions(params) {
|
|
1799
1799
|
return this.getPrivate(`/delivery/${params.settle}/positions`);
|
|
@@ -1802,7 +1802,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1802
1802
|
* Get single position
|
|
1803
1803
|
*
|
|
1804
1804
|
* @param params Parameters for retrieving a single position
|
|
1805
|
-
* @returns Promise<
|
|
1805
|
+
* @returns Promise<Position>
|
|
1806
1806
|
*/
|
|
1807
1807
|
getDeliveryPosition(params) {
|
|
1808
1808
|
return this.getPrivate(`/delivery/${params.settle}/positions/${params.contract}`);
|
|
@@ -1811,7 +1811,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1811
1811
|
* Update position margin
|
|
1812
1812
|
*
|
|
1813
1813
|
* @param params Parameters for updating position margin
|
|
1814
|
-
* @returns Promise<
|
|
1814
|
+
* @returns Promise<Position>
|
|
1815
1815
|
*/
|
|
1816
1816
|
updateDeliveryMargin(params) {
|
|
1817
1817
|
const { settle, contract, ...query } = params;
|
|
@@ -1821,7 +1821,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1821
1821
|
* Update position leverage
|
|
1822
1822
|
*
|
|
1823
1823
|
* @param params Parameters for updating position leverage
|
|
1824
|
-
* @returns Promise<
|
|
1824
|
+
* @returns Promise<Position>
|
|
1825
1825
|
*/
|
|
1826
1826
|
updateDeliveryLeverage(params) {
|
|
1827
1827
|
const { settle, contract, ...query } = params;
|
|
@@ -1831,7 +1831,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1831
1831
|
* Update position risk limit
|
|
1832
1832
|
*
|
|
1833
1833
|
* @param params Parameters for updating position risk limit
|
|
1834
|
-
* @returns Promise<
|
|
1834
|
+
* @returns Promise<Position>
|
|
1835
1835
|
*/
|
|
1836
1836
|
updateDeliveryRiskLimit(params) {
|
|
1837
1837
|
const { settle, contract, ...query } = params;
|
|
@@ -1843,7 +1843,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1843
1843
|
* Zero-filled order cannot be retrieved 10 minutes after order cancellation
|
|
1844
1844
|
*
|
|
1845
1845
|
* @param params Parameters for creating a futures order
|
|
1846
|
-
* @returns Promise<
|
|
1846
|
+
* @returns Promise<FuturesOrder>
|
|
1847
1847
|
*/
|
|
1848
1848
|
submitDeliveryOrder(params) {
|
|
1849
1849
|
const { settle, ...body } = params;
|
|
@@ -1855,7 +1855,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1855
1855
|
* Zero-fill order cannot be retrieved 10 minutes after order cancellation.
|
|
1856
1856
|
*
|
|
1857
1857
|
* @param params Parameters for listing futures orders
|
|
1858
|
-
* @returns Promise<
|
|
1858
|
+
* @returns Promise<FuturesOrder[]>
|
|
1859
1859
|
*/
|
|
1860
1860
|
getDeliveryOrders(params) {
|
|
1861
1861
|
const { settle, ...query } = params;
|
|
@@ -1867,7 +1867,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1867
1867
|
* Zero-filled order cannot be retrieved 10 minutes after order cancellation
|
|
1868
1868
|
*
|
|
1869
1869
|
* @param params Parameters for cancelling all open orders matched
|
|
1870
|
-
* @returns Promise<
|
|
1870
|
+
* @returns Promise<FuturesOrder[]>
|
|
1871
1871
|
*/
|
|
1872
1872
|
cancelAllDeliveryOrders(params) {
|
|
1873
1873
|
const { settle, ...query } = params;
|
|
@@ -1881,7 +1881,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1881
1881
|
* Zero-filled order cannot be retrieved 10 minutes after order cancellation
|
|
1882
1882
|
*
|
|
1883
1883
|
* @param params Parameters for retrieving a single order
|
|
1884
|
-
* @returns Promise<
|
|
1884
|
+
* @returns Promise<FuturesOrder>
|
|
1885
1885
|
*/
|
|
1886
1886
|
getDeliveryOrder(params) {
|
|
1887
1887
|
return this.getPrivate(`/delivery/${params.settle}/orders/${params.order_id}`);
|
|
@@ -1890,7 +1890,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1890
1890
|
* Cancel a single order
|
|
1891
1891
|
*
|
|
1892
1892
|
* @param params Parameters for cancelling a single order
|
|
1893
|
-
* @returns Promise<
|
|
1893
|
+
* @returns Promise<FuturesOrder>
|
|
1894
1894
|
*/
|
|
1895
1895
|
cancelDeliveryOrder(params) {
|
|
1896
1896
|
return this.deletePrivate(`/delivery/${params.settle}/orders/${params.order_id}`);
|
|
@@ -1899,7 +1899,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1899
1899
|
* List personal trading history
|
|
1900
1900
|
*
|
|
1901
1901
|
* @param params Parameters for listing personal trading history
|
|
1902
|
-
* @returns Promise<
|
|
1902
|
+
* @returns Promise<GetDeliveryTradingHistoryResp[]>
|
|
1903
1903
|
*/
|
|
1904
1904
|
getDeliveryTradingHistory(params) {
|
|
1905
1905
|
const { settle, ...query } = params;
|
|
@@ -1909,7 +1909,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1909
1909
|
* List position close history
|
|
1910
1910
|
*
|
|
1911
1911
|
* @param params Parameters for listing position close history
|
|
1912
|
-
* @returns Promise<
|
|
1912
|
+
* @returns Promise<GetDeliveryClosedPositionsResp[]>
|
|
1913
1913
|
*/
|
|
1914
1914
|
getDeliveryClosedPositions(params) {
|
|
1915
1915
|
const { settle, ...query } = params;
|
|
@@ -1919,7 +1919,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1919
1919
|
* List liquidation history
|
|
1920
1920
|
*
|
|
1921
1921
|
* @param params Parameters for listing liquidation history
|
|
1922
|
-
* @returns Promise<
|
|
1922
|
+
* @returns Promise<GetDeliveryLiquidationHistoryResp[]>
|
|
1923
1923
|
*/
|
|
1924
1924
|
getDeliveryLiquidationHistory(params) {
|
|
1925
1925
|
const { settle, ...query } = params;
|
|
@@ -1929,7 +1929,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1929
1929
|
* List settlement history
|
|
1930
1930
|
*
|
|
1931
1931
|
* @param params Parameters for listing settlement history
|
|
1932
|
-
* @returns Promise<
|
|
1932
|
+
* @returns Promise<GetDeliverySettlementHistoryResp[]>
|
|
1933
1933
|
*/
|
|
1934
1934
|
getDeliverySettlementHistory(params) {
|
|
1935
1935
|
const { settle, ...query } = params;
|
|
@@ -1939,7 +1939,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1939
1939
|
* Create a price-triggered order
|
|
1940
1940
|
*
|
|
1941
1941
|
* @param params Parameters for creating a price-triggered order
|
|
1942
|
-
* @returns Promise<
|
|
1942
|
+
* @returns Promise<{ id: number }>
|
|
1943
1943
|
*/
|
|
1944
1944
|
submitDeliveryTriggeredOrder(params) {
|
|
1945
1945
|
const { settle, ...body } = params;
|
|
@@ -1951,7 +1951,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1951
1951
|
* List all auto orders
|
|
1952
1952
|
*
|
|
1953
1953
|
* @param params Parameters for listing all auto orders
|
|
1954
|
-
* @returns Promise<
|
|
1954
|
+
* @returns Promise<FuturesPriceTriggeredOrder[]>
|
|
1955
1955
|
*/
|
|
1956
1956
|
getDeliveryAutoOrders(params) {
|
|
1957
1957
|
const { settle, ...query } = params;
|
|
@@ -1961,7 +1961,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1961
1961
|
* Cancel all open orders
|
|
1962
1962
|
*
|
|
1963
1963
|
* @param params Parameters for cancelling all open orders
|
|
1964
|
-
* @returns Promise<
|
|
1964
|
+
* @returns Promise<FuturesPriceTriggeredOrder[]>
|
|
1965
1965
|
*/
|
|
1966
1966
|
cancelAllOpenDeliveryOrders(params) {
|
|
1967
1967
|
const { settle, ...query } = params;
|
|
@@ -1973,7 +1973,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1973
1973
|
* Get a price-triggered order
|
|
1974
1974
|
*
|
|
1975
1975
|
* @param params Parameters for retrieving a price-triggered order
|
|
1976
|
-
* @returns Promise<
|
|
1976
|
+
* @returns Promise<FuturesPriceTriggeredOrder>
|
|
1977
1977
|
*/
|
|
1978
1978
|
getDeliveryTriggeredOrder(params) {
|
|
1979
1979
|
return this.getPrivate(`/delivery/${params.settle}/price_orders/${params.order_id}`);
|
|
@@ -1982,7 +1982,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1982
1982
|
* Cancel a price-triggered order
|
|
1983
1983
|
*
|
|
1984
1984
|
* @param params Parameters for cancelling a price-triggered order
|
|
1985
|
-
* @returns Promise<
|
|
1985
|
+
* @returns Promise<FuturesPriceTriggeredOrder>
|
|
1986
1986
|
*/
|
|
1987
1987
|
cancelTriggeredDeliveryOrder(params) {
|
|
1988
1988
|
return this.deletePrivate(`/delivery/${params.settle}/price_orders/${params.order_id}`);
|
|
@@ -1994,7 +1994,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
1994
1994
|
/**
|
|
1995
1995
|
* List all underlyings
|
|
1996
1996
|
*
|
|
1997
|
-
* @returns Promise<
|
|
1997
|
+
* @returns Promise<{ name: string; index_price: string }[]>
|
|
1998
1998
|
*/
|
|
1999
1999
|
getOptionsUnderlyings() {
|
|
2000
2000
|
return this.get(`/options/underlyings`);
|
|
@@ -2003,7 +2003,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2003
2003
|
* List all expiration times
|
|
2004
2004
|
*
|
|
2005
2005
|
* @param params Parameters for listing expiration times
|
|
2006
|
-
* @returns Promise<
|
|
2006
|
+
* @returns Promise<number[]>
|
|
2007
2007
|
*/
|
|
2008
2008
|
getOptionsExpirationTimes(params) {
|
|
2009
2009
|
return this.get(`/options/expirations`, params);
|
|
@@ -2012,7 +2012,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2012
2012
|
* List all the contracts with specified underlying and expiration time
|
|
2013
2013
|
*
|
|
2014
2014
|
* @param params Parameters for listing contracts
|
|
2015
|
-
* @returns Promise<
|
|
2015
|
+
* @returns Promise<GetOptionsContractsResp[]>
|
|
2016
2016
|
*/
|
|
2017
2017
|
getOptionsContracts(params) {
|
|
2018
2018
|
return this.get(`/options/contracts`, params);
|
|
@@ -2021,7 +2021,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2021
2021
|
* Query specified contract detail
|
|
2022
2022
|
*
|
|
2023
2023
|
* @param params Parameters for querying specified contract detail
|
|
2024
|
-
* @returns Promise<
|
|
2024
|
+
* @returns Promise<GetOptionsContractsResp>
|
|
2025
2025
|
*/
|
|
2026
2026
|
getOptionsContract(params) {
|
|
2027
2027
|
return this.get(`/options/contracts/${params.contract}`);
|
|
@@ -2030,7 +2030,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2030
2030
|
* List settlement history
|
|
2031
2031
|
*
|
|
2032
2032
|
* @param params Parameters for listing settlement history
|
|
2033
|
-
* @returns Promise<
|
|
2033
|
+
* @returns Promise<GetOptionsSettlementHistoryResp[]>
|
|
2034
2034
|
*/
|
|
2035
2035
|
getOptionsSettlementHistory(params) {
|
|
2036
2036
|
return this.get(`/options/settlements`, params);
|
|
@@ -2039,7 +2039,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2039
2039
|
* Get specified contract's settlement
|
|
2040
2040
|
*
|
|
2041
2041
|
* @param params Parameters for retrieving specified contract's settlement
|
|
2042
|
-
* @returns Promise<
|
|
2042
|
+
* @returns Promise<GetOptionsSettlementHistoryResp}>
|
|
2043
2043
|
*/
|
|
2044
2044
|
getOptionsContractSettlement(params) {
|
|
2045
2045
|
const { contract, ...query } = params;
|
|
@@ -2049,7 +2049,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2049
2049
|
* List my options settlements
|
|
2050
2050
|
*
|
|
2051
2051
|
* @param params Parameters for listing my options settlements
|
|
2052
|
-
* @returns Promise<
|
|
2052
|
+
* @returns Promise<GetOptionsMySettlementsResp[]>
|
|
2053
2053
|
*/
|
|
2054
2054
|
getOptionsMySettlements(params) {
|
|
2055
2055
|
return this.getPrivate(`/options/my_settlements`, params);
|
|
@@ -2060,7 +2060,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2060
2060
|
* Bids will be sorted by price from high to low, while asks sorted reversely
|
|
2061
2061
|
*
|
|
2062
2062
|
* @param params Parameters for retrieving options order book
|
|
2063
|
-
* @returns Promise<
|
|
2063
|
+
* @returns Promise<GetOptionsOrderBookResp>
|
|
2064
2064
|
*/
|
|
2065
2065
|
getOptionsOrderBook(params) {
|
|
2066
2066
|
return this.get(`/options/order_book`, params);
|
|
@@ -2069,7 +2069,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2069
2069
|
* List tickers of options contracts
|
|
2070
2070
|
*
|
|
2071
2071
|
* @param params Parameters for listing tickers of options contracts
|
|
2072
|
-
* @returns Promise<
|
|
2072
|
+
* @returns Promise<GetOptionsTickersResp[]>
|
|
2073
2073
|
*/
|
|
2074
2074
|
getOptionsTickers(params) {
|
|
2075
2075
|
return this.get(`/options/tickers`, params);
|
|
@@ -2078,11 +2078,11 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2078
2078
|
* Get underlying ticker
|
|
2079
2079
|
*
|
|
2080
2080
|
* @param params Parameters for retrieving underlying ticker
|
|
2081
|
-
* @returns Promise<
|
|
2081
|
+
* @returns Promise<{
|
|
2082
2082
|
* trade_put: number;
|
|
2083
2083
|
* trade_call: number;
|
|
2084
2084
|
* index_price: string;
|
|
2085
|
-
* }
|
|
2085
|
+
* }>
|
|
2086
2086
|
*/
|
|
2087
2087
|
getOptionsUnderlyingTicker(params) {
|
|
2088
2088
|
return this.get(`/options/underlying/tickers/${params.underlying}`);
|
|
@@ -2091,7 +2091,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2091
2091
|
* Get options Candles
|
|
2092
2092
|
*
|
|
2093
2093
|
* @param params Parameters for retrieving options Candles
|
|
2094
|
-
* @returns Promise<
|
|
2094
|
+
* @returns Promise<GetOptionsCandlesResp[]>
|
|
2095
2095
|
*/
|
|
2096
2096
|
getOptionsCandles(params) {
|
|
2097
2097
|
return this.get(`/options/Candles`, params);
|
|
@@ -2100,7 +2100,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2100
2100
|
* Mark price Candles of an underlying
|
|
2101
2101
|
*
|
|
2102
2102
|
* @param params Parameters for retrieving mark price Candles of an underlying
|
|
2103
|
-
* @returns Promise<
|
|
2103
|
+
* @returns Promise<GetOptionsUnderlyingCandlesResp[]>
|
|
2104
2104
|
*/
|
|
2105
2105
|
getOptionsUnderlyingCandles(params) {
|
|
2106
2106
|
return this.get(`/options/underlying/Candles`, params);
|
|
@@ -2109,7 +2109,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2109
2109
|
* Options trade history
|
|
2110
2110
|
*
|
|
2111
2111
|
* @param params Parameters for retrieving options trade history
|
|
2112
|
-
* @returns Promise<
|
|
2112
|
+
* @returns Promise<GetOptionsTradesResp[]>
|
|
2113
2113
|
*/
|
|
2114
2114
|
getOptionsTrades(params) {
|
|
2115
2115
|
return this.get(`/options/trades`, params);
|
|
@@ -2117,7 +2117,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2117
2117
|
/**
|
|
2118
2118
|
* List options account
|
|
2119
2119
|
*
|
|
2120
|
-
* @returns Promise<
|
|
2120
|
+
* @returns Promise<GetOptionsAccountResp>
|
|
2121
2121
|
*/
|
|
2122
2122
|
getOptionsAccount() {
|
|
2123
2123
|
return this.getPrivate(`/options/accounts`);
|
|
@@ -2126,7 +2126,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2126
2126
|
* List account changing history
|
|
2127
2127
|
*
|
|
2128
2128
|
* @param params Parameters for listing account changing history
|
|
2129
|
-
* @returns Promise<
|
|
2129
|
+
* @returns Promise<GetOptionsAccountChangeResp[]>
|
|
2130
2130
|
*/
|
|
2131
2131
|
getOptionsAccountChange(params) {
|
|
2132
2132
|
return this.getPrivate(`/options/account_book`, params);
|
|
@@ -2135,7 +2135,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2135
2135
|
* List user's positions of specified underlying
|
|
2136
2136
|
*
|
|
2137
2137
|
* @param params Parameters for listing user's positions of specified underlying
|
|
2138
|
-
* @returns Promise<
|
|
2138
|
+
* @returns Promise<GetOptionsPositionsUnderlyingResp[]>
|
|
2139
2139
|
*/
|
|
2140
2140
|
getOptionsPositionsUnderlying(params) {
|
|
2141
2141
|
return this.getPrivate(`/options/positions`, params);
|
|
@@ -2144,7 +2144,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2144
2144
|
* Get specified contract position
|
|
2145
2145
|
*
|
|
2146
2146
|
* @param params Parameters for retrieving specified contract position
|
|
2147
|
-
* @returns Promise<
|
|
2147
|
+
* @returns Promise<GetOptionsPositionsUnderlyingResp>
|
|
2148
2148
|
*/
|
|
2149
2149
|
getOptionsPositionContract(params) {
|
|
2150
2150
|
return this.getPrivate(`/options/positions/${params.contract}`);
|
|
@@ -2153,7 +2153,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2153
2153
|
* List user's liquidation history of specified underlying
|
|
2154
2154
|
*
|
|
2155
2155
|
* @param params Parameters for listing user's liquidation history of specified underlying
|
|
2156
|
-
* @returns Promise<
|
|
2156
|
+
* @returns Promise<GetOptionsLiquidationResp[]>
|
|
2157
2157
|
*/
|
|
2158
2158
|
getOptionsLiquidation(params) {
|
|
2159
2159
|
return this.getPrivate(`/options/position_close`, params);
|
|
@@ -2162,7 +2162,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2162
2162
|
* Create an options order
|
|
2163
2163
|
*
|
|
2164
2164
|
* @param params Parameters for creating an options order
|
|
2165
|
-
* @returns Promise<
|
|
2165
|
+
* @returns Promise<SubmitOptionsOrderResp>
|
|
2166
2166
|
*/
|
|
2167
2167
|
submitOptionsOrder(params) {
|
|
2168
2168
|
return this.postPrivate(`/options/orders`, { body: params });
|
|
@@ -2171,7 +2171,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2171
2171
|
* List options orders
|
|
2172
2172
|
*
|
|
2173
2173
|
* @param params Parameters for listing options orders
|
|
2174
|
-
* @returns Promise<
|
|
2174
|
+
* @returns Promise<SubmitOptionsOrderResp[]>
|
|
2175
2175
|
*/
|
|
2176
2176
|
getOptionsOrders(params) {
|
|
2177
2177
|
return this.getPrivate(`/options/orders`, params);
|
|
@@ -2180,7 +2180,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2180
2180
|
* Cancel all open orders matched
|
|
2181
2181
|
*
|
|
2182
2182
|
* @param params Parameters for canceling all open orders matched
|
|
2183
|
-
* @returns Promise<
|
|
2183
|
+
* @returns Promise<SubmitOptionsOrderResp[]>
|
|
2184
2184
|
*/
|
|
2185
2185
|
cancelAllOpenOptionsOrders(params) {
|
|
2186
2186
|
return this.deletePrivate(`/options/orders`, { query: params });
|
|
@@ -2189,7 +2189,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2189
2189
|
* Get a single order
|
|
2190
2190
|
*
|
|
2191
2191
|
* @param params Parameters for retrieving a single order
|
|
2192
|
-
* @returns Promise<
|
|
2192
|
+
* @returns Promise<SubmitOptionsOrderResp>
|
|
2193
2193
|
*/
|
|
2194
2194
|
getOptionsOrder(params) {
|
|
2195
2195
|
return this.getPrivate(`/options/orders/${params.order_id}`);
|
|
@@ -2198,7 +2198,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2198
2198
|
* Cancel a single order
|
|
2199
2199
|
*
|
|
2200
2200
|
* @param params Parameters for canceling a single order
|
|
2201
|
-
* @returns Promise<
|
|
2201
|
+
* @returns Promise<SubmitOptionsOrderResp>
|
|
2202
2202
|
*/
|
|
2203
2203
|
cancelOptionsOrder(params) {
|
|
2204
2204
|
return this.deletePrivate(`/options/orders/${params.order_id}`);
|
|
@@ -2207,7 +2207,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2207
2207
|
* List personal trading history
|
|
2208
2208
|
*
|
|
2209
2209
|
* @param params Parameters for listing personal trading history
|
|
2210
|
-
* @returns Promise<
|
|
2210
|
+
* @returns Promise<GetOptionsPersonalHistoryResp[]>
|
|
2211
2211
|
*/
|
|
2212
2212
|
getOptionsPersonalHistory(params) {
|
|
2213
2213
|
return this.getPrivate(`/options/my_trades`, params);
|
|
@@ -2219,7 +2219,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2219
2219
|
/**
|
|
2220
2220
|
* List currencies for lending
|
|
2221
2221
|
*
|
|
2222
|
-
* @returns Promise<
|
|
2222
|
+
* @returns Promise<GetLendingCurrenciesResp[]>
|
|
2223
2223
|
*/
|
|
2224
2224
|
getLendingCurrencies() {
|
|
2225
2225
|
return this.get(`/earn/uni/currencies`);
|
|
@@ -2228,7 +2228,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2228
2228
|
* Get currency detail for lending
|
|
2229
2229
|
*
|
|
2230
2230
|
* @param params Parameters for retrieving currency detail for lending
|
|
2231
|
-
* @returns Promise<
|
|
2231
|
+
* @returns Promise<GetLendingCurrenciesResp>
|
|
2232
2232
|
*/
|
|
2233
2233
|
getLendingCurrency(params) {
|
|
2234
2234
|
return this.get(`/earn/uni/currencies/${params.currency}`);
|
|
@@ -2237,7 +2237,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2237
2237
|
* Lend or redeem
|
|
2238
2238
|
*
|
|
2239
2239
|
* @param params Parameters for lending or redeeming
|
|
2240
|
-
* @returns Promise<
|
|
2240
|
+
* @returns Promise<any>
|
|
2241
2241
|
*/
|
|
2242
2242
|
submitLendOrRedeemOrder(params) {
|
|
2243
2243
|
return this.postPrivate(`/earn/uni/lends`, { body: params });
|
|
@@ -2246,7 +2246,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2246
2246
|
* List user's lending orders
|
|
2247
2247
|
*
|
|
2248
2248
|
* @param params Parameters for listing user's lending orders
|
|
2249
|
-
* @returns Promise<
|
|
2249
|
+
* @returns Promise<GetLendingOrdersResp[]>
|
|
2250
2250
|
*/
|
|
2251
2251
|
getLendingOrders(params) {
|
|
2252
2252
|
return this.getPrivate(`/earn/uni/lends`, params);
|
|
@@ -2257,7 +2257,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2257
2257
|
* Currently only supports amending the minimum interest rate (hour)
|
|
2258
2258
|
*
|
|
2259
2259
|
* @param params Parameters for amending lending order
|
|
2260
|
-
* @returns Promise<
|
|
2260
|
+
* @returns Promise<any>
|
|
2261
2261
|
*/
|
|
2262
2262
|
updateLendingOrder(params) {
|
|
2263
2263
|
return this.patchPrivate(`/earn/uni/lends`, { query: params });
|
|
@@ -2266,7 +2266,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2266
2266
|
* List records of lending
|
|
2267
2267
|
*
|
|
2268
2268
|
* @param params Parameters for listing records of lending
|
|
2269
|
-
* @returns Promise<
|
|
2269
|
+
* @returns Promise<GetLendingRecordsResp[]>
|
|
2270
2270
|
*/
|
|
2271
2271
|
getLendingRecords(params) {
|
|
2272
2272
|
return this.getPrivate(`/earn/uni/lend_records`, params);
|
|
@@ -2275,10 +2275,10 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2275
2275
|
* Get the user's total interest income of specified currency
|
|
2276
2276
|
*
|
|
2277
2277
|
* @param params Parameters for retrieving the user's total interest income of specified currency
|
|
2278
|
-
* @returns Promise<
|
|
2278
|
+
* @returns Promise<{
|
|
2279
2279
|
* currency: string;
|
|
2280
2280
|
* interest: string;
|
|
2281
|
-
* }
|
|
2281
|
+
* }>
|
|
2282
2282
|
*/
|
|
2283
2283
|
getLendingTotalInterest(params) {
|
|
2284
2284
|
return this.getPrivate(`/earn/uni/interests/${params.currency}`);
|
|
@@ -2287,7 +2287,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2287
2287
|
* List interest records
|
|
2288
2288
|
*
|
|
2289
2289
|
* @param params Parameters for listing interest records
|
|
2290
|
-
* @returns Promise<
|
|
2290
|
+
* @returns Promise<GetLendingInterestRecordsResp[]>
|
|
2291
2291
|
*/
|
|
2292
2292
|
getLendingInterestRecords(params) {
|
|
2293
2293
|
return this.getPrivate(`/earn/uni/interest_records`, params);
|
|
@@ -2296,7 +2296,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2296
2296
|
* Set interest reinvestment toggle
|
|
2297
2297
|
*
|
|
2298
2298
|
* @param params Parameters for setting interest reinvestment toggle
|
|
2299
|
-
* @returns Promise<
|
|
2299
|
+
* @returns Promise<any>
|
|
2300
2300
|
*/
|
|
2301
2301
|
updateInterestReinvestment(params) {
|
|
2302
2302
|
return this.putPrivate(`/earn/uni/interest_reinvest`, { body: params });
|
|
@@ -2305,10 +2305,10 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2305
2305
|
* Query currency interest compounding status
|
|
2306
2306
|
*
|
|
2307
2307
|
* @param params Parameters for querying currency interest compounding status
|
|
2308
|
-
* @returns Promise<
|
|
2308
|
+
* @returns Promise<{
|
|
2309
2309
|
* currency: string;
|
|
2310
2310
|
* interest_status: string;
|
|
2311
|
-
* }
|
|
2311
|
+
* }>
|
|
2312
2312
|
*/
|
|
2313
2313
|
getLendingInterestStatus(params) {
|
|
2314
2314
|
return this.getPrivate(`/earn/uni/interest_status/${params.currency}`);
|
|
@@ -2321,7 +2321,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2321
2321
|
* Place order
|
|
2322
2322
|
*
|
|
2323
2323
|
* @param params Parameters for placing an order
|
|
2324
|
-
* @returns Promise<
|
|
2324
|
+
* @returns Promise<{ order_id: number }>
|
|
2325
2325
|
*/
|
|
2326
2326
|
submitLoanOrder(params) {
|
|
2327
2327
|
return this.postPrivate(`/loan/collateral/orders`, { body: params });
|
|
@@ -2330,7 +2330,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2330
2330
|
* List Orders
|
|
2331
2331
|
*
|
|
2332
2332
|
* @param params Parameters for listing orders
|
|
2333
|
-
* @returns Promise<
|
|
2333
|
+
* @returns Promise<GetLoanOrdersResp[]>
|
|
2334
2334
|
*/
|
|
2335
2335
|
getLoanOrders(params) {
|
|
2336
2336
|
return this.getPrivate(`/loan/collateral/orders`, params);
|
|
@@ -2339,7 +2339,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2339
2339
|
* Get a single order
|
|
2340
2340
|
*
|
|
2341
2341
|
* @param params Parameters for retrieving a single order
|
|
2342
|
-
* @returns Promise<
|
|
2342
|
+
* @returns Promise<GetLoanOrdersResp>
|
|
2343
2343
|
*/
|
|
2344
2344
|
getLoanOrder(params) {
|
|
2345
2345
|
return this.getPrivate(`/loan/collateral/orders/${params.order_id}`);
|
|
@@ -2348,10 +2348,10 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2348
2348
|
* Repayment
|
|
2349
2349
|
*
|
|
2350
2350
|
* @param params Parameters for repayment
|
|
2351
|
-
* @returns Promise<
|
|
2351
|
+
* @returns Promise<{
|
|
2352
2352
|
* repaid_principal: string;
|
|
2353
2353
|
* repaid_interest: string;
|
|
2354
|
-
* }
|
|
2354
|
+
* }>
|
|
2355
2355
|
*/
|
|
2356
2356
|
submitLoanRepay(params) {
|
|
2357
2357
|
return this.postPrivate(`/loan/collateral/repay`, { body: params });
|
|
@@ -2360,7 +2360,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2360
2360
|
* Repayment history
|
|
2361
2361
|
*
|
|
2362
2362
|
* @param params Parameters for retrieving repayment history
|
|
2363
|
-
* @returns Promise<
|
|
2363
|
+
* @returns Promise<GetLoanRepaymentHistoryResp[]>
|
|
2364
2364
|
*/
|
|
2365
2365
|
getLoanRepaymentHistory(params) {
|
|
2366
2366
|
return this.getPrivate(`/loan/collateral/repay_records`, params);
|
|
@@ -2369,7 +2369,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2369
2369
|
* Increase or redeem collateral
|
|
2370
2370
|
*
|
|
2371
2371
|
* @param params Parameters for increasing or redeeming collateral
|
|
2372
|
-
* @returns Promise<
|
|
2372
|
+
* @returns Promise<any>
|
|
2373
2373
|
*/
|
|
2374
2374
|
updateLoanCollateral(params) {
|
|
2375
2375
|
return this.postPrivate(`/loan/collateral/collaterals`, { body: params });
|
|
@@ -2378,7 +2378,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2378
2378
|
* Query collateral adjustment records
|
|
2379
2379
|
*
|
|
2380
2380
|
* @param params Parameters for querying collateral adjustment records
|
|
2381
|
-
* @returns Promise<
|
|
2381
|
+
* @returns Promise<GetLoanCollateralRecordsResp[]>
|
|
2382
2382
|
*/
|
|
2383
2383
|
getLoanCollateralRecords(params) {
|
|
2384
2384
|
return this.getPrivate(`/loan/collateral/collaterals`, params);
|
|
@@ -2386,10 +2386,10 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2386
2386
|
/**
|
|
2387
2387
|
* Query the total borrowing and collateral amount for the user
|
|
2388
2388
|
*
|
|
2389
|
-
* @returns Promise<
|
|
2389
|
+
* @returns Promise<{
|
|
2390
2390
|
* borrow_amount: string;
|
|
2391
2391
|
* collateral_amount: string;
|
|
2392
|
-
* }
|
|
2392
|
+
* }>
|
|
2393
2393
|
*/
|
|
2394
2394
|
getLoanTotalAmount() {
|
|
2395
2395
|
return this.getPrivate(`/loan/collateral/total_amount`);
|
|
@@ -2398,7 +2398,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2398
2398
|
* Query user's collateralization ratio
|
|
2399
2399
|
*
|
|
2400
2400
|
* @param params Parameters for querying user's collateralization ratio
|
|
2401
|
-
* @returns Promise<
|
|
2401
|
+
* @returns Promise<GetLoanCollateralizationRatioResp>
|
|
2402
2402
|
*/
|
|
2403
2403
|
getLoanCollateralizationRatio(params) {
|
|
2404
2404
|
return this.getPrivate(`/loan/collateral/ltv`, params);
|
|
@@ -2407,10 +2407,10 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2407
2407
|
* Query supported borrowing and collateral currencies
|
|
2408
2408
|
*
|
|
2409
2409
|
* @param params Parameters for querying supported borrowing and collateral currencies
|
|
2410
|
-
* @returns Promise<
|
|
2410
|
+
* @returns Promise<{
|
|
2411
2411
|
* loan_currency: string;
|
|
2412
2412
|
* collateral_currency: string[];
|
|
2413
|
-
* }[]
|
|
2413
|
+
* }[]>
|
|
2414
2414
|
*/
|
|
2415
2415
|
getLoanSupportedCurrencies(params) {
|
|
2416
2416
|
return this.get(`/loan/collateral/currencies`, params);
|
|
@@ -2423,7 +2423,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2423
2423
|
* Create Multi-Collateral Order
|
|
2424
2424
|
*
|
|
2425
2425
|
* @param params Parameters for creating a multi-collateral order
|
|
2426
|
-
* @returns Promise<
|
|
2426
|
+
* @returns Promise<{ order_id: number }>
|
|
2427
2427
|
*/
|
|
2428
2428
|
submitMultiLoanOrder(params) {
|
|
2429
2429
|
return this.postPrivate(`/loan/multi_collateral/orders`, { body: params });
|
|
@@ -2432,7 +2432,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2432
2432
|
* List Multi-Collateral Orders
|
|
2433
2433
|
*
|
|
2434
2434
|
* @param params Parameters for listing multi-collateral orders
|
|
2435
|
-
* @returns Promise<
|
|
2435
|
+
* @returns Promise<GetMultiLoanOrdersResp[]>
|
|
2436
2436
|
*/
|
|
2437
2437
|
getMultiLoanOrders(params) {
|
|
2438
2438
|
return this.getPrivate(`/loan/multi_collateral/orders`, params);
|
|
@@ -2441,7 +2441,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2441
2441
|
* Get Multi-Collateral Order Detail
|
|
2442
2442
|
*
|
|
2443
2443
|
* @param params Parameters for retrieving a multi-collateral order detail
|
|
2444
|
-
* @returns Promise<
|
|
2444
|
+
* @returns Promise<GetMultiLoanOrdersResp>
|
|
2445
2445
|
*/
|
|
2446
2446
|
getMultiLoanOrder(params) {
|
|
2447
2447
|
return this.getPrivate(`/loan/multi_collateral/orders/${params.order_id}`);
|
|
@@ -2450,7 +2450,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2450
2450
|
* Repay Multi-Collateral Loan
|
|
2451
2451
|
*
|
|
2452
2452
|
* @param params Parameters for repaying a multi-collateral loan
|
|
2453
|
-
* @returns Promise<
|
|
2453
|
+
* @returns Promise<RepayMultiLoanResp>
|
|
2454
2454
|
*/
|
|
2455
2455
|
repayMultiLoan(params) {
|
|
2456
2456
|
return this.postPrivate(`/loan/multi_collateral/repay`, { body: params });
|
|
@@ -2459,7 +2459,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2459
2459
|
* List Multi-Collateral Repay Records
|
|
2460
2460
|
*
|
|
2461
2461
|
* @param params Parameters for listing multi-collateral repay records
|
|
2462
|
-
* @returns Promise<
|
|
2462
|
+
* @returns Promise<GetMultiLoanRepayRecordsResp[]>
|
|
2463
2463
|
*/
|
|
2464
2464
|
getMultiLoanRepayRecords(params) {
|
|
2465
2465
|
return this.getPrivate(`/loan/multi_collateral/repay`, params);
|
|
@@ -2468,7 +2468,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2468
2468
|
* Operate Multi-Collateral
|
|
2469
2469
|
*
|
|
2470
2470
|
* @param params Parameters for operating multi-collateral
|
|
2471
|
-
* @returns Promise<
|
|
2471
|
+
* @returns Promise<UpdateMultiLoanResp>
|
|
2472
2472
|
*/
|
|
2473
2473
|
updateMultiLoan(params) {
|
|
2474
2474
|
return this.postPrivate(`/loan/multi_collateral/mortgage`, {
|
|
@@ -2479,7 +2479,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2479
2479
|
* Query collateral adjustment records
|
|
2480
2480
|
*
|
|
2481
2481
|
* @param params Parameters for querying collateral adjustment records
|
|
2482
|
-
* @returns Promise<
|
|
2482
|
+
* @returns Promise<GetMultiLoanAdjustmentRecordsResp[]>
|
|
2483
2483
|
*/
|
|
2484
2484
|
getMultiLoanAdjustmentRecords(params) {
|
|
2485
2485
|
return this.getPrivate(`/loan/multi_collateral/mortgage`, params);
|
|
@@ -2488,7 +2488,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2488
2488
|
* List User Currency Quota
|
|
2489
2489
|
*
|
|
2490
2490
|
* @param params Parameters for listing user currency quota
|
|
2491
|
-
* @returns Promise<
|
|
2491
|
+
* @returns Promise<GetMultiLoanCurrencyQuotaResp[]>
|
|
2492
2492
|
*/
|
|
2493
2493
|
getMultiLoanCurrencyQuota(params) {
|
|
2494
2494
|
return this.getPrivate(`/loan/multi_collateral/currency_quota`, params);
|
|
@@ -2496,7 +2496,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2496
2496
|
/**
|
|
2497
2497
|
* Query supported borrowing and collateral currencies in Multi-Collateral
|
|
2498
2498
|
*
|
|
2499
|
-
* @returns Promise<
|
|
2499
|
+
* @returns Promise<GetMultiLoanSupportedCurrenciesResp>
|
|
2500
2500
|
*/
|
|
2501
2501
|
getMultiLoanSupportedCurrencies() {
|
|
2502
2502
|
return this.get(`/loan/multi_collateral/currencies`);
|
|
@@ -2504,7 +2504,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2504
2504
|
/**
|
|
2505
2505
|
* Get Multi-Collateral ratio
|
|
2506
2506
|
*
|
|
2507
|
-
* @returns Promise<
|
|
2507
|
+
* @returns Promise<GetMultiLoanRatioResp>
|
|
2508
2508
|
*/
|
|
2509
2509
|
getMultiLoanRatio() {
|
|
2510
2510
|
return this.get(`/loan/multi_collateral/ltv`);
|
|
@@ -2512,7 +2512,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2512
2512
|
/**
|
|
2513
2513
|
* Query fixed interest rates for the currency for 7 days and 30 days
|
|
2514
2514
|
*
|
|
2515
|
-
* @returns Promise<
|
|
2515
|
+
* @returns Promise<GetMultiLoanFixedRatesResp[]>
|
|
2516
2516
|
*/
|
|
2517
2517
|
getMultiLoanFixedRates() {
|
|
2518
2518
|
return this.get(`/loan/multi_collateral/fixed_rate`);
|
|
@@ -2525,7 +2525,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2525
2525
|
* ETH2 swap
|
|
2526
2526
|
*
|
|
2527
2527
|
* @param params Parameters for ETH2 swap
|
|
2528
|
-
* @returns Promise<
|
|
2528
|
+
* @returns Promise<any>
|
|
2529
2529
|
*/
|
|
2530
2530
|
submitEth2Swap(params) {
|
|
2531
2531
|
return this.postPrivate(`/earn/staking/eth2/swap`, { body: params });
|
|
@@ -2533,7 +2533,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2533
2533
|
/**
|
|
2534
2534
|
* Dual Investment product list
|
|
2535
2535
|
*
|
|
2536
|
-
* @returns Promise<
|
|
2536
|
+
* @returns Promise<GetDualInvestmentProductsResp[]>
|
|
2537
2537
|
*/
|
|
2538
2538
|
getDualInvestmentProducts() {
|
|
2539
2539
|
return this.get(`/earn/dual/investment_plan`);
|
|
@@ -2541,7 +2541,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2541
2541
|
/**
|
|
2542
2542
|
* Dual Investment order list
|
|
2543
2543
|
*
|
|
2544
|
-
* @returns Promise<
|
|
2544
|
+
* @returns Promise<GetDualInvestmentOrdersResp[]>
|
|
2545
2545
|
*/
|
|
2546
2546
|
getDualInvestmentOrders() {
|
|
2547
2547
|
return this.getPrivate(`/earn/dual/orders`);
|
|
@@ -2550,7 +2550,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2550
2550
|
* Place Dual Investment order
|
|
2551
2551
|
*
|
|
2552
2552
|
* @param params Parameters for placing a dual investment order
|
|
2553
|
-
* @returns Promise<
|
|
2553
|
+
* @returns Promise<any>
|
|
2554
2554
|
*/
|
|
2555
2555
|
submitDualInvestmentOrder(params) {
|
|
2556
2556
|
return this.postPrivate(`/earn/dual/orders`, { body: params });
|
|
@@ -2559,7 +2559,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2559
2559
|
* Structured Product List
|
|
2560
2560
|
*
|
|
2561
2561
|
* @param params Parameters for listing structured products
|
|
2562
|
-
* @returns Promise<
|
|
2562
|
+
* @returns Promise<GetStructuredProductListResp[]>
|
|
2563
2563
|
*/
|
|
2564
2564
|
getStructuredProducts(params) {
|
|
2565
2565
|
return this.get(`/earn/structured/products`, params);
|
|
@@ -2568,7 +2568,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2568
2568
|
* Structured Product Order List
|
|
2569
2569
|
*
|
|
2570
2570
|
* @param params Parameters for listing structured product orders
|
|
2571
|
-
* @returns Promise<
|
|
2571
|
+
* @returns Promise<GetStructuredProductOrdersResp[]>
|
|
2572
2572
|
*/
|
|
2573
2573
|
getStructuredProductOrders(params) {
|
|
2574
2574
|
return this.getPrivate(`/earn/structured/orders`, params);
|
|
@@ -2577,7 +2577,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2577
2577
|
* Place Structured Product Order
|
|
2578
2578
|
*
|
|
2579
2579
|
* @param params Parameters for placing a structured product order
|
|
2580
|
-
* @returns Promise<
|
|
2580
|
+
* @returns Promise<any>
|
|
2581
2581
|
*/
|
|
2582
2582
|
submitStructuredProductOrder(params) {
|
|
2583
2583
|
return this.postPrivate(`/earn/structured/orders`, { body: params });
|
|
@@ -2589,7 +2589,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2589
2589
|
/**
|
|
2590
2590
|
* Get account detail
|
|
2591
2591
|
*
|
|
2592
|
-
* @returns Promise<
|
|
2592
|
+
* @returns Promise<GetAccountDetailResp>
|
|
2593
2593
|
*/
|
|
2594
2594
|
getAccountDetail() {
|
|
2595
2595
|
return this.getPrivate(`/account/detail`);
|
|
@@ -2598,7 +2598,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2598
2598
|
* Create STP Group
|
|
2599
2599
|
*
|
|
2600
2600
|
* @param params Parameters for creating an STP group
|
|
2601
|
-
* @returns Promise<
|
|
2601
|
+
* @returns Promise<CreateStpGroupResp>
|
|
2602
2602
|
*/
|
|
2603
2603
|
createStpGroup(params) {
|
|
2604
2604
|
return this.postPrivate(`/account/stp_groups`, { body: params });
|
|
@@ -2607,7 +2607,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2607
2607
|
* List STP Groups
|
|
2608
2608
|
*
|
|
2609
2609
|
* @param params Parameters for listing STP groups
|
|
2610
|
-
* @returns Promise<
|
|
2610
|
+
* @returns Promise<CreateStpGroupResp[]>
|
|
2611
2611
|
*/
|
|
2612
2612
|
getStpGroups(params) {
|
|
2613
2613
|
return this.getPrivate(`/account/stp_groups`, params);
|
|
@@ -2616,7 +2616,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2616
2616
|
* List users of the STP group
|
|
2617
2617
|
*
|
|
2618
2618
|
* @param params Parameters for listing users of the STP group
|
|
2619
|
-
* @returns Promise<
|
|
2619
|
+
* @returns Promise<StpResp[]>
|
|
2620
2620
|
*/
|
|
2621
2621
|
getStpGroupUsers(params) {
|
|
2622
2622
|
return this.getPrivate(`/account/stp_groups/${params.stp_id}/users`);
|
|
@@ -2625,7 +2625,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2625
2625
|
* Add users to the STP group
|
|
2626
2626
|
*
|
|
2627
2627
|
* @param params Parameters for adding users to the STP group
|
|
2628
|
-
* @returns Promise<
|
|
2628
|
+
* @returns Promise<StpResp[]>
|
|
2629
2629
|
*/
|
|
2630
2630
|
addUsersToStpGroup(params) {
|
|
2631
2631
|
const { stp_id, ...body } = params;
|
|
@@ -2637,7 +2637,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2637
2637
|
* Delete the user in the STP group
|
|
2638
2638
|
*
|
|
2639
2639
|
* @param params Parameters for deleting users from the STP group
|
|
2640
|
-
* @returns Promise<
|
|
2640
|
+
* @returns Promise<StpResp[]>
|
|
2641
2641
|
*/
|
|
2642
2642
|
deleteUserFromStpGroup(params) {
|
|
2643
2643
|
const { stp_id, ...query } = params;
|
|
@@ -2654,7 +2654,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2654
2654
|
* Record time range cannot exceed 30 days.
|
|
2655
2655
|
*
|
|
2656
2656
|
* @param params Parameters for retrieving transaction history
|
|
2657
|
-
* @returns Promise<
|
|
2657
|
+
* @returns Promise<GetAgencyTransactionHistoryResp>
|
|
2658
2658
|
*/
|
|
2659
2659
|
getAgencyTransactionHistory(params) {
|
|
2660
2660
|
return this.getPrivate('/rebate/agency/transaction_history', params);
|
|
@@ -2664,7 +2664,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2664
2664
|
* Record time range cannot exceed 30 days.
|
|
2665
2665
|
*
|
|
2666
2666
|
* @param params Parameters for retrieving commission history
|
|
2667
|
-
* @returns Promise<
|
|
2667
|
+
* @returns Promise<GetAgencyCommissionHistoryResp>
|
|
2668
2668
|
*/
|
|
2669
2669
|
getAgencyCommissionHistory(params) {
|
|
2670
2670
|
return this.getPrivate('/rebate/agency/commission_history', params);
|
|
@@ -2674,7 +2674,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2674
2674
|
* Record time range cannot exceed 30 days.
|
|
2675
2675
|
*
|
|
2676
2676
|
* @param params Parameters for retrieving commission rebate records
|
|
2677
|
-
* @returns Promise<
|
|
2677
|
+
* @returns Promise<GetBrokerCommissionHistoryResp>
|
|
2678
2678
|
*/
|
|
2679
2679
|
getBrokerCommissionHistory(params) {
|
|
2680
2680
|
return this.getPrivate('/rebate/broker/commission_history', params);
|
|
@@ -2684,7 +2684,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
2684
2684
|
* Record time range cannot exceed 30 days.
|
|
2685
2685
|
*
|
|
2686
2686
|
* @param params Parameters for retrieving trading history
|
|
2687
|
-
* @returns Promise<
|
|
2687
|
+
* @returns Promise<GetBrokerTransactionHistoryResp>
|
|
2688
2688
|
*/
|
|
2689
2689
|
getBrokerTransactionHistory(params) {
|
|
2690
2690
|
return this.getPrivate('/rebate/broker/transaction_history', params);
|