kucoin-api 1.0.23 → 2.0.1

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.
Files changed (34) hide show
  1. package/README.md +3 -3
  2. package/dist/cjs/FuturesClient.d.ts +411 -117
  3. package/dist/cjs/FuturesClient.js +381 -113
  4. package/dist/cjs/FuturesClient.js.map +1 -1
  5. package/dist/cjs/SpotClient.d.ts +906 -338
  6. package/dist/cjs/SpotClient.js +926 -364
  7. package/dist/cjs/SpotClient.js.map +1 -1
  8. package/dist/cjs/types/request/futures.types.d.ts +68 -16
  9. package/dist/cjs/types/request/spot-account.d.ts +1 -1
  10. package/dist/cjs/types/request/spot-funding.d.ts +0 -2
  11. package/dist/cjs/types/request/spot-trading.d.ts +11 -20
  12. package/dist/cjs/types/response/futures.types.d.ts +118 -58
  13. package/dist/cjs/types/response/spot-account.d.ts +76 -28
  14. package/dist/cjs/types/response/spot-funding.d.ts +34 -32
  15. package/dist/cjs/types/response/spot-margin-trading.d.ts +80 -15
  16. package/dist/cjs/types/response/spot-misc.d.ts +1 -1
  17. package/dist/cjs/types/response/spot-trading.d.ts +100 -74
  18. package/dist/mjs/FuturesClient.d.ts +411 -117
  19. package/dist/mjs/FuturesClient.js +381 -113
  20. package/dist/mjs/FuturesClient.js.map +1 -1
  21. package/dist/mjs/SpotClient.d.ts +906 -338
  22. package/dist/mjs/SpotClient.js +926 -364
  23. package/dist/mjs/SpotClient.js.map +1 -1
  24. package/dist/mjs/types/request/futures.types.d.ts +68 -16
  25. package/dist/mjs/types/request/spot-account.d.ts +1 -1
  26. package/dist/mjs/types/request/spot-funding.d.ts +0 -2
  27. package/dist/mjs/types/request/spot-trading.d.ts +11 -20
  28. package/dist/mjs/types/response/futures.types.d.ts +118 -58
  29. package/dist/mjs/types/response/spot-account.d.ts +76 -28
  30. package/dist/mjs/types/response/spot-funding.d.ts +34 -32
  31. package/dist/mjs/types/response/spot-margin-trading.d.ts +80 -15
  32. package/dist/mjs/types/response/spot-misc.d.ts +1 -1
  33. package/dist/mjs/types/response/spot-trading.d.ts +100 -74
  34. package/package.json +1 -1
@@ -6,14 +6,14 @@ import { GetEarnFixedIncomeHoldAssetsRequest, GetEarnRedeemPreviewRequest, Initi
6
6
  import { ApplyWithdrawRequest, CreateDepositAddressV3Request, FlexTransferRequest, GetDepositsRequest, GetIsolatedMarginBalanceRequest, GetMarginBalanceRequest, GetTransferableRequest, GetWithdrawalsRequest, InnerTransferRequest, submitTransferMasterSubRequest, SubmitWithdrawV3Request } from './types/request/spot-funding.js';
7
7
  import { GetHFMarginFilledRequest, getHFMarginFillsRequest, GetLendingRedemptionOrdersV3Request, GetLendingSubscriptionOrdersV3Request, HFMarginRequestOrder, InitiateLendingRedemptionV3Request, InitiateLendingSubscriptionV3Request, MarginBorrowV3Request, MarginHistoryV3Request, MarginInterestRecordsRequest, MarginRepayV3Request, MarginRiskLimitRequest, ModifyLendingSubscriptionOrdersV3Request, SubmitHFMarginOrderRequest, SubmitMarginOrderRequest } from './types/request/spot-margin-trading.js';
8
8
  import { GetAnnouncementsRequest } from './types/request/spot-misc.js';
9
- import { CancelAllOrdersRequest, CancelSpecifiedNumberHFOrdersRequest, CancelStopOrdersRequest, GetFillsRequest, GetHFCompletedOrdersRequest, GetHFFilledListRequest, GetOCOOrdersRequest, GetOrderListRequest, GetSpotKlinesRequest, GetStopOrdersListRequest, ModifyHFOrderRequest, SubmitHFOrderRequest, SubmitMultipleHFOrdersRequest, SubmitMultipleOrdersRequest, SubmitOCOOrderRequest, SubmitOrderRequest, SubmitStopOrderRequest } from './types/request/spot-trading.js';
9
+ import { CancelAllOrdersRequest, CancelSpecifiedNumberHFOrdersRequest, CancelStopOrdersRequest, GetFillsRequest, GetHFCompletedOrdersRequest, GetHFFilledListRequest, GetOCOOrdersRequest, GetOrderListRequest, GetSpotKlinesRequest, GetStopOrdersListRequest, ModifyHFOrderRequest, SubmitHFOrderRequest, SubmitMultipleOrdersRequest, SubmitOCOOrderRequest, SubmitOrderRequest, SubmitStopOrderRequest } from './types/request/spot-trading.js';
10
10
  import { APISuccessResponse, ServiceStatus } from './types/response/shared.types.js';
11
11
  import { Account, AccountHFMarginTransactions, Balances, CreateSubAccount, CreateSubAPI, DeleteSubAccountAPI, SpotAccountSummary, SpotAccountTransaction, SpotAccountTransactions, SubAccountAPIInfo, SubAccountBalance, SubAccountBalancesV2, SubAccountInfo, SubAccountsV2, UpdateSubAPI } from './types/response/spot-account.js';
12
12
  import { EarnFixedIncomeHoldAssets, EarnProduct, GetEarnRedeemPreviewResponse, InitiateRedemptionResponse, SubscribeEarnFixedIncomeResponse } from './types/response/spot-earn.js';
13
- import { CreateDepositAddressV3Response, DepositAddress, DepositAddressV2, Deposits, HistoricalWithdrawalsV1, IsolatedMarginBalance, MarginAccountBalance, MarginBalance, TransferableFunds, V1HistoricalDeposits, WithdrawalQuotas, Withdrawals } from './types/response/spot-funding.js';
14
- import { HFMarginFilledOrder, HFMarginOrder, HFMarginTransactionRecord, IsolatedMarginAccountInfo, IsolatedMarginSymbolsConfig, LendingCurrencyV3, LendingRedemption, MarginConfigInfo, MarginHistoryRecord, MarginInterestRecords, MarginLevTokenInfo, MarginMarkPrice, MarginOrderV3, MarginRiskLimit, SingleIsolatedMarginAccountInfo, SubmitMarginOrderResponse } from './types/response/spot-margin-trading.js';
13
+ import { CreateDepositAddressV3Response, DepositAddress, DepositAddressV2, DepositAddressV3, Deposits, HistoricalWithdrawalsV1, IsolatedMarginBalance, MarginAccountBalance, MarginBalance, TransferableFunds, V1HistoricalDeposits, WithdrawalQuotas, Withdrawals } from './types/response/spot-funding.js';
14
+ import { HFMarginOrder, HFMarginTransactionRecord, IsolatedMarginAccountInfo, IsolatedMarginSymbolsConfig, LendingCurrencyV3, LendingRedemption, MarginActivePairsV3, MarginBorrowHistoryV3, MarginConfigInfo, MarginInterestRecords, MarginLevTokenInfo, MarginMarkPrice, MarginOrderV3, MarginRepayHistoryV3, MarginRiskLimit, MarginSubmitOrderV3Response, SingleIsolatedMarginAccountInfo, SubmitMarginOrderResponse } from './types/response/spot-margin-trading.js';
15
15
  import { Announcements } from './types/response/spot-misc.js';
16
- import { AutoCancelHFOrderSettingQueryResponse, CancelAllHFOrdersResponse, CurrencyInfo, HFFilledOrder, HFOrder, Kline, MultipleOrdersResponse, OCOOrderDetails, OCOOrderListItem, OCOOrders, OrderBookLevel, SpotOrder, SpotOrderFill, SpotOrderFills, SpotOrderList, StopOrderItem, StopOrders, SubmitHFOrderSyncResponse, SubmitMultipleHFOrdersResponse, SubmitMultipleHFOrdersSyncResponse, Symbol24hrStats, SymbolInfo, SyncCancelHFOrderResponse, Ticker, TradeHistory } from './types/response/spot-trading.js';
16
+ import { AllTickers, AutoCancelHFOrderSettingQueryResponse, CancelAllHFOrdersResponse, CurrencyInfo, HFFilledOrder, HFOrder, Kline, MultipleOrdersResponse, OCOOrderDetails, OCOOrderListItem, OCOOrders, OrderBookLevel, SpotOrder, SpotOrderFill, SpotOrderFills, SpotOrderList, StopOrderItem, StopOrders, SubmitHFOrderSyncResponse, SubmitMultipleHFOrdersResponse, SubmitMultipleHFOrdersSyncResponse, Symbol24hrStats, SymbolInfo, SyncCancelHFOrderResponse, Ticker, TradeHistory } from './types/response/spot-trading.js';
17
17
  import { OtcLoan, OtcLoanAccount } from './types/response/spot-vip.js';
18
18
  import { WsConnectionInfo } from './types/response/ws.js';
19
19
  /**
@@ -43,196 +43,283 @@ export declare class SpotClient extends BaseRestClient {
43
43
  generateNewOrderID(): string;
44
44
  getServerTime(): Promise<APISuccessResponse<number>>;
45
45
  getServiceStatus(): Promise<APISuccessResponse<ServiceStatus>>;
46
- getAnnouncements(params?: GetAnnouncementsRequest): Promise<APISuccessResponse<Announcements>>;
47
46
  /**
48
47
  *
49
- * REST - ACCOUNT - Basic Info
48
+ * REST - Account Info - Account & Funding
49
+ *
50
+ */
51
+ /**
52
+ * Get Account Summary Info
50
53
  *
54
+ * This endpoint can be used to obtain account summary information.
51
55
  */
52
56
  getAccountSummary(): Promise<APISuccessResponse<SpotAccountSummary>>;
57
+ /**
58
+ * Get API Key Information
59
+ *
60
+ * Get information about the API key being used. Works for both master and sub user API keys.
61
+ */
62
+ getApikeyInfo(): Promise<APISuccessResponse<{
63
+ remark: string;
64
+ apiKey: string;
65
+ apiVersion: number;
66
+ permission: string;
67
+ ipWhitelist: string;
68
+ createdAt: number;
69
+ uid: number;
70
+ isMaster: boolean;
71
+ }>>;
72
+ /**
73
+ * Get Account Type - Spot
74
+ *
75
+ * This endpoint determines whether the current user is a spot high-frequency user or a spot low-frequency user.
76
+ */
77
+ getUserType(): Promise<APISuccessResponse<boolean>>;
53
78
  /**
54
79
  * Get a list of acounts and their balance states (spot/margin/trade_hf)
55
80
  *
56
- * Get Account List - Spot/Margin/trade_hf
81
+ * Get Account List - Spot
82
+ */
83
+ getBalances(params?: GetBalancesRequest): Promise<APISuccessResponse<Balances[]>>;
84
+ /**
85
+ * Get Account Detail - Spot
86
+ *
87
+ * Get Information for a single spot account. Use this endpoint when you know the accountId.
57
88
  */
58
- getBalances(params?: GetBalancesRequest): Promise<Promise<APISuccessResponse<Balances[]>>>;
59
89
  getAccountDetail(params: {
60
90
  accountId: any;
61
91
  }): Promise<APISuccessResponse<Account>>;
92
+ /**
93
+ * Get Account - Cross Margin
94
+ *
95
+ * Request via this endpoint to get the info of the cross margin account.
96
+ */
97
+ getMarginBalance(params?: GetMarginBalanceRequest): Promise<APISuccessResponse<MarginBalance>>;
98
+ /**
99
+ * Get Account - Isolated Margin
100
+ *
101
+ * Request via this endpoint to get the info of the isolated margin account.
102
+ */
103
+ getIsolatedMarginBalance(params?: GetIsolatedMarginBalanceRequest): Promise<APISuccessResponse<IsolatedMarginBalance[]>>;
62
104
  /**
63
105
  * Get Account Ledgers - Spot/Margin
106
+ *
107
+ * This endpoint is for transaction records from all types of your accounts, supporting inquiry of various currencies.
108
+ * Items are paginated and sorted to show the latest first.
109
+ * See the Pagination section for retrieving additional entries after the first page.
64
110
  */
65
111
  getTransactions(params?: GetSpotTransactionsRequest): Promise<APISuccessResponse<SpotAccountTransactions>>;
66
112
  /**
67
113
  * Get Account Ledgers - trade_hf
114
+ *
115
+ * This API endpoint returns all transfer (in and out) records in high-frequency trading account and supports multi-coin queries.
116
+ * The query results are sorted in descending order by createdAt and id.
68
117
  */
69
118
  getHFTransactions(params: AccountHFTransactionsRequest): Promise<APISuccessResponse<SpotAccountTransaction[]>>;
70
119
  /**
71
120
  * Get Account Ledgers - margin_hf
121
+ *
122
+ * This API endpoint returns all transfer (in and out) records in high-frequency margin trading account and supports multi-coin queries.
123
+ * The query results are sorted in descending order by createdAt and id.
72
124
  */
73
125
  getHFMarginTransactions(params: AccountHFMarginTransactionsRequest): Promise<APISuccessResponse<AccountHFMarginTransactions[]>>;
74
126
  /**
75
127
  *
76
- * REST - ACCOUNT - Sub-Account
128
+ * REST - Account Info - Sub Account
77
129
  *
78
130
  */
79
131
  /**
80
- * @deprecated This method is deprecated.
81
- * It is recommended to use the GET /api/v2/sub/user endpoint instead of this endpoint
132
+ * Add SubAccount
133
+ *
134
+ * This endpoint is used to create a sub-account.
82
135
  */
83
- getSubAccountsV1(): Promise<APISuccessResponse<SubAccountInfo[]>>;
84
- getSubAccountsV2(params?: {
85
- currentPage?: number;
86
- pageSize?: number;
87
- }): Promise<APISuccessResponse<SubAccountsV2>>;
88
136
  createSubAccount(params: CreateSubAccountRequest): Promise<APISuccessResponse<CreateSubAccount>>;
137
+ /**
138
+ * Add SubAccount Margin Permission
139
+ *
140
+ * This endpoint can be used to add sub-accounts Margin permission.
141
+ * Before using this endpoints, you need to ensure that the master account apikey has Margin permissions and the Margin function has been activated.
142
+ */
89
143
  enableSubAccountMargin(params: {
90
144
  uid: string;
91
- }): Promise<void>;
145
+ }): Promise<boolean | null>;
146
+ /**
147
+ * Add SubAccount Futures Permission
148
+ *
149
+ * This endpoint can be used to add sub-accounts Futures permission.
150
+ * Before using this endpoints, you need to ensure that the master account apikey has Futures permissions and the Futures function has been activated.
151
+ */
92
152
  enableSubAccountFutures(params: {
93
153
  uid: string;
94
- }): Promise<void>;
154
+ }): Promise<boolean | null>;
155
+ /**
156
+ * Get SubAccount List - Summary Info
157
+ *
158
+ * This endpoint can be used to get a paginated list of sub-accounts. Pagination is required.
159
+ */
160
+ getSubAccountsV2(params?: {
161
+ currentPage?: number;
162
+ pageSize?: number;
163
+ }): Promise<APISuccessResponse<SubAccountsV2>>;
95
164
  /**
96
165
  * @deprecated This method is deprecated.
97
- * It is recommended to use the GET /api/v2/sub/accounts/balance endpoint instead of this endpoint
166
+ * It is recommended to use the getSubAccountBalancesV2() endpoint instead of this endpoint
98
167
  */
99
168
  getSubAccountBalance(params: {
100
169
  subUserId: string;
101
170
  includeBaseAmount: boolean;
102
171
  }): Promise<APISuccessResponse<SubAccountBalance>>;
103
- getSubAccountBalancesV1(): Promise<APISuccessResponse<SubAccountBalance>>;
172
+ /**
173
+ * Get SubAccount List - Spot Balance(V2)
174
+ *
175
+ * This endpoint can be used to get paginated Spot sub-account information.
176
+ * Pagination is required.
177
+ */
104
178
  getSubAccountBalancesV2(params?: {
105
179
  currentPage?: number;
106
180
  pageSize?: number;
107
181
  }): Promise<APISuccessResponse<SubAccountBalancesV2>>;
108
182
  /**
109
183
  *
110
- * REST - ACCOUNT - Sub-Account API
184
+ * REST - Account Info - Sub Account API
111
185
  *
186
+ */
187
+ /**
188
+ * Add SubAccount API
112
189
  *
190
+ * This endpoint can be used to create APIs for sub-accounts.
113
191
  */
114
- getSubAPIs(params: {
115
- apiKey?: string;
116
- subName: string;
117
- }): Promise<APISuccessResponse<SubAccountAPIInfo[]>>;
118
192
  createSubAPI(params: CreateSubAccountAPIRequest): Promise<APISuccessResponse<CreateSubAPI>>;
119
- updateSubAPI(params: UpdateSubAccountAPIRequest): Promise<APISuccessResponse<UpdateSubAPI>>;
120
- deleteSubAPI(params: DeleteSubAccountAPIRequest): Promise<APISuccessResponse<DeleteSubAccountAPI>>;
121
193
  /**
194
+ * Modify SubAccount API
122
195
  *
123
- * REST - FUNDING - Funding overview
196
+ * This endpoint can be used to update APIs for sub-accounts.
197
+ */
198
+ updateSubAPI(params: UpdateSubAccountAPIRequest): Promise<APISuccessResponse<UpdateSubAPI>>;
199
+ /**
200
+ * Get SubAccount API List
124
201
  *
202
+ * This endpoint can be used to obtain a list of APIs pertaining to a sub-account.
203
+ * (Not contain ND Broker Sub Account)
125
204
  */
205
+ getSubAPIs(params: {
206
+ apiKey?: string;
207
+ subName: string;
208
+ }): Promise<APISuccessResponse<SubAccountAPIInfo[]>>;
126
209
  /**
127
- * @deprecated This method is deprecated.
128
- * It is recommended to use the GET /api/v3/margin/accounts endpoint instead of this endpoint
210
+ * Delete SubAccount API
211
+ *
212
+ * This endpoint can be used to delete an API for a sub-account.
129
213
  */
130
- getMarginBalances(): Promise<APISuccessResponse<{
131
- debtRatio: string;
132
- accounts: MarginAccountBalance[];
133
- }>>;
134
- getMarginBalance(params?: GetMarginBalanceRequest): Promise<APISuccessResponse<MarginBalance>>;
135
- getIsolatedMarginBalance(params?: GetIsolatedMarginBalanceRequest): Promise<APISuccessResponse<IsolatedMarginBalance[]>>;
214
+ deleteSubAPI(params: DeleteSubAccountAPIRequest): Promise<APISuccessResponse<DeleteSubAccountAPI>>;
136
215
  /**
137
216
  *
138
- * REST - FUNDING -Deposit
217
+ * REST - Account Info - Deposit
139
218
  *
140
219
  */
141
220
  /**
142
- * @deprecated This method is deprecated. Please use createDepositAddressV3 instead.
221
+ * Add Deposit Address(V3)
222
+ *
223
+ * Request via this endpoint to create a deposit address for a currency you intend to deposit.
143
224
  */
144
- createDepositAddress(params: {
145
- currency: string;
146
- chain?: string;
147
- }): Promise<APISuccessResponse<DepositAddress>>;
148
225
  createDepositAddressV3(params: CreateDepositAddressV3Request): Promise<APISuccessResponse<CreateDepositAddressV3Response>>;
149
226
  /**
150
- * @deprecated This method is deprecated. Please use getDepositAddressesV3 instead.
151
- */
152
- getDepositAddressesV2(params: {
153
- currency: string;
154
- }): Promise<APISuccessResponse<DepositAddressV2[]>>;
155
- /**
156
- * @deprecated This method is deprecated. Please use getDepositAddressesV3 instead.
227
+ * Get Deposit Address(V3)
228
+ *
229
+ * Get all deposit addresses for the currency you intend to deposit.
230
+ * If the returned data is empty, you may need to Add Deposit Address first.
157
231
  */
158
- getDepositAddressV1(params: {
159
- currency: string;
160
- chain?: string;
161
- }): Promise<APISuccessResponse<DepositAddress>>;
162
232
  getDepositAddressesV3(params: {
163
233
  currency: string;
164
234
  amount?: string;
165
235
  chain?: string;
166
- }): Promise<APISuccessResponse<DepositAddress[]>>;
167
- getDeposits(params?: GetDepositsRequest): Promise<APISuccessResponse<Deposits>>;
236
+ }): Promise<APISuccessResponse<DepositAddressV3[]>>;
168
237
  /**
169
- * @deprecated This method is deprecated.
170
- * It is recommended to use the GET /api/v1/deposits endpoint instead of this endpoint
238
+ * Get Deposit History
239
+ *
240
+ * Request via this endpoint to get deposit list Items are paginated and sorted to show the latest first.
241
+ * See the Pagination section for retrieving additional entries after the first page.
171
242
  */
172
- getHistoricalDepositsV1(params?: GetDepositsRequest): Promise<APISuccessResponse<V1HistoricalDeposits>>;
243
+ getDeposits(params?: GetDepositsRequest): Promise<APISuccessResponse<Deposits>>;
173
244
  /**
174
245
  *
175
- * REST - FUNDING -Withdrawals
246
+ * REST - Account Info - Withdrawals
176
247
  *
177
248
  */
178
- getWithdrawals(params?: GetWithdrawalsRequest): Promise<APISuccessResponse<Withdrawals>>;
179
249
  /**
180
- * @deprecated This method is deprecated.
181
- * It is recommended to use the GET /api/v1/withdrawals endpoint instead of this endpoint
250
+ * Get Withdrawal Quotas
251
+ *
252
+ * This endpoint can obtain the withdrawal quotas information of this currency.
182
253
  */
183
- getHistoricalWithdrawalsV1(params?: GetWithdrawalsRequest): Promise<APISuccessResponse<HistoricalWithdrawalsV1>>;
184
254
  getWithdrawalQuotas(params: {
185
255
  currency: string;
186
256
  chain?: string;
187
257
  }): Promise<APISuccessResponse<WithdrawalQuotas>>;
188
258
  /**
189
- * @deprecated This method is deprecated. Please use submitWithdrawV3 instead.
259
+ * Withdraw(V3)
260
+ *
261
+ * Use this endpoint to withdraw the specified currency
190
262
  */
191
- submitWithdraw(params: ApplyWithdrawRequest): Promise<APISuccessResponse<{
192
- withdrawalId: string;
193
- }>>;
194
263
  submitWithdrawV3(params: SubmitWithdrawV3Request): Promise<APISuccessResponse<{
195
264
  withdrawalId: string;
196
265
  }>>;
266
+ /**
267
+ * Cancel Withdrawal
268
+ *
269
+ * This endpoint can cancel the withdrawal, Only withdrawals requests of PROCESSING status could be canceled.
270
+ */
197
271
  cancelWithdrawal(params: {
198
272
  withdrawalId: string;
199
- }): Promise<APISuccessResponse<{
200
- withdrawalId: string;
201
- }>>;
273
+ }): Promise<APISuccessResponse<string | null>>;
202
274
  /**
275
+ * Get Withdrawal History
203
276
  *
204
- * REST - FUNDING - Transfer
277
+ * Request via this endpoint to get withdrawal list Items are paginated and sorted to show the latest first.
278
+ * See the Pagination section for retrieving additional entries after the first page.
279
+ */
280
+ getWithdrawals(params?: GetWithdrawalsRequest): Promise<APISuccessResponse<Withdrawals>>;
281
+ /**
282
+ *
283
+ * REST - Account Info - Transfer
205
284
  *
206
285
  */
207
- getTransferable(params: GetTransferableRequest): Promise<APISuccessResponse<TransferableFunds>>;
208
- submitFlexTransfer(params: FlexTransferRequest): Promise<APISuccessResponse<{
209
- orderId: string;
210
- }>>;
211
286
  /**
212
- * @deprecated This method is deprecated.
213
- * It is recommended to use the GET /api/v3/accounts/universal-transfer endpoint instead of this endpoint
287
+ * Get Transfer Quotas
288
+ *
289
+ * This endpoint returns the transferable balance of a specified account.
214
290
  */
215
- submitTransferMasterSub(params: submitTransferMasterSubRequest): Promise<APISuccessResponse<{
216
- orderId: string;
217
- }>>;
291
+ getTransferable(params: GetTransferableRequest): Promise<APISuccessResponse<TransferableFunds>>;
218
292
  /**
219
- * @deprecated This method is deprecated.
220
- * It is recommended to use the GET /api/v3/accounts/universal-transfer endpoint instead of this endpoint
293
+ * Flex Transfer
294
+ *
295
+ * This endpoint can be used for transfers between master and sub accounts and inner transfers
221
296
  */
222
- submitInnerTransfer(params: InnerTransferRequest): Promise<APISuccessResponse<{
297
+ submitFlexTransfer(params: FlexTransferRequest): Promise<APISuccessResponse<{
223
298
  orderId: string;
224
299
  }>>;
225
300
  /**
226
301
  *
227
- * REST - FUNDING - Trade Fee
302
+ * REST - Account Info - Trade Fee
303
+ *
304
+ */
305
+ /**
306
+ * Get Basic Fee - Spot/Margin
228
307
  *
308
+ * This endpoint is for the spot/margin basic fee rate of users
229
309
  */
230
310
  getBasicUserFee(params: {
231
- currencyType: string;
311
+ currencyType: number;
232
312
  }): Promise<APISuccessResponse<{
233
313
  takerFeeRate: string;
234
314
  makerFeeRate: string;
235
315
  }>>;
316
+ /**
317
+ * Get Actual Fee - Spot/Margin
318
+ *
319
+ * This endpoint is for the actual fee rate of the trading pair.
320
+ * You can inquire about fee rates of 10 trading pairs each time at most.
321
+ * The fee rate of your sub-account is the same as that of the master account.
322
+ */
236
323
  getTradingPairFee(params: {
237
324
  symbol: string;
238
325
  }): Promise<APISuccessResponse<{
@@ -242,241 +329,339 @@ export declare class SpotClient extends BaseRestClient {
242
329
  }[]>>;
243
330
  /**
244
331
  *
245
- * REST - SPOT TRADING -Market data
332
+ * REST - SPOT TRADING - Market Data
246
333
  *
247
334
  */
248
- getCurrencies(): Promise<APISuccessResponse<CurrencyInfo[]>>;
335
+ /**
336
+ * Get Announcements
337
+ *
338
+ * This endpoint can obtain the latest news announcements, and the default page search is for announcements within a month.
339
+ */
340
+ getAnnouncements(params?: GetAnnouncementsRequest): Promise<APISuccessResponse<Announcements>>;
341
+ /**
342
+ * Get Currency
343
+ *
344
+ * Request via this endpoint to get the currency details of a specified currency.
345
+ */
249
346
  getCurrency(params: {
250
347
  currency: string;
251
348
  chain?: string;
252
349
  }): Promise<APISuccessResponse<CurrencyInfo>>;
253
- getSymbols(params?: {
254
- market?: string;
255
- }): Promise<APISuccessResponse<SymbolInfo[]>>;
350
+ /**
351
+ * Get All Currencies
352
+ *
353
+ * Request via this endpoint to get the currency list. Not all currencies currently can be used for trading.
354
+ */
355
+ getCurrencies(): Promise<APISuccessResponse<CurrencyInfo[]>>;
356
+ /**
357
+ * Get Symbol
358
+ *
359
+ * Request via this endpoint to get detail currency pairs for trading.
360
+ * If you want to get the market information of the trading symbol, please use Get All Tickers.
361
+ */
256
362
  getSymbol(params: {
257
363
  symbol: string;
258
364
  }): Promise<APISuccessResponse<SymbolInfo>>;
365
+ /**
366
+ * Get All Symbols
367
+ *
368
+ * Request via this endpoint to get detail currency pairs for trading.
369
+ * If you want to get the market information of the trading symbol, please use Get All Tickers.
370
+ */
371
+ getSymbols(params?: {
372
+ market?: string;
373
+ }): Promise<APISuccessResponse<SymbolInfo[]>>;
374
+ /**
375
+ * Get Ticker
376
+ *
377
+ * Request via this endpoint to get Level 1 Market Data.
378
+ * The returned value includes the best bid price and size,
379
+ * the best ask price and size as well as the last traded price and the last traded size.
380
+ */
259
381
  getTicker(params: {
260
382
  symbol: string;
261
383
  }): Promise<APISuccessResponse<Ticker>>;
262
- getTickers(): Promise<APISuccessResponse<{
263
- time: number;
264
- ticker: Ticker[];
265
- }>>;
266
- get24hrStats(params: {
384
+ /**
385
+ * Get All Tickers
386
+ *
387
+ * Request market tickers for all the trading pairs in the market (including 24h volume), takes a snapshot every 2 seconds.
388
+ */
389
+ getTickers(): Promise<APISuccessResponse<AllTickers>>;
390
+ /**
391
+ * Get Trade History
392
+ *
393
+ * Request via this endpoint to get the trade history of the specified symbol,
394
+ * the returned quantity is the last 100 transaction records.
395
+ */
396
+ getTradeHistories(params: {
267
397
  symbol: string;
268
- }): Promise<APISuccessResponse<Symbol24hrStats>>;
269
- getMarkets(): Promise<APISuccessResponse<string[]>>;
398
+ }): Promise<APISuccessResponse<TradeHistory[]>>;
399
+ /**
400
+ * Get Klines
401
+ *
402
+ * Get the Kline of the symbol.
403
+ * Data are returned in grouped buckets based on requested type.
404
+ */
405
+ getKlines(params: GetSpotKlinesRequest): Promise<APISuccessResponse<Kline[]>>;
406
+ /**
407
+ * Get Part OrderBook
408
+ *
409
+ * Query for part orderbook depth data. Level 20(aggregated by price)
410
+ */
270
411
  getOrderBookLevel20(params: {
271
412
  symbol: string;
272
413
  }): Promise<APISuccessResponse<OrderBookLevel>>;
414
+ /**
415
+ * Get Part OrderBook
416
+ *
417
+ * Query for part orderbook depth data. Level 100(aggregated by price)
418
+ */
273
419
  getOrderBookLevel100(params: {
274
420
  symbol: string;
275
421
  }): Promise<APISuccessResponse<OrderBookLevel>>;
422
+ /**
423
+ * Get Full OrderBook
424
+ *
425
+ * Query for full orderbook depth data. (aggregated by price)
426
+ */
276
427
  getFullOrderBook(params: {
277
428
  symbol: string;
278
429
  }): Promise<APISuccessResponse<OrderBookLevel>>;
279
- getTradeHistories(params: {
280
- symbol: string;
281
- }): Promise<APISuccessResponse<TradeHistory[]>>;
282
- getKlines(params: GetSpotKlinesRequest): Promise<APISuccessResponse<Kline[]>>;
430
+ /**
431
+ * Get Fiat Price
432
+ *
433
+ * Request via this endpoint to get the fiat price of the currencies for the available trading pairs.
434
+ */
283
435
  getFiatPrice(params?: {
284
436
  base?: string;
285
437
  currencies?: string;
286
438
  }): Promise<any>;
439
+ /**
440
+ * Get 24hr Stats
441
+ *
442
+ * Request via this endpoint to get the statistics of the specified ticker in the last 24 hours.
443
+ */
444
+ get24hrStats(params: {
445
+ symbol: string;
446
+ }): Promise<APISuccessResponse<Symbol24hrStats>>;
447
+ /**
448
+ * Get Market List
449
+ *
450
+ * Request via this endpoint to get the transaction currency for the entire trading market.
451
+ */
452
+ getMarkets(): Promise<APISuccessResponse<string[]>>;
287
453
  /**
288
454
  *
289
- * REST - SPOT TRADING - Spot HF trade
455
+ * REST - SPOT TRADING - Orders
290
456
  *
291
457
  */
292
- getUserType(): Promise<APISuccessResponse<boolean>>;
458
+ /**
459
+ * Add Order
460
+ *
461
+ * Place order to the Spot trading system, you can place two major types of orders: limit and market.
462
+ * Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order.
463
+ * The amount of funds on hold depends on the order type and parameters specified.
464
+ */
293
465
  submitHFOrder(params: SubmitHFOrderRequest): Promise<APISuccessResponse<{
294
466
  orderId: string;
295
467
  clientOid: string;
296
468
  }>>;
297
- submitHFOrderTest(): Promise<any>;
469
+ /**
470
+ * Add Order Sync
471
+ *
472
+ * Place order to the spot trading system
473
+ *
474
+ * The difference between this endpoint and "SubmitHFOrder()" is that this endpoint will synchronously return the order information after the order matching is completed.
475
+ */
298
476
  submitHFOrderSync(params: SubmitHFOrderRequest): Promise<APISuccessResponse<SubmitHFOrderSyncResponse>>;
477
+ /**
478
+ * Add Order Test
479
+ *
480
+ * Order test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint,
481
+ * and can be used to verify whether the signature is correct and other operations. After placing an order, the order will not enter the matching system, and the order cannot be queried.
482
+ */
483
+ submitHFOrderTest(params: SubmitHFOrderRequest): Promise<any>;
484
+ /**
485
+ * Batch Add Orders
486
+ *
487
+ * This endpoint supports sequential batch order placement from a single endpoint. A maximum of 20 orders can be placed simultaneously.
488
+ */
299
489
  submitHFMultipleOrders(params: {
300
- orderList: SubmitMultipleHFOrdersRequest[];
490
+ orderList: SubmitHFOrderRequest[];
301
491
  }): Promise<APISuccessResponse<SubmitMultipleHFOrdersResponse[]>>;
492
+ /**
493
+ * Batch Add Orders Sync
494
+ *
495
+ * This endpoint supports sequential batch order placement from a single endpoint. A maximum of 20 orders can be placed simultaneously.
496
+ * The difference between this endpoint and "submitHFMultipleOrders()" is that this endpoint will synchronously return the order information after the order matching is completed.
497
+ */
302
498
  submitHFMultipleOrdersSync(params: {
303
- orderList: SubmitMultipleHFOrdersRequest[];
499
+ orderList: SubmitHFOrderRequest[];
304
500
  }): Promise<APISuccessResponse<SubmitMultipleHFOrdersSyncResponse[]>>;
305
- updateHFOrder(params: ModifyHFOrderRequest): Promise<APISuccessResponse<{
306
- newOrderId: string;
307
- clientOid: string;
308
- }>>;
501
+ /**
502
+ * Cancel Order By OrderId
503
+ *
504
+ * This endpoint can be used to cancel a spot order by orderId.
505
+ * This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.
506
+ */
309
507
  cancelHFOrder(params: {
310
508
  orderId: string;
311
509
  symbol: string;
312
510
  }): Promise<APISuccessResponse<{
313
511
  orderId: string;
314
512
  }>>;
513
+ /**
514
+ * Cancel Order By OrderId Sync
515
+ *
516
+ * This endpoint can be used to cancel a spot order by orderId.
517
+ * The difference between this endpoint and "cancelHFOrder()" is that this endpoint will synchronously return the order information after the order canceling is completed.
518
+ */
315
519
  cancelHFOrderSync(params: {
316
520
  orderId: string;
317
521
  symbol: string;
318
522
  }): Promise<APISuccessResponse<SyncCancelHFOrderResponse>>;
523
+ /**
524
+ * Cancel Order By ClientOid
525
+ *
526
+ * This endpoint can be used to cancel a spot order by clientOid.
527
+ * This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.
528
+ */
319
529
  cancelHFOrderByClientOId(params: {
320
530
  clientOid: string;
321
531
  symbol: string;
322
532
  }): Promise<APISuccessResponse<{
323
533
  clientOid: string;
324
534
  }>>;
535
+ /**
536
+ * Cancel Order By ClientOid Sync
537
+ *
538
+ * This endpoint can be used to cancel a spot order by clientOid.
539
+ * The difference between this endpoint and "cancelHFOrderByClientOId()" is that this endpoint will synchronously return the order information after the order canceling is completed.
540
+ */
325
541
  cancelHFOrderSyncByClientOId(params: {
326
542
  clientOid: string;
327
543
  symbol: string;
328
544
  }): Promise<APISuccessResponse<SyncCancelHFOrderResponse>>;
329
- cancelHFOrdersNumber(params: CancelSpecifiedNumberHFOrdersRequest): Promise<any>;
330
- cancelHFAllOrdersBySymbol(params: {
331
- symbol: string;
332
- }): Promise<APISuccessResponse<{
545
+ /**
546
+ * Cancel Partial Order
547
+ *
548
+ * This endpoint can cancel the specified quantity of the order according to the orderId.
549
+ */
550
+ cancelHFOrdersNumber(params: CancelSpecifiedNumberHFOrdersRequest): Promise<{
333
551
  orderId: string;
334
552
  cancelSize: string;
335
- }>>;
336
- cancelHFAllOrders(): Promise<APISuccessResponse<CancelAllHFOrdersResponse>>;
337
- getHFActiveOrders(params: {
553
+ }>;
554
+ /**
555
+ * Cancel All Orders By Symbol
556
+ *
557
+ * This endpoint can cancel all spot orders for specific symbol.
558
+ */
559
+ cancelHFAllOrdersBySymbol(params: {
338
560
  symbol: string;
339
- }): Promise<APISuccessResponse<HFOrder[]>>;
340
- getHFActiveSymbols(): Promise<APISuccessResponse<{
341
- symbols: string[];
342
- }>>;
343
- getHFCompletedOrders(params: GetHFCompletedOrdersRequest): Promise<APISuccessResponse<{
344
- lastId: number;
345
- items: HFOrder[];
561
+ }): Promise<APISuccessResponse<string>>;
562
+ /**
563
+ * Cancel All Orders
564
+ *
565
+ * This endpoint can cancel all spot orders for all symbol.
566
+ */
567
+ cancelHFAllOrders(): Promise<APISuccessResponse<CancelAllHFOrdersResponse>>;
568
+ /**
569
+ * Modify Order
570
+ *
571
+ * This endpoint can modify the price and quantity of the order according to orderId or clientOid.
572
+ */
573
+ updateHFOrder(params: ModifyHFOrderRequest): Promise<APISuccessResponse<{
574
+ newOrderId: string;
575
+ clientOid: string;
346
576
  }>>;
577
+ /**
578
+ * Get Order By OrderId
579
+ *
580
+ * This endpoint can be used to obtain information for a single Spot order using the order id.
581
+ */
347
582
  getHFOrderDetailsByOrderId(params: {
348
583
  orderId: string;
349
584
  symbol: string;
350
585
  }): Promise<APISuccessResponse<HFOrder>>;
586
+ /**
587
+ * Get Order By ClientOid
588
+ *
589
+ * This endpoint can be used to obtain information for a single Spot order using the clientOid.
590
+ */
351
591
  getHFOrderDetailsByClientOid(params: {
352
592
  clientOid: string;
353
593
  symbol: string;
354
594
  }): Promise<APISuccessResponse<HFOrder>>;
355
- cancelHFOrderAutoSetting(params: {
356
- timeout: number;
357
- symbols?: string;
358
- }): Promise<APISuccessResponse<{
359
- currentTime: number;
360
- triggerTime: number;
361
- }>>;
362
- cancelHFOrderAutoSettingQuery(): Promise<APISuccessResponse<AutoCancelHFOrderSettingQueryResponse>>;
363
- getHFFilledOrders(params: GetHFFilledListRequest): Promise<APISuccessResponse<{
364
- items: HFFilledOrder[];
365
- lastId: number;
366
- }>>;
367
595
  /**
596
+ * Get Symbols With Open Order
368
597
  *
369
- * REST - SPOT TRADING - Orders
370
- *
371
- */
372
- /**
373
- * @deprecated This method is deprecated.
374
- * It is recommended to use the POST /api/v1/hf/orders endpoint instead of this endpoint
598
+ * This endpoint can query all spot symbol that has active orders
375
599
  */
376
- submitOrder(params: SubmitOrderRequest): Promise<APISuccessResponse<{
377
- orderId: string;
600
+ getHFActiveSymbols(): Promise<APISuccessResponse<{
601
+ symbols: string[];
378
602
  }>>;
379
603
  /**
380
- * @deprecated This method is deprecated.
381
- * It is recommended to use the POST /api/v1/hf/orders/test endpoint instead of this endpoint
382
- */
383
- submitOrderTest(): Promise<any>;
384
- /**
385
- * @deprecated This method is deprecated.
386
- * It is recommended to use the POST /api/v1/hf/orders/multi endpoint instead of this endpoint
604
+ * Get Open Orders
605
+ *
606
+ * This endpoint is to obtain all Spot active order lists, and the return value of the active order endpoint is the paged data of all uncompleted order lists.
607
+ * The returned data is sorted in descending order according to the latest update time of the order.
387
608
  */
388
- submitMultipleOrders(params: {
609
+ getHFActiveOrders(params: {
389
610
  symbol: string;
390
- orderList: SubmitMultipleOrdersRequest[];
391
- }): Promise<APISuccessResponse<MultipleOrdersResponse[]>>;
392
- /**
393
- * @deprecated This method is deprecated.
394
- * It is recommended to use the DELETE /api/v1/hf/orders/{orderId} endpoint instead of this endpoint
395
- */
396
- cancelOrderById(params: {
397
- orderId: string;
398
- }): Promise<APISuccessResponse<{
399
- cancelledOrderIds: string[];
400
- }>>;
611
+ }): Promise<APISuccessResponse<HFOrder[]>>;
401
612
  /**
402
- * @deprecated This method is deprecated.
403
- * It is recommended to use the DELETE /api/v1/hf/orders/client-order/{params.clientOid} endpoint instead of this endpoint
613
+ * Get Closed Orders
614
+ *
615
+ * This endpoint is to obtain all Spot completed order lists, and the return value of the completed order endpoint is the paged data of all completed order lists.
616
+ * The returned data is sorted in descending order according to the latest update time of the order.
404
617
  */
405
- cancelOrderByClientOid(params: {
406
- clientOid: string;
407
- }): Promise<APISuccessResponse<{
408
- cancelledOrderId: string;
409
- clientOid: string;
618
+ getHFCompletedOrders(params: GetHFCompletedOrdersRequest): Promise<APISuccessResponse<{
619
+ lastId: number;
620
+ items: HFOrder[];
410
621
  }>>;
411
622
  /**
412
- * @deprecated This method is deprecated.
413
- * It is recommended to use the DELETE /api/v1/hf/orders/cancelAll endpoint instead of this endpoint
623
+ * Get Trade History
624
+ *
625
+ * This endpoint can be used to obtain a list of the latest Spot transaction details.
414
626
  */
415
- cancelAllOrders(params?: CancelAllOrdersRequest): Promise<APISuccessResponse<{
416
- cancelledOrderIds: string[];
627
+ getHFFilledOrders(params: GetHFFilledListRequest): Promise<APISuccessResponse<{
628
+ items: HFFilledOrder[];
629
+ lastId: number;
417
630
  }>>;
418
631
  /**
419
- * @deprecated This method is deprecated.
420
- * It is recommended to use the GET /api/v1/hf/orders/active endpoint instead of this endpoint
421
- */
422
- getOrders(params?: GetOrderListRequest): Promise<APISuccessResponse<SpotOrderList>>;
423
- /**
424
- * @deprecated This method is deprecated.
425
- * It is recommended to use the GET /api/v1/hf/orders/active endpoint instead of this endpoint
426
- */
427
- getRecentOrders(params?: {
428
- currentPage?: number;
429
- pageSize?: number;
430
- }): Promise<APISuccessResponse<SpotOrder[]>>;
431
- /**
432
- * @deprecated This method is deprecated.
433
- * It is recommended to use the GET /api/v1/hf/orders/{params.orderId} endpoint instead of this endpoint
434
- */
435
- getOrderByOrderId(params: {
436
- orderId: string;
437
- }): Promise<APISuccessResponse<SpotOrder>>;
438
- /**
439
- * @deprecated This method is deprecated.
440
- * It is recommended to use the GET /api/v1/hf/orders/client-order/{params.clientOid} endpoint instead of this endpoint
441
- */
442
- getOrderByClientOid(params: {
443
- clientOid: string;
444
- }): Promise<APISuccessResponse<SpotOrder>>;
445
- /**
632
+ * Get DCP
446
633
  *
447
- * REST - SPOT TRADING -Fills
448
- *
449
- */
450
- /**
451
- * @deprecated This method is deprecated.
452
- * It is recommended to use the GET /api/v1/hf/fills endpoint instead of this endpoint
453
- */
454
- getFills(params?: GetFillsRequest): Promise<APISuccessResponse<SpotOrderFills>>;
455
- /**
456
- * @deprecated This method is deprecated.
457
- * It is recommended to use the GET /api/v1/hf/fills endpoint instead of this endpoint
634
+ * Get Disconnection Protect(Deadman Swich)
635
+ * Through this endpoint, you can query the settings of automatic order cancellation
458
636
  */
459
- getRecentFills(): Promise<APISuccessResponse<SpotOrderFill[]>>;
637
+ cancelHFOrderAutoSettingQuery(): Promise<APISuccessResponse<AutoCancelHFOrderSettingQueryResponse>>;
460
638
  /**
639
+ * Set DCP
461
640
  *
462
- * REST - SPOT TRADING - Stop order
463
- *
641
+ * Set Disconnection Protect(Deadman Swich)
642
+ * Through this endpoint, Call this endpoint to automatically cancel all orders of the set trading pair after the specified time.
643
+ * If this endpoint is not called again for renewal or cancellation before the set time, the system will help the user to cancel the order of the corresponding trading pair. Otherwise it will not.
464
644
  */
465
- submitStopOrder(params: SubmitStopOrderRequest): Promise<APISuccessResponse<{
466
- orderId: string;
645
+ cancelHFOrderAutoSetting(params: {
646
+ timeout: number;
647
+ symbols?: string;
648
+ }): Promise<APISuccessResponse<{
649
+ currentTime: number;
650
+ triggerTime: number;
467
651
  }>>;
468
652
  /**
469
- * Cancels a single stop order by orderId. Applicable for both spot and margin trading.
653
+ * Add Stop Order
470
654
  *
471
- * This endpoint requires the "Spot Trading" or "Margin Trading" permission on your API key.
655
+ * Place stop order to the Spot trading system.
472
656
  */
473
- cancelStopOrderById(params: {
657
+ submitStopOrder(params: SubmitStopOrderRequest): Promise<APISuccessResponse<{
474
658
  orderId: string;
475
- }): Promise<APISuccessResponse<{
476
- cancelledOrderIds: string[];
659
+ clientOid: string;
477
660
  }>>;
478
661
  /**
479
- * Cancels a stop order by clientOid. Requires "Spot Trading" or "Margin Trading" permission.
662
+ * Cancel Stop Order By ClientOid
663
+ *
664
+ * This endpoint can be used to cancel a spot stop order by clientOid.
480
665
  */
481
666
  cancelStopOrderByClientOid(params: {
482
667
  clientOid: string;
@@ -486,38 +671,60 @@ export declare class SpotClient extends BaseRestClient {
486
671
  clientOid: string;
487
672
  }>>;
488
673
  /**
489
- * Cancels a batch of stop orders. Requires "Spot Trading" or "Margin Trading" permission.
674
+ * Cancel Stop Order By OrderId
675
+ *
676
+ * Request via this endpoint to cancel a single stop order previously placed.
677
+ */
678
+ cancelStopOrderById(params: {
679
+ orderId: string;
680
+ }): Promise<APISuccessResponse<{
681
+ cancelledOrderIds: string[];
682
+ }>>;
683
+ /**
684
+ * Batch Cancel Stop Orders
685
+ *
686
+ * Request via this endpoint to cancel a batch of stop orders.
490
687
  */
491
688
  cancelStopOrders(params?: CancelStopOrdersRequest): Promise<APISuccessResponse<{
492
689
  cancelledOrderIds: string[];
493
690
  }>>;
494
691
  /**
495
- * Retrieves your current untriggered stop order list, paginated and sorted to show the latest first.
692
+ * Get Stop Orders List
693
+ *
694
+ * Request via this endpoint to get your current untriggered stop order list.
496
695
  */
497
696
  getStopOrders(params?: GetStopOrdersListRequest): Promise<APISuccessResponse<StopOrders>>;
498
697
  /**
499
- * Retrieves the details of a single stop order by its orderId.
698
+ * Get Stop Order By OrderId
699
+ *
700
+ * Request via this endpoint to get a stop order information via the order ID.
701
+
702
+
500
703
  */
501
704
  getStopOrderByOrderId(params: {
502
705
  orderId: string;
503
706
  }): Promise<APISuccessResponse<StopOrderItem>>;
504
707
  /**
505
- * Retrieves the details of a single stop order by its clientOid.
708
+ * Get Stop Order By ClientOid
709
+ *
710
+ *
506
711
  */
507
712
  getStopOrderByClientOid(params: {
508
713
  clientOid: string;
509
714
  symbol?: string;
510
715
  }): Promise<APISuccessResponse<StopOrderItem[]>>;
511
716
  /**
717
+ * Add OCO Order
512
718
  *
513
- * REST - SPOT TRADING - OCO order
514
- *
719
+ * Place OCO order to the Spot trading system
515
720
  */
516
721
  submitOCOOrder(params: SubmitOCOOrderRequest): Promise<APISuccessResponse<{
517
722
  orderId: string;
518
723
  }>>;
519
724
  /**
520
- * Cancels a single OCO order by orderId.
725
+ * Cancel OCO Order By OrderId
726
+ *
727
+ * Request via this endpoint to cancel a single oco order previously placed.
521
728
  */
522
729
  cancelOCOOrderById(params: {
523
730
  orderId: string;
@@ -525,7 +732,9 @@ export declare class SpotClient extends BaseRestClient {
525
732
  cancelledOrderIds: string[];
526
733
  }>>;
527
734
  /**
528
- * Cancels a single OCO order by clientOid.
735
+ * Cancel OCO Order By ClientOid
736
+ *
737
+ * Request via this endpoint to cancel a single oco order previously placed.
529
738
  */
530
739
  cancelOCOOrderByClientOid(params: {
531
740
  clientOid: string;
@@ -533,7 +742,9 @@ export declare class SpotClient extends BaseRestClient {
533
742
  cancelledOrderIds: string[];
534
743
  }>>;
535
744
  /**
536
- * Batch cancels OCO orders through orderIds.
745
+ * Batch Cancel OCO Order
746
+ *
747
+ * This endpoint can batch cancel OCO orders through orderIds.
537
748
  */
538
749
  cancelMultipleOCOOrders(params?: {
539
750
  orderIds?: string;
@@ -542,66 +753,138 @@ export declare class SpotClient extends BaseRestClient {
542
753
  cancelledOrderIds: string[];
543
754
  }>>;
544
755
  /**
545
- * Retrieves the details of a single OCO order by its orderId.
756
+ * Get OCO Order By OrderId
757
+ *
758
+ * Request via this endpoint to get a oco order information via the order ID.
546
759
  */
547
760
  getOCOOrderByOrderId(params: {
548
761
  orderId: string;
549
762
  }): Promise<APISuccessResponse<OCOOrderListItem>>;
550
763
  /**
551
- * Retrieves the details of a single OCO order by its clientOid.
764
+ * Get OCO Order By ClientOid
765
+ *
766
+ * Request via this endpoint to get a oco order information via the clientOid.
552
767
  */
553
768
  getOCOOrderByClientOid(params: {
554
769
  clientOid: string;
555
770
  }): Promise<APISuccessResponse<OCOOrderListItem>>;
556
771
  /**
557
- * Retrieves the details of a single OCO order by its orderId, including detailed information about the individual orders.
772
+ * Get OCO Order Details
773
+ *
774
+ * Request via this endpoint to get a oco order information via the order ID.
558
775
  */
559
776
  getOCOOrderDetails(params: {
560
777
  orderId: string;
561
778
  }): Promise<APISuccessResponse<OCOOrderDetails>>;
562
779
  /**
563
- * Retrieves your current OCO order list, paginated and sorted to show the latest first.
780
+ * Get OCO Order List
781
+ *
782
+ * Request via this endpoint to get your current OCO order list.
564
783
  */
565
784
  getOCOOrders(params: GetOCOOrdersRequest): Promise<APISuccessResponse<OCOOrders>>;
566
785
  /**
567
786
  *
568
- * REST - MARGIN TRADING -Margin HF trade
787
+ * REST - MARGIN TRADING - Market Data
569
788
  *
570
789
  */
571
- submitHFMarginOrder(params: SubmitHFMarginOrderRequest): Promise<APISuccessResponse<{
572
- orderNo: string;
790
+ /**
791
+ * Get Symbols - Cross Margin
792
+ *
793
+ * This endpoint allows querying the configuration of cross margin symbol.
794
+ */
795
+ getMarginActivePairsV3(params?: {
796
+ symbol?: string;
797
+ }): Promise<APISuccessResponse<{
798
+ timestamp: number;
799
+ items: MarginActivePairsV3[];
573
800
  }>>;
574
- submitHFMarginOrderTest(): Promise<any>;
801
+ /**
802
+ * Get Margin Config
803
+ *
804
+ * Request via this endpoint to get the configure info of the cross margin.
805
+ */
806
+ getMarginConfigInfo(): Promise<APISuccessResponse<MarginConfigInfo>>;
807
+ /**
808
+ * Get ETF Info
809
+ *
810
+ * This endpoint returns leveraged token information
811
+ */
812
+ getMarginLeveragedToken(params?: {
813
+ currency?: string;
814
+ }): Promise<APISuccessResponse<MarginLevTokenInfo[]>>;
815
+ /**
816
+ * Get Mark Price List
817
+ *
818
+ * This endpoint returns the current Mark price for all margin trading pairs.
819
+ */
820
+ getMarginMarkPrices(): Promise<APISuccessResponse<MarginMarkPrice[]>>;
821
+ /**
822
+ * Get Mark Price Detail
823
+ *
824
+ * This endpoint returns the current Mark price for specified margin trading pairs.
825
+ */
826
+ getMarginMarkPrice(params: {
827
+ symbol: string;
828
+ }): Promise<APISuccessResponse<MarginMarkPrice>>;
829
+ /**
830
+ * Get Symbols - Isolated Margin
831
+ *
832
+ * This endpoint allows querying the configuration of isolated margin symbol.
833
+ */
834
+ getIsolatedMarginSymbolsConfig(): Promise<APISuccessResponse<IsolatedMarginSymbolsConfig[]>>;
835
+ /**
836
+ *
837
+ * REST - MARGIN TRADING - Orders
838
+ *
839
+ */
840
+ /**
841
+ * Add Order
842
+ *
843
+ * Place order to the Cross-margin or Isolated-margin trading system
844
+ */
845
+ submitHFMarginOrder(params: SubmitHFMarginOrderRequest): Promise<APISuccessResponse<MarginSubmitOrderV3Response>>;
846
+ /**
847
+ * Add Order Test
848
+ *
849
+ * This endpoint is used to test the order submission.
850
+ */
851
+ submitHFMarginOrderTest(params: SubmitHFMarginOrderRequest): Promise<MarginSubmitOrderV3Response>;
852
+ /**
853
+ * Cancel Order By OrderId
854
+ *
855
+ * This endpoint can be used to cancel a margin order by orderId.
856
+ */
575
857
  cancelHFMarginOrder(params: {
576
858
  orderId: string;
577
859
  symbol: string;
578
860
  }): Promise<APISuccessResponse<{
579
861
  orderId: string;
580
862
  }>>;
863
+ /**
864
+ * Cancel Order By ClientOid
865
+ *
866
+ * This endpoint can be used to cancel a margin order by clientOid.
867
+ */
581
868
  cancelHFMarginOrderByClientOid(params: {
582
869
  clientOid: string;
583
870
  symbol: string;
584
871
  }): Promise<APISuccessResponse<{
585
872
  clientOid: string;
586
873
  }>>;
587
- cancelHFAllMarginOrders(params: HFMarginOrder): Promise<any>;
588
- getHFActiveMarginOrders(params: HFMarginRequestOrder): Promise<APISuccessResponse<HFMarginOrder[]>>;
589
- getHFMarginFilledOrders(params: GetHFMarginFilledRequest): Promise<APISuccessResponse<{
590
- lastId: number;
591
- items: HFMarginFilledOrder[];
592
- }>>;
593
- getHFMarginOrderByOrderId(params: {
594
- orderId: string;
595
- symbol: string;
596
- }): Promise<APISuccessResponse<HFMarginOrder>>;
597
- getHFMarginOrderByClientOid(params: {
598
- clientOid: string;
874
+ /**
875
+ * Cancel All Orders By Symbol
876
+ *
877
+ * This endpoint can cancel all open Margin orders by symbol
878
+ */
879
+ cancelHFAllMarginOrders(params: {
599
880
  symbol: string;
600
- }): Promise<APISuccessResponse<HFMarginOrder>>;
601
- getHFMarginFills(params: getHFMarginFillsRequest): Promise<APISuccessResponse<{
602
- lastId: number;
603
- items: HFMarginTransactionRecord[];
604
- }>>;
881
+ tradeType: string;
882
+ }): Promise<any>;
883
+ /**
884
+ * Get Symbols With Open Order
885
+ *
886
+ * This endpoint can query all Margin symbol that has active orders
887
+ */
605
888
  getHFMarginOpenSymbols(params: {
606
889
  tradeType: string;
607
890
  }): Promise<APISuccessResponse<{
@@ -609,70 +892,87 @@ export declare class SpotClient extends BaseRestClient {
609
892
  symbols: string[];
610
893
  }>>;
611
894
  /**
895
+ * Get Open Orders
612
896
  *
613
- * REST - MARGIN TRADING - Orders
614
- *
897
+ * This endpoint is to obtain all Margin active order lists, and the return value of the active order endpoint is the paged data of all uncompleted order lists.
615
898
  */
899
+ getHFActiveMarginOrders(params: HFMarginRequestOrder): Promise<APISuccessResponse<HFMarginOrder[]>>;
616
900
  /**
617
- * @deprecated This method is deprecated.
618
- * It is recommended to use the POST /api/v3/hf/margin/order endpoint instead of this endpoint
901
+ * Get Closed Orders
902
+ *
903
+ * This endpoint is to obtain all Margin Closed order lists
619
904
  */
620
- submitMarginOrder(params: SubmitMarginOrderRequest): Promise<APISuccessResponse<SubmitMarginOrderResponse>>;
905
+ getHFMarginFilledOrders(params: GetHFMarginFilledRequest): Promise<APISuccessResponse<{
906
+ lastId: number;
907
+ items: HFMarginOrder[];
908
+ }>>;
621
909
  /**
622
- * @deprecated This method is deprecated.
623
- * It is recommended to use the POST /api/v3/hf/margin/order/test endpoint instead of this endpoint
910
+ * Get Trade History
911
+ *
912
+ * This endpoint can be used to obtain a list of the latest Margin transaction details.
624
913
  */
625
- submitMarginOrderTest(): Promise<any>;
914
+ getHFMarginFills(params: getHFMarginFillsRequest): Promise<APISuccessResponse<{
915
+ lastId: number;
916
+ items: HFMarginTransactionRecord[];
917
+ }>>;
626
918
  /**
919
+ * Get Order By OrderId
627
920
  *
628
- * REST - MARGIN TRADING - Margin info
921
+ * This endpoint can be used to obtain a Margin order by orderId.
922
+ */
923
+ getHFMarginOrderByOrderId(params: {
924
+ orderId: string;
925
+ symbol: string;
926
+ }): Promise<APISuccessResponse<HFMarginOrder>>;
927
+ /**
928
+ * Get Order By ClientOid
629
929
  *
930
+ * This endpoint can be used to obtain a Margin order by clientOid.
630
931
  */
631
- getMarginLeveragedToken(params?: {
632
- currency?: string;
633
- }): Promise<APISuccessResponse<MarginLevTokenInfo[]>>;
634
- getMarginMarkPrices(): Promise<APISuccessResponse<MarginMarkPrice[]>>;
635
- getMarginMarkPrice(params: {
932
+ getHFMarginOrderByClientOid(params: {
933
+ clientOid: string;
636
934
  symbol: string;
637
- }): Promise<APISuccessResponse<MarginMarkPrice>>;
638
- getMarginConfigInfo(): Promise<APISuccessResponse<MarginConfigInfo>>;
639
- getMarginRiskLimitConfig(params: MarginRiskLimitRequest): Promise<APISuccessResponse<MarginRiskLimit[]>>;
935
+ }): Promise<APISuccessResponse<HFMarginOrder>>;
640
936
  /**
641
937
  *
642
- * REST - MARGIN TRADING - Isolated Margin
938
+ * REST - MARGIN TRADING - Debit
643
939
  *
644
940
  */
645
- getIsolatedMarginSymbolsConfig(): Promise<APISuccessResponse<IsolatedMarginSymbolsConfig[]>>;
646
941
  /**
647
- * @deprecated This method is deprecated.
648
- * It is recommended to use the GET /api/v3/margin/accounts endpoint instead of this endpoint
942
+ * Borrow
943
+ *
944
+ * This API endpoint is used to initiate an application for cross or isolated margin borrowing.
649
945
  */
650
- getIsolatedMarginAccounts(params?: {
651
- balanceCurrency?: 'USDT' | 'KCS' | 'BTC';
652
- }): Promise<APISuccessResponse<IsolatedMarginAccountInfo>>;
946
+ marginBorrowV3(params: MarginBorrowV3Request): Promise<APISuccessResponse<MarginOrderV3>>;
653
947
  /**
654
- * @deprecated This method is deprecated.
655
- * It is recommended to use the GET /api/v3/isolated/accounts endpoint instead of this endpoint
948
+ * Get Borrow History
949
+ *
950
+ * This API endpoint is used to get the borrowing orders for cross and isolated margin accounts
656
951
  */
657
- getIsolatedMarginAccount(params: {
658
- symbol: string;
659
- }): Promise<APISuccessResponse<SingleIsolatedMarginAccountInfo>>;
952
+ getMarginBorrowHistoryV3(params: MarginHistoryV3Request): Promise<APISuccessResponse<MarginBorrowHistoryV3[]>>;
660
953
  /**
954
+ * Repay
661
955
  *
662
- * REST - MARGIN TRADING - Margin trading(v3)
663
- *
956
+ * This API endpoint is used to initiate an application for cross or isolated margin repayment.
664
957
  */
665
- marginBorrowV3(params: MarginBorrowV3Request): Promise<APISuccessResponse<MarginOrderV3>>;
666
958
  marginRepayV3(params: MarginRepayV3Request): Promise<APISuccessResponse<MarginOrderV3>>;
667
- getMarginBorrowHistoryV3(params: MarginHistoryV3Request): Promise<APISuccessResponse<MarginHistoryRecord[]>>;
668
- getMarginRepayHistoryV3(params: MarginHistoryV3Request): Promise<APISuccessResponse<MarginHistoryRecord[]>>;
959
+ /**
960
+ * Get Repay History
961
+ *
962
+ * This API endpoint is used to get the repayment orders for cross and isolated margin accounts
963
+ */
964
+ getMarginRepayHistoryV3(params: MarginHistoryV3Request): Promise<APISuccessResponse<MarginRepayHistoryV3[]>>;
965
+ /**
966
+ * Get Interest History
967
+ *
968
+ * Request via this endpoint to get the interest records of the cross/isolated margin lending.
969
+ */
669
970
  getMarginInterestRecordsV3(params?: MarginInterestRecordsRequest): Promise<APISuccessResponse<MarginInterestRecords>>;
670
- getMarginActivePairsV3(params?: {
671
- symbol?: string;
672
- }): Promise<APISuccessResponse<{
673
- timestamp: number;
674
- items: any[];
675
- }>>;
971
+ /**
972
+ * Modify Leverage
973
+ *
974
+ * This endpoint allows modifying the leverage multiplier for cross margin or isolated margin.
975
+ */
676
976
  updateMarginLeverageV3(params: {
677
977
  symbol?: string;
678
978
  leverage: string;
@@ -680,56 +980,102 @@ export declare class SpotClient extends BaseRestClient {
680
980
  }): Promise<APISuccessResponse<any>>;
681
981
  /**
682
982
  *
683
- * REST - MARGIN TRADING - Lending market(v3)
983
+ * REST - MARGIN TRADING - Credit
984
+ *
985
+ */
986
+ /**
987
+ * Get Loan Market
684
988
  *
989
+ * This API endpoint is used to get the information about the currencies available for lending.
685
990
  */
686
991
  getLendingCurrencyV3(params?: {
687
992
  currency?: string;
688
993
  }): Promise<APISuccessResponse<LendingCurrencyV3>>;
994
+ /**
995
+ * Get Loan Market Interest Rate
996
+ *
997
+ * This API endpoint is used to get the interest rates of the margin lending market over the past 7 days.
998
+ */
689
999
  getLendingInterestRateV3(params: {
690
1000
  currency: string;
691
1001
  }): Promise<APISuccessResponse<{
692
1002
  time: string;
693
1003
  marketInterestRate: string;
694
1004
  }[]>>;
1005
+ /**
1006
+ * Purchase
1007
+ *
1008
+ * Invest credit in the market and earn interest,Please ensure that the funds are in the main(funding) account
1009
+ */
695
1010
  submitLendingSubscriptionV3(params: InitiateLendingSubscriptionV3Request): Promise<APISuccessResponse<{
696
1011
  orderNo: string;
697
1012
  }[]>>;
1013
+ /**
1014
+ * Modify Purchase
1015
+ *
1016
+ * This API endpoint is used to update the interest rates of subscription orders, which will take effect at the beginning of the next hour.
1017
+ */
1018
+ updateLendingSubscriptionOrdersV3(params: ModifyLendingSubscriptionOrdersV3Request): Promise<any>;
1019
+ /**
1020
+ * Get Purchase Orders
1021
+ *
1022
+ * This API endpoint provides pagination query for the purchase orders.
1023
+ */
1024
+ getLendingSubscriptionOrdersV3(params: GetLendingSubscriptionOrdersV3Request): Promise<APISuccessResponse<LendingRedemption>>;
1025
+ /**
1026
+ * Redeem
1027
+ *
1028
+ * Redeem your loan order
1029
+ */
698
1030
  submitLendingRedemptionV3(params: InitiateLendingRedemptionV3Request): Promise<APISuccessResponse<{
699
1031
  orderNo: string;
700
1032
  }[]>>;
701
- updateLendingSubscriptionOrdersV3(params: ModifyLendingSubscriptionOrdersV3Request): Promise<any>;
1033
+ /**
1034
+ * Get Redeem Orders
1035
+ *
1036
+ * This API endpoint provides pagination query for the redeem orders.
1037
+ */
702
1038
  getLendingRedemptionOrdersV3(params: GetLendingRedemptionOrdersV3Request): Promise<APISuccessResponse<LendingRedemption>>;
703
- getLendingSubscriptionOrdersV3(params: GetLendingSubscriptionOrdersV3Request): Promise<APISuccessResponse<LendingRedemption>>;
704
1039
  /**
705
1040
  *
706
- * REST - EARN -General
1041
+ * REST - MARGIN TRADING - Risk Limit
707
1042
  *
708
1043
  */
709
1044
  /**
710
- * Subscribe to Earn Fixed Income Products
1045
+ * Get Margin Risk Limit
711
1046
  *
712
- * This endpoint allows subscribing to fixed income products.
713
- * If the subscription fails, it returns the corresponding error code.
1047
+ * Request via this endpoint to get the Configure and Risk limit info of the margin.
714
1048
  */
715
- subscribeEarnFixedIncome(params: SubscribeEarnFixedIncomeRequest): Promise<APISuccessResponse<SubscribeEarnFixedIncomeResponse>>;
1049
+ getMarginRiskLimitConfig(params: MarginRiskLimitRequest): Promise<APISuccessResponse<MarginRiskLimit[]>>;
716
1050
  /**
717
- * Initiate redemption by holding ID
718
1051
  *
719
- * This endpoint allows initiating redemption by holding ID. If the current holding is fully redeemed or in the process of being redeemed, it indicates that the holding does not exist.
1052
+ * REST - COPY TRADING
1053
+ *
720
1054
  */
721
- submitRedemption(params: InitiateRedemptionRequest): Promise<APISuccessResponse<InitiateRedemptionResponse>>;
722
1055
  /**
723
- * Get Earn Redeem Preview by Holding ID
1056
+ *
1057
+ * REST - EARN
1058
+ *
1059
+ */
1060
+ /**
1061
+ /**
1062
+ * Earn Purchase
1063
+ *
1064
+ * This endpoint allows subscribing earn product
1065
+ */
1066
+ subscribeEarnFixedIncome(params: SubscribeEarnFixedIncomeRequest): Promise<APISuccessResponse<SubscribeEarnFixedIncomeResponse>>;
1067
+ /**
1068
+ * Get Earn Redeem Preview
724
1069
  *
725
1070
  * This endpoint retrieves redemption preview information by holding ID. If the current holding is fully redeemed or in the process of being redeemed, it indicates that the holding does not exist.
726
1071
  */
727
1072
  getEarnRedeemPreview(params: GetEarnRedeemPreviewRequest): Promise<APISuccessResponse<GetEarnRedeemPreviewResponse>>;
728
1073
  /**
1074
+ * Earn Redeem
729
1075
  *
730
- * REST - EARN -KUCOIN EARN
731
- *
1076
+ * This endpoint allows initiating redemption by holding ID. If the current holding is fully redeemed or in the process of being redeemed, it indicates that the holding does not exist.
732
1077
  */
1078
+ submitRedemption(params: InitiateRedemptionRequest): Promise<APISuccessResponse<InitiateRedemptionResponse>>;
733
1079
  /**
734
1080
  * Get Earn Savings Products
735
1081
  *
@@ -738,12 +1084,6 @@ export declare class SpotClient extends BaseRestClient {
738
1084
  getEarnSavingsProducts(params?: {
739
1085
  currency?: string;
740
1086
  }): Promise<APISuccessResponse<EarnProduct[]>>;
741
- /**
742
- * Get Earn Fixed Income Current Holdings
743
- *
744
- * This endpoint retrieves current holding assets of fixed income products. If no current holding assets are available, an empty list is returned.
745
- */
746
- getEarnFixedIncomeHoldAssets(params?: GetEarnFixedIncomeHoldAssetsRequest): Promise<APISuccessResponse<EarnFixedIncomeHoldAssets>>;
747
1087
  /**
748
1088
  * Get Earn Limited-Time Promotion Products
749
1089
  *
@@ -753,25 +1093,26 @@ export declare class SpotClient extends BaseRestClient {
753
1093
  currency?: string;
754
1094
  }): Promise<APISuccessResponse<EarnProduct[]>>;
755
1095
  /**
1096
+ * Get Earn Account Holdings
756
1097
  *
757
- * REST - EARN - Staking
758
- *
1098
+ * This endpoint retrieves current holding assets of fixed income products. If no current holding assets are available, an empty list is returned.
759
1099
  */
1100
+ getEarnFixedIncomeHoldAssets(params?: GetEarnFixedIncomeHoldAssetsRequest): Promise<APISuccessResponse<EarnFixedIncomeHoldAssets>>;
760
1101
  /**
761
- * Get Earn KCS Staking Products
762
- *
763
- * This endpoint retrieves KCS Staking products. If no KCS Staking products are available, an empty list is returned.
1102
+ * Get Earn Staking Products
764
1103
  *
1104
+ * This endpoint retrieves staking products. If no staking products are available, an empty list is returned.
765
1105
  */
766
- getEarnKcsStakingProducts(params?: {
1106
+ getEarnStakingProducts(params?: {
767
1107
  currency?: string;
768
1108
  }): Promise<APISuccessResponse<EarnProduct[]>>;
769
1109
  /**
770
- * Get Earn Staking Products
1110
+ * Get Earn KCS Staking Products
1111
+ *
1112
+ * This endpoint retrieves KCS Staking products. If no KCS Staking products are available, an empty list is returned.
771
1113
  *
772
- * This endpoint retrieves staking products. If no staking products are available, an empty list is returned.
773
1114
  */
774
- getEarnStakingProducts(params?: {
1115
+ getEarnKcsStakingProducts(params?: {
775
1116
  currency?: string;
776
1117
  }): Promise<APISuccessResponse<EarnProduct[]>>;
777
1118
  /**
@@ -780,22 +1121,26 @@ export declare class SpotClient extends BaseRestClient {
780
1121
  * This endpoint retrieves ETH Staking products. If no ETH Staking products are available, an empty list is returned.
781
1122
  *
782
1123
  */
783
- getEarnEthStakingProducts(): Promise<APISuccessResponse<EarnProduct[]>>;
1124
+ getEarnEthStakingProducts(params?: {
1125
+ currency: string;
1126
+ }): Promise<APISuccessResponse<EarnProduct[]>>;
784
1127
  /**
785
1128
  *
786
1129
  * REST - VIP LENDING
1130
+ *
787
1131
  */
788
1132
  /**
789
- * Get information on off-exchange funding and loans
1133
+ * Get Account Detail - VIP Lending
790
1134
  *
1135
+ * The following information is only applicable to loans.
1136
+ * Get information on off-exchange funding and loans.
791
1137
  * This endpoint is only for querying accounts that are currently involved in loans.
792
- *
793
1138
  */
794
1139
  getOtcLoan(): Promise<APISuccessResponse<OtcLoan>>;
795
1140
  /**
796
- * Get information on accounts involved in off-exchange loans
1141
+ * Get Accounts - VIP Lending
797
1142
  *
798
- * This endpoint is only for querying accounts that are currently involved in off-exchange funding and loans.
1143
+ * Accounts participating in OTC lending, This endpoint is only for querying accounts currently running OTC lending.
799
1144
  */
800
1145
  getOtcLoanAccounts(): Promise<APISuccessResponse<OtcLoanAccount[]>>;
801
1146
  /**
@@ -807,15 +1152,13 @@ export declare class SpotClient extends BaseRestClient {
807
1152
  * Get Affiliate User Rebate Information
808
1153
  *
809
1154
  * This endpoint allows getting affiliate user rebate information.
1155
+ */
1156
+ getAffiliateUserRebateInfo(): Promise<APISuccessResponse<any>>;
1157
+ /**
1158
+ *
1159
+ * REST - BROKER
810
1160
  *
811
- * @param params - The parameters for the request
812
- * @returns A promise that resolves to the affiliate user rebate information
813
1161
  */
814
- getAffiliateUserRebateInfo(params: {
815
- date: string;
816
- maxCount?: number;
817
- offset: string;
818
- }): Promise<APISuccessResponse<any>>;
819
1162
  /**
820
1163
  * Get download link for broker rebate orders
821
1164
  *
@@ -833,4 +1176,229 @@ export declare class SpotClient extends BaseRestClient {
833
1176
  */
834
1177
  getPublicWSConnectionToken(): Promise<APISuccessResponse<WsConnectionInfo>>;
835
1178
  getPrivateWSConnectionToken(): Promise<APISuccessResponse<WsConnectionInfo>>;
1179
+ /**
1180
+ *
1181
+ * DEPRECATED
1182
+ *
1183
+ */
1184
+ /**
1185
+ *
1186
+ * REST - ACCOUNT - Sub-Account
1187
+ * DEPRECATED
1188
+ */
1189
+ /**
1190
+ * @deprecated This method is deprecated.
1191
+ * It is recommended to use the getSubAccountsV2() endpoint instead of this endpoint
1192
+ */
1193
+ getSubAccountsV1(): Promise<APISuccessResponse<SubAccountInfo[]>>;
1194
+ /**
1195
+ * @deprecated This method is deprecated.
1196
+ * It is recommended to use the getSubAccountsV2() endpoint instead of this endpoint
1197
+ */
1198
+ getSubAccountBalancesV1(): Promise<APISuccessResponse<SubAccountBalance>>;
1199
+ /**
1200
+ *
1201
+ * REST - FUNDING - Funding overview
1202
+ * DEPRECATED
1203
+ */
1204
+ /**
1205
+ * @deprecated This method is deprecated.
1206
+ * It is recommended to use the getMarginBalance() endpoint instead of this endpoint
1207
+ */
1208
+ getMarginBalances(): Promise<APISuccessResponse<{
1209
+ debtRatio: string;
1210
+ accounts: MarginAccountBalance[];
1211
+ }>>;
1212
+ /**
1213
+ *
1214
+ * REST - FUNDING -Deposit
1215
+ * DEPRECATED
1216
+ */
1217
+ /**
1218
+ * @deprecated This method is deprecated. Please use createDepositAddressV3() instead.
1219
+ */
1220
+ createDepositAddress(params: {
1221
+ currency: string;
1222
+ chain?: string;
1223
+ }): Promise<APISuccessResponse<DepositAddress>>;
1224
+ /**
1225
+ * @deprecated This method is deprecated. Please use getDepositAddressesV3() instead.
1226
+ */
1227
+ getDepositAddressesV2(params: {
1228
+ currency: string;
1229
+ }): Promise<APISuccessResponse<DepositAddressV2[]>>;
1230
+ /**
1231
+ * @deprecated This method is deprecated. Please use getDepositAddressesV3() instead.
1232
+ */
1233
+ getDepositAddressV1(params: {
1234
+ currency: string;
1235
+ chain?: string;
1236
+ }): Promise<APISuccessResponse<DepositAddress>>;
1237
+ /**
1238
+ * @deprecated This method is deprecated.
1239
+ * It is recommended to use the getDeposits() endpoint instead of this endpoint
1240
+ */
1241
+ getHistoricalDepositsV1(params?: GetDepositsRequest): Promise<APISuccessResponse<V1HistoricalDeposits>>;
1242
+ /**
1243
+ *
1244
+ * REST - FUNDING -Withdrawals
1245
+ * DEPRECATED
1246
+ */
1247
+ /**
1248
+ * @deprecated This method is deprecated.
1249
+ * It is recommended to use the getWithdrawals() endpoint instead of this endpoint
1250
+ */
1251
+ getHistoricalWithdrawalsV1(params?: GetWithdrawalsRequest): Promise<APISuccessResponse<HistoricalWithdrawalsV1>>;
1252
+ /**
1253
+ * @deprecated This method is deprecated. Please use submitWithdrawV3() instead.
1254
+ */
1255
+ submitWithdraw(params: ApplyWithdrawRequest): Promise<APISuccessResponse<{
1256
+ withdrawalId: string;
1257
+ }>>;
1258
+ /**
1259
+ *
1260
+ * REST - FUNDING - Transfer
1261
+ * DEPRECATED
1262
+ */
1263
+ /**
1264
+ * @deprecated This method is deprecated.
1265
+ * It is recommended to use the submitFlexTransfer() endpoint instead of this endpoint
1266
+ */
1267
+ submitTransferMasterSub(params: submitTransferMasterSubRequest): Promise<APISuccessResponse<{
1268
+ orderId: string;
1269
+ }>>;
1270
+ /**
1271
+ * @deprecated This method is deprecated.
1272
+ * It is recommended to use the submitFlexTransfer() endpoint instead of this endpoint
1273
+ */
1274
+ submitInnerTransfer(params: InnerTransferRequest): Promise<APISuccessResponse<{
1275
+ orderId: string;
1276
+ }>>;
1277
+ /**
1278
+ *
1279
+ * REST - SPOT TRADING - Orders
1280
+ * DEPRECATED
1281
+ */
1282
+ /**
1283
+ * @deprecated This method is deprecated.
1284
+ * It is recommended to use the submitHFOrder() endpoint instead of this endpoint
1285
+ */
1286
+ submitOrder(params: SubmitOrderRequest): Promise<APISuccessResponse<{
1287
+ orderId: string;
1288
+ }>>;
1289
+ /**
1290
+ * @deprecated This method is deprecated.
1291
+ * It is recommended to use the submitHFOrderTest() endpoint instead of this endpoint
1292
+ */
1293
+ submitOrderTest(): Promise<any>;
1294
+ /**
1295
+ * @deprecated This method is deprecated.
1296
+ * It is recommended to use the submitMultipleHFOrders() endpoint instead of this endpoint
1297
+ */
1298
+ submitMultipleOrders(params: {
1299
+ symbol: string;
1300
+ orderList: SubmitMultipleOrdersRequest[];
1301
+ }): Promise<APISuccessResponse<MultipleOrdersResponse[]>>;
1302
+ /**
1303
+ * @deprecated This method is deprecated.
1304
+ * It is recommended to use the cancelHFOrder() endpoint instead of this endpoint
1305
+ */
1306
+ cancelOrderById(params: {
1307
+ orderId: string;
1308
+ }): Promise<APISuccessResponse<{
1309
+ cancelledOrderIds: string[];
1310
+ }>>;
1311
+ /**
1312
+ * @deprecated This method is deprecated.
1313
+ * It is recommended to use the cancelHFOrderByClientOid() endpoint instead of this endpoint
1314
+ */
1315
+ cancelOrderByClientOid(params: {
1316
+ clientOid: string;
1317
+ }): Promise<APISuccessResponse<{
1318
+ cancelledOrderId: string;
1319
+ clientOid: string;
1320
+ }>>;
1321
+ /**
1322
+ * @deprecated This method is deprecated.
1323
+ * It is recommended to use the cancelHFAllOrders() endpoint instead of this endpoint
1324
+ */
1325
+ cancelAllOrders(params?: CancelAllOrdersRequest): Promise<APISuccessResponse<{
1326
+ cancelledOrderIds: string[];
1327
+ }>>;
1328
+ /**
1329
+ * @deprecated This method is deprecated.
1330
+ * It is recommended to use the getHfOrderDetails() endpoint instead of this endpoint
1331
+ */
1332
+ getOrders(params?: GetOrderListRequest): Promise<APISuccessResponse<SpotOrderList>>;
1333
+ /**
1334
+ * @deprecated This method is deprecated.
1335
+ * It is recommended to use the getHFOrders() endpoint instead of this endpoint
1336
+ */
1337
+ getRecentOrders(params?: {
1338
+ currentPage?: number;
1339
+ pageSize?: number;
1340
+ }): Promise<APISuccessResponse<SpotOrder[]>>;
1341
+ /**
1342
+ * @deprecated This method is deprecated.
1343
+ * It is recommended to use the getHFOrderDetailsByOrderId() instead of this endpoint
1344
+ */
1345
+ getOrderByOrderId(params: {
1346
+ orderId: string;
1347
+ }): Promise<APISuccessResponse<SpotOrder>>;
1348
+ /**
1349
+ * @deprecated This method is deprecated.
1350
+ * It is recommended to use the getHFOrderDetailsByClientOid() instead of this endpoint
1351
+ */
1352
+ getOrderByClientOid(params: {
1353
+ clientOid: string;
1354
+ }): Promise<APISuccessResponse<SpotOrder>>;
1355
+ /**
1356
+ *
1357
+ * REST - SPOT TRADING -Fills
1358
+ * DEPRECATED
1359
+ */
1360
+ /**
1361
+ * @deprecated This method is deprecated.
1362
+ * It is recommended to use the getHFFilledOrders() instead of this endpoint
1363
+ */
1364
+ getFills(params?: GetFillsRequest): Promise<APISuccessResponse<SpotOrderFills>>;
1365
+ /**
1366
+ * @deprecated This method is deprecated.
1367
+ * It is recommended to use the getHFFilledOrders() instead of this endpoint
1368
+ */
1369
+ getRecentFills(): Promise<APISuccessResponse<SpotOrderFill[]>>;
1370
+ /**
1371
+ *
1372
+ * REST - MARGIN TRADING - Orders
1373
+ * DEPRECATED
1374
+ */
1375
+ /**
1376
+ * @deprecated This method is deprecated.
1377
+ * It is recommended to use the submitHFMarginOrder() endpoint instead of this endpoint
1378
+ */
1379
+ submitMarginOrder(params: SubmitMarginOrderRequest): Promise<APISuccessResponse<SubmitMarginOrderResponse>>;
1380
+ /**
1381
+ * @deprecated This method is deprecated.
1382
+ * It is recommended to use the submitHFMarginOrderTest() endpoint instead of this endpoint
1383
+ */
1384
+ submitMarginOrderTest(): Promise<any>;
1385
+ /**
1386
+ *
1387
+ * REST - MARGIN TRADING - Isolated Margin
1388
+ * DEPRECATED
1389
+ */
1390
+ /**
1391
+ * @deprecated This method is deprecated.
1392
+ * It is recommended to use the getMarginBalance() endpoint instead of this endpoint
1393
+ */
1394
+ getIsolatedMarginAccounts(params?: {
1395
+ balanceCurrency?: 'USDT' | 'KCS' | 'BTC';
1396
+ }): Promise<APISuccessResponse<IsolatedMarginAccountInfo>>;
1397
+ /**
1398
+ * @deprecated This method is deprecated.
1399
+ * It is recommended to use the getIsolatedMarginBalance() endpoint instead of this endpoint
1400
+ */
1401
+ getIsolatedMarginAccount(params: {
1402
+ symbol: string;
1403
+ }): Promise<APISuccessResponse<SingleIsolatedMarginAccountInfo>>;
836
1404
  }