kucoin-api 2.0.0 → 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 (33) hide show
  1. package/dist/cjs/FuturesClient.d.ts +129 -24
  2. package/dist/cjs/FuturesClient.js +108 -16
  3. package/dist/cjs/FuturesClient.js.map +1 -1
  4. package/dist/cjs/SpotClient.d.ts +80 -85
  5. package/dist/cjs/SpotClient.js +55 -55
  6. package/dist/cjs/SpotClient.js.map +1 -1
  7. package/dist/cjs/types/request/futures.types.d.ts +68 -16
  8. package/dist/cjs/types/request/spot-account.d.ts +1 -1
  9. package/dist/cjs/types/request/spot-funding.d.ts +0 -2
  10. package/dist/cjs/types/request/spot-trading.d.ts +11 -20
  11. package/dist/cjs/types/response/futures.types.d.ts +118 -58
  12. package/dist/cjs/types/response/spot-account.d.ts +76 -28
  13. package/dist/cjs/types/response/spot-funding.d.ts +34 -32
  14. package/dist/cjs/types/response/spot-margin-trading.d.ts +80 -15
  15. package/dist/cjs/types/response/spot-misc.d.ts +1 -1
  16. package/dist/cjs/types/response/spot-trading.d.ts +100 -74
  17. package/dist/mjs/FuturesClient.d.ts +129 -24
  18. package/dist/mjs/FuturesClient.js +108 -16
  19. package/dist/mjs/FuturesClient.js.map +1 -1
  20. package/dist/mjs/SpotClient.d.ts +80 -85
  21. package/dist/mjs/SpotClient.js +55 -55
  22. package/dist/mjs/SpotClient.js.map +1 -1
  23. package/dist/mjs/types/request/futures.types.d.ts +68 -16
  24. package/dist/mjs/types/request/spot-account.d.ts +1 -1
  25. package/dist/mjs/types/request/spot-funding.d.ts +0 -2
  26. package/dist/mjs/types/request/spot-trading.d.ts +11 -20
  27. package/dist/mjs/types/response/futures.types.d.ts +118 -58
  28. package/dist/mjs/types/response/spot-account.d.ts +76 -28
  29. package/dist/mjs/types/response/spot-funding.d.ts +34 -32
  30. package/dist/mjs/types/response/spot-margin-trading.d.ts +80 -15
  31. package/dist/mjs/types/response/spot-misc.d.ts +1 -1
  32. package/dist/mjs/types/response/spot-trading.d.ts +100 -74
  33. 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
  /**
@@ -72,7 +72,7 @@ export declare class SpotClient extends BaseRestClient {
72
72
  /**
73
73
  * Get Account Type - Spot
74
74
  *
75
- * This interface determines whether the current user is a spot high-frequency user or a spot low-frequency user.
75
+ * This endpoint determines whether the current user is a spot high-frequency user or a spot low-frequency user.
76
76
  */
77
77
  getUserType(): Promise<APISuccessResponse<boolean>>;
78
78
  /**
@@ -104,7 +104,7 @@ export declare class SpotClient extends BaseRestClient {
104
104
  /**
105
105
  * Get Account Ledgers - Spot/Margin
106
106
  *
107
- * This interface is for transaction records from all types of your accounts, supporting inquiry of various currencies.
107
+ * This endpoint is for transaction records from all types of your accounts, supporting inquiry of various currencies.
108
108
  * Items are paginated and sorted to show the latest first.
109
109
  * See the Pagination section for retrieving additional entries after the first page.
110
110
  */
@@ -142,7 +142,7 @@ export declare class SpotClient extends BaseRestClient {
142
142
  */
143
143
  enableSubAccountMargin(params: {
144
144
  uid: string;
145
- }): Promise<void>;
145
+ }): Promise<boolean | null>;
146
146
  /**
147
147
  * Add SubAccount Futures Permission
148
148
  *
@@ -151,7 +151,7 @@ export declare class SpotClient extends BaseRestClient {
151
151
  */
152
152
  enableSubAccountFutures(params: {
153
153
  uid: string;
154
- }): Promise<void>;
154
+ }): Promise<boolean | null>;
155
155
  /**
156
156
  * Get SubAccount List - Summary Info
157
157
  *
@@ -163,7 +163,7 @@ export declare class SpotClient extends BaseRestClient {
163
163
  }): Promise<APISuccessResponse<SubAccountsV2>>;
164
164
  /**
165
165
  * @deprecated This method is deprecated.
166
- * 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
167
167
  */
168
168
  getSubAccountBalance(params: {
169
169
  subUserId: string;
@@ -233,7 +233,7 @@ export declare class SpotClient extends BaseRestClient {
233
233
  currency: string;
234
234
  amount?: string;
235
235
  chain?: string;
236
- }): Promise<APISuccessResponse<DepositAddress[]>>;
236
+ }): Promise<APISuccessResponse<DepositAddressV3[]>>;
237
237
  /**
238
238
  * Get Deposit History
239
239
  *
@@ -249,7 +249,7 @@ export declare class SpotClient extends BaseRestClient {
249
249
  /**
250
250
  * Get Withdrawal Quotas
251
251
  *
252
- * This interface can obtain the withdrawal quotas information of this currency.
252
+ * This endpoint can obtain the withdrawal quotas information of this currency.
253
253
  */
254
254
  getWithdrawalQuotas(params: {
255
255
  currency: string;
@@ -258,7 +258,7 @@ export declare class SpotClient extends BaseRestClient {
258
258
  /**
259
259
  * Withdraw(V3)
260
260
  *
261
- * Use this interface to withdraw the specified currency
261
+ * Use this endpoint to withdraw the specified currency
262
262
  */
263
263
  submitWithdrawV3(params: SubmitWithdrawV3Request): Promise<APISuccessResponse<{
264
264
  withdrawalId: string;
@@ -266,13 +266,11 @@ export declare class SpotClient extends BaseRestClient {
266
266
  /**
267
267
  * Cancel Withdrawal
268
268
  *
269
- * This interface can cancel the withdrawal, Only withdrawals requests of PROCESSING status could be canceled.
269
+ * This endpoint can cancel the withdrawal, Only withdrawals requests of PROCESSING status could be canceled.
270
270
  */
271
271
  cancelWithdrawal(params: {
272
272
  withdrawalId: string;
273
- }): Promise<APISuccessResponse<{
274
- withdrawalId: string;
275
- }>>;
273
+ }): Promise<APISuccessResponse<string | null>>;
276
274
  /**
277
275
  * Get Withdrawal History
278
276
  *
@@ -294,7 +292,7 @@ export declare class SpotClient extends BaseRestClient {
294
292
  /**
295
293
  * Flex Transfer
296
294
  *
297
- * This interface can be used for transfers between master and sub accounts and inner transfers
295
+ * This endpoint can be used for transfers between master and sub accounts and inner transfers
298
296
  */
299
297
  submitFlexTransfer(params: FlexTransferRequest): Promise<APISuccessResponse<{
300
298
  orderId: string;
@@ -307,10 +305,10 @@ export declare class SpotClient extends BaseRestClient {
307
305
  /**
308
306
  * Get Basic Fee - Spot/Margin
309
307
  *
310
- * This interface is for the spot/margin basic fee rate of users
308
+ * This endpoint is for the spot/margin basic fee rate of users
311
309
  */
312
310
  getBasicUserFee(params: {
313
- currencyType: string;
311
+ currencyType: number;
314
312
  }): Promise<APISuccessResponse<{
315
313
  takerFeeRate: string;
316
314
  makerFeeRate: string;
@@ -318,7 +316,7 @@ export declare class SpotClient extends BaseRestClient {
318
316
  /**
319
317
  * Get Actual Fee - Spot/Margin
320
318
  *
321
- * This interface is for the actual fee rate of the trading pair.
319
+ * This endpoint is for the actual fee rate of the trading pair.
322
320
  * You can inquire about fee rates of 10 trading pairs each time at most.
323
321
  * The fee rate of your sub-account is the same as that of the master account.
324
322
  */
@@ -337,7 +335,7 @@ export declare class SpotClient extends BaseRestClient {
337
335
  /**
338
336
  * Get Announcements
339
337
  *
340
- * This interface can obtain the latest news announcements, and the default page search is for announcements within a month.
338
+ * This endpoint can obtain the latest news announcements, and the default page search is for announcements within a month.
341
339
  */
342
340
  getAnnouncements(params?: GetAnnouncementsRequest): Promise<APISuccessResponse<Announcements>>;
343
341
  /**
@@ -388,10 +386,7 @@ export declare class SpotClient extends BaseRestClient {
388
386
  *
389
387
  * Request market tickers for all the trading pairs in the market (including 24h volume), takes a snapshot every 2 seconds.
390
388
  */
391
- getTickers(): Promise<APISuccessResponse<{
392
- time: number;
393
- ticker: Ticker[];
394
- }>>;
389
+ getTickers(): Promise<APISuccessResponse<AllTickers>>;
395
390
  /**
396
391
  * Get Trade History
397
392
  *
@@ -476,7 +471,7 @@ export declare class SpotClient extends BaseRestClient {
476
471
  *
477
472
  * Place order to the spot trading system
478
473
  *
479
- * The difference between this interface and "Add order" is that this interface will synchronously return the order information after the order matching is completed.
474
+ * The difference between this endpoint and "SubmitHFOrder()" is that this endpoint will synchronously return the order information after the order matching is completed.
480
475
  */
481
476
  submitHFOrderSync(params: SubmitHFOrderRequest): Promise<APISuccessResponse<SubmitHFOrderSyncResponse>>;
482
477
  /**
@@ -485,23 +480,23 @@ export declare class SpotClient extends BaseRestClient {
485
480
  * Order test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint,
486
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.
487
482
  */
488
- submitHFOrderTest(): Promise<any>;
483
+ submitHFOrderTest(params: SubmitHFOrderRequest): Promise<any>;
489
484
  /**
490
485
  * Batch Add Orders
491
486
  *
492
487
  * This endpoint supports sequential batch order placement from a single endpoint. A maximum of 20 orders can be placed simultaneously.
493
488
  */
494
489
  submitHFMultipleOrders(params: {
495
- orderList: SubmitMultipleHFOrdersRequest[];
490
+ orderList: SubmitHFOrderRequest[];
496
491
  }): Promise<APISuccessResponse<SubmitMultipleHFOrdersResponse[]>>;
497
492
  /**
498
493
  * Batch Add Orders Sync
499
494
  *
500
495
  * This endpoint supports sequential batch order placement from a single endpoint. A maximum of 20 orders can be placed simultaneously.
501
- * The difference between this interface and "Batch Add Orders" is that this interface will synchronously return the order information after the order matching is completed.
496
+ * The difference between this endpoint and "submitHFMultipleOrders()" is that this endpoint will synchronously return the order information after the order matching is completed.
502
497
  */
503
498
  submitHFMultipleOrdersSync(params: {
504
- orderList: SubmitMultipleHFOrdersRequest[];
499
+ orderList: SubmitHFOrderRequest[];
505
500
  }): Promise<APISuccessResponse<SubmitMultipleHFOrdersSyncResponse[]>>;
506
501
  /**
507
502
  * Cancel Order By OrderId
@@ -519,7 +514,7 @@ export declare class SpotClient extends BaseRestClient {
519
514
  * Cancel Order By OrderId Sync
520
515
  *
521
516
  * This endpoint can be used to cancel a spot order by orderId.
522
- * The difference between this interface and "Cancel Order By OrderId" is that this interface will synchronously return the order information after the order canceling is completed.
517
+ * The difference between this endpoint and "cancelHFOrder()" is that this endpoint will synchronously return the order information after the order canceling is completed.
523
518
  */
524
519
  cancelHFOrderSync(params: {
525
520
  orderId: string;
@@ -541,7 +536,7 @@ export declare class SpotClient extends BaseRestClient {
541
536
  * Cancel Order By ClientOid Sync
542
537
  *
543
538
  * This endpoint can be used to cancel a spot order by clientOid.
544
- * The difference between this interface and "Cancel Order By ClientOid" is that this interface will synchronously return the order information after the order canceling is completed.
539
+ * The difference between this endpoint and "cancelHFOrderByClientOId()" is that this endpoint will synchronously return the order information after the order canceling is completed.
545
540
  */
546
541
  cancelHFOrderSyncByClientOId(params: {
547
542
  clientOid: string;
@@ -550,9 +545,12 @@ export declare class SpotClient extends BaseRestClient {
550
545
  /**
551
546
  * Cancel Partial Order
552
547
  *
553
- * This interface can cancel the specified quantity of the order according to the orderId.
548
+ * This endpoint can cancel the specified quantity of the order according to the orderId.
554
549
  */
555
- cancelHFOrdersNumber(params: CancelSpecifiedNumberHFOrdersRequest): Promise<any>;
550
+ cancelHFOrdersNumber(params: CancelSpecifiedNumberHFOrdersRequest): Promise<{
551
+ orderId: string;
552
+ cancelSize: string;
553
+ }>;
556
554
  /**
557
555
  * Cancel All Orders By Symbol
558
556
  *
@@ -560,10 +558,7 @@ export declare class SpotClient extends BaseRestClient {
560
558
  */
561
559
  cancelHFAllOrdersBySymbol(params: {
562
560
  symbol: string;
563
- }): Promise<APISuccessResponse<{
564
- orderId: string;
565
- cancelSize: string;
566
- }>>;
561
+ }): Promise<APISuccessResponse<string>>;
567
562
  /**
568
563
  * Cancel All Orders
569
564
  *
@@ -573,7 +568,7 @@ export declare class SpotClient extends BaseRestClient {
573
568
  /**
574
569
  * Modify Order
575
570
  *
576
- * This interface can modify the price and quantity of the order according to orderId or clientOid.
571
+ * This endpoint can modify the price and quantity of the order according to orderId or clientOid.
577
572
  */
578
573
  updateHFOrder(params: ModifyHFOrderRequest): Promise<APISuccessResponse<{
579
574
  newOrderId: string;
@@ -600,7 +595,7 @@ export declare class SpotClient extends BaseRestClient {
600
595
  /**
601
596
  * Get Symbols With Open Order
602
597
  *
603
- * This interface can query all spot symbol that has active orders
598
+ * This endpoint can query all spot symbol that has active orders
604
599
  */
605
600
  getHFActiveSymbols(): Promise<APISuccessResponse<{
606
601
  symbols: string[];
@@ -608,7 +603,7 @@ export declare class SpotClient extends BaseRestClient {
608
603
  /**
609
604
  * Get Open Orders
610
605
  *
611
- * This interface is to obtain all Spot active order lists, and the return value of the active order interface is the paged data of all uncompleted order lists.
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.
612
607
  * The returned data is sorted in descending order according to the latest update time of the order.
613
608
  */
614
609
  getHFActiveOrders(params: {
@@ -617,7 +612,7 @@ export declare class SpotClient extends BaseRestClient {
617
612
  /**
618
613
  * Get Closed Orders
619
614
  *
620
- * This interface is to obtain all Spot completed order lists, and the return value of the completed order interface is the paged data of all completed order lists.
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.
621
616
  * The returned data is sorted in descending order according to the latest update time of the order.
622
617
  */
623
618
  getHFCompletedOrders(params: GetHFCompletedOrdersRequest): Promise<APISuccessResponse<{
@@ -637,15 +632,15 @@ export declare class SpotClient extends BaseRestClient {
637
632
  * Get DCP
638
633
  *
639
634
  * Get Disconnection Protect(Deadman Swich)
640
- * Through this interface, you can query the settings of automatic order cancellation
635
+ * Through this endpoint, you can query the settings of automatic order cancellation
641
636
  */
642
637
  cancelHFOrderAutoSettingQuery(): Promise<APISuccessResponse<AutoCancelHFOrderSettingQueryResponse>>;
643
638
  /**
644
639
  * Set DCP
645
640
  *
646
641
  * Set Disconnection Protect(Deadman Swich)
647
- * Through this interface, Call this interface to automatically cancel all orders of the set trading pair after the specified time.
648
- * If this interface 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.
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.
649
644
  */
650
645
  cancelHFOrderAutoSetting(params: {
651
646
  timeout: number;
@@ -661,6 +656,7 @@ export declare class SpotClient extends BaseRestClient {
661
656
  */
662
657
  submitStopOrder(params: SubmitStopOrderRequest): Promise<APISuccessResponse<{
663
658
  orderId: string;
659
+ clientOid: string;
664
660
  }>>;
665
661
  /**
666
662
  * Cancel Stop Order By ClientOid
@@ -687,7 +683,7 @@ export declare class SpotClient extends BaseRestClient {
687
683
  /**
688
684
  * Batch Cancel Stop Orders
689
685
  *
690
- * Request via this interface to cancel a batch of stop orders.
686
+ * Request via this endpoint to cancel a batch of stop orders.
691
687
  */
692
688
  cancelStopOrders(params?: CancelStopOrdersRequest): Promise<APISuccessResponse<{
693
689
  cancelledOrderIds: string[];
@@ -701,7 +697,7 @@ export declare class SpotClient extends BaseRestClient {
701
697
  /**
702
698
  * Get Stop Order By OrderId
703
699
  *
704
- * Request via this interface to get a stop order information via the order ID.
700
+ * Request via this endpoint to get a stop order information via the order ID.
705
701
 
706
702
 
707
703
  */
@@ -748,7 +744,7 @@ export declare class SpotClient extends BaseRestClient {
748
744
  /**
749
745
  * Batch Cancel OCO Order
750
746
  *
751
- * This interface can batch cancel OCO orders through orderIds.
747
+ * This endpoint can batch cancel OCO orders through orderIds.
752
748
  */
753
749
  cancelMultipleOCOOrders(params?: {
754
750
  orderIds?: string;
@@ -759,7 +755,7 @@ export declare class SpotClient extends BaseRestClient {
759
755
  /**
760
756
  * Get OCO Order By OrderId
761
757
  *
762
- * Request via this interface to get a oco order information via the order ID.
758
+ * Request via this endpoint to get a oco order information via the order ID.
763
759
  */
764
760
  getOCOOrderByOrderId(params: {
765
761
  orderId: string;
@@ -767,7 +763,7 @@ export declare class SpotClient extends BaseRestClient {
767
763
  /**
768
764
  * Get OCO Order By ClientOid
769
765
  *
770
- * Request via this interface to get a oco order information via the clientOid.
766
+ * Request via this endpoint to get a oco order information via the clientOid.
771
767
  */
772
768
  getOCOOrderByClientOid(params: {
773
769
  clientOid: string;
@@ -775,7 +771,7 @@ export declare class SpotClient extends BaseRestClient {
775
771
  /**
776
772
  * Get OCO Order Details
777
773
  *
778
- * Request via this interface to get a oco order information via the order ID.
774
+ * Request via this endpoint to get a oco order information via the order ID.
779
775
  */
780
776
  getOCOOrderDetails(params: {
781
777
  orderId: string;
@@ -800,7 +796,7 @@ export declare class SpotClient extends BaseRestClient {
800
796
  symbol?: string;
801
797
  }): Promise<APISuccessResponse<{
802
798
  timestamp: number;
803
- items: any[];
799
+ items: MarginActivePairsV3[];
804
800
  }>>;
805
801
  /**
806
802
  * Get Margin Config
@@ -811,7 +807,7 @@ export declare class SpotClient extends BaseRestClient {
811
807
  /**
812
808
  * Get ETF Info
813
809
  *
814
- * This interface returns leveraged token information
810
+ * This endpoint returns leveraged token information
815
811
  */
816
812
  getMarginLeveragedToken(params?: {
817
813
  currency?: string;
@@ -846,15 +842,13 @@ export declare class SpotClient extends BaseRestClient {
846
842
  *
847
843
  * Place order to the Cross-margin or Isolated-margin trading system
848
844
  */
849
- submitHFMarginOrder(params: SubmitHFMarginOrderRequest): Promise<APISuccessResponse<{
850
- orderNo: string;
851
- }>>;
845
+ submitHFMarginOrder(params: SubmitHFMarginOrderRequest): Promise<APISuccessResponse<MarginSubmitOrderV3Response>>;
852
846
  /**
853
847
  * Add Order Test
854
848
  *
855
- * This interface is used to test the order submission.
849
+ * This endpoint is used to test the order submission.
856
850
  */
857
- submitHFMarginOrderTest(): Promise<any>;
851
+ submitHFMarginOrderTest(params: SubmitHFMarginOrderRequest): Promise<MarginSubmitOrderV3Response>;
858
852
  /**
859
853
  * Cancel Order By OrderId
860
854
  *
@@ -880,13 +874,16 @@ export declare class SpotClient extends BaseRestClient {
880
874
  /**
881
875
  * Cancel All Orders By Symbol
882
876
  *
883
- * This interface can cancel all open Margin orders by symbol
877
+ * This endpoint can cancel all open Margin orders by symbol
884
878
  */
885
- cancelHFAllMarginOrders(params: HFMarginOrder): Promise<any>;
879
+ cancelHFAllMarginOrders(params: {
880
+ symbol: string;
881
+ tradeType: string;
882
+ }): Promise<any>;
886
883
  /**
887
884
  * Get Symbols With Open Order
888
885
  *
889
- * This interface can query all Margin symbol that has active orders
886
+ * This endpoint can query all Margin symbol that has active orders
890
887
  */
891
888
  getHFMarginOpenSymbols(params: {
892
889
  tradeType: string;
@@ -897,17 +894,17 @@ export declare class SpotClient extends BaseRestClient {
897
894
  /**
898
895
  * Get Open Orders
899
896
  *
900
- * This interface is to obtain all Margin active order lists, and the return value of the active order interface is the paged data of all uncompleted order lists.
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.
901
898
  */
902
899
  getHFActiveMarginOrders(params: HFMarginRequestOrder): Promise<APISuccessResponse<HFMarginOrder[]>>;
903
900
  /**
904
901
  * Get Closed Orders
905
902
  *
906
- * This interface is to obtain all Margin Closed order lists
903
+ * This endpoint is to obtain all Margin Closed order lists
907
904
  */
908
905
  getHFMarginFilledOrders(params: GetHFMarginFilledRequest): Promise<APISuccessResponse<{
909
906
  lastId: number;
910
- items: HFMarginFilledOrder[];
907
+ items: HFMarginOrder[];
911
908
  }>>;
912
909
  /**
913
910
  * Get Trade History
@@ -952,7 +949,7 @@ export declare class SpotClient extends BaseRestClient {
952
949
  *
953
950
  * This API endpoint is used to get the borrowing orders for cross and isolated margin accounts
954
951
  */
955
- getMarginBorrowHistoryV3(params: MarginHistoryV3Request): Promise<APISuccessResponse<MarginHistoryRecord[]>>;
952
+ getMarginBorrowHistoryV3(params: MarginHistoryV3Request): Promise<APISuccessResponse<MarginBorrowHistoryV3[]>>;
956
953
  /**
957
954
  * Repay
958
955
  *
@@ -964,7 +961,7 @@ export declare class SpotClient extends BaseRestClient {
964
961
  *
965
962
  * This API endpoint is used to get the repayment orders for cross and isolated margin accounts
966
963
  */
967
- getMarginRepayHistoryV3(params: MarginHistoryV3Request): Promise<APISuccessResponse<MarginHistoryRecord[]>>;
964
+ getMarginRepayHistoryV3(params: MarginHistoryV3Request): Promise<APISuccessResponse<MarginRepayHistoryV3[]>>;
968
965
  /**
969
966
  * Get Interest History
970
967
  *
@@ -1124,7 +1121,9 @@ export declare class SpotClient extends BaseRestClient {
1124
1121
  * This endpoint retrieves ETH Staking products. If no ETH Staking products are available, an empty list is returned.
1125
1122
  *
1126
1123
  */
1127
- getEarnEthStakingProducts(): Promise<APISuccessResponse<EarnProduct[]>>;
1124
+ getEarnEthStakingProducts(params?: {
1125
+ currency: string;
1126
+ }): Promise<APISuccessResponse<EarnProduct[]>>;
1128
1127
  /**
1129
1128
  *
1130
1129
  * REST - VIP LENDING
@@ -1141,7 +1140,7 @@ export declare class SpotClient extends BaseRestClient {
1141
1140
  /**
1142
1141
  * Get Accounts - VIP Lending
1143
1142
  *
1144
- * Accounts participating in OTC lending, This interface is only for querying accounts currently running OTC lending.
1143
+ * Accounts participating in OTC lending, This endpoint is only for querying accounts currently running OTC lending.
1145
1144
  */
1146
1145
  getOtcLoanAccounts(): Promise<APISuccessResponse<OtcLoanAccount[]>>;
1147
1146
  /**
@@ -1154,11 +1153,7 @@ export declare class SpotClient extends BaseRestClient {
1154
1153
  *
1155
1154
  * This endpoint allows getting affiliate user rebate information.
1156
1155
  */
1157
- getAffiliateUserRebateInfo(params: {
1158
- date: string;
1159
- maxCount?: number;
1160
- offset: string;
1161
- }): Promise<APISuccessResponse<any>>;
1156
+ getAffiliateUserRebateInfo(): Promise<APISuccessResponse<any>>;
1162
1157
  /**
1163
1158
  *
1164
1159
  * REST - BROKER
@@ -1286,19 +1281,19 @@ export declare class SpotClient extends BaseRestClient {
1286
1281
  */
1287
1282
  /**
1288
1283
  * @deprecated This method is deprecated.
1289
- * It is recommended to use the HF trading endpoints instead of this endpoint
1284
+ * It is recommended to use the submitHFOrder() endpoint instead of this endpoint
1290
1285
  */
1291
1286
  submitOrder(params: SubmitOrderRequest): Promise<APISuccessResponse<{
1292
1287
  orderId: string;
1293
1288
  }>>;
1294
1289
  /**
1295
1290
  * @deprecated This method is deprecated.
1296
- * It is recommended to use the HF trading endpoints instead of this endpoint
1291
+ * It is recommended to use the submitHFOrderTest() endpoint instead of this endpoint
1297
1292
  */
1298
1293
  submitOrderTest(): Promise<any>;
1299
1294
  /**
1300
1295
  * @deprecated This method is deprecated.
1301
- * It is recommended to use the HF trading endpoints instead of this endpoint
1296
+ * It is recommended to use the submitMultipleHFOrders() endpoint instead of this endpoint
1302
1297
  */
1303
1298
  submitMultipleOrders(params: {
1304
1299
  symbol: string;
@@ -1306,7 +1301,7 @@ export declare class SpotClient extends BaseRestClient {
1306
1301
  }): Promise<APISuccessResponse<MultipleOrdersResponse[]>>;
1307
1302
  /**
1308
1303
  * @deprecated This method is deprecated.
1309
- * It is recommended to use the HF trading endpoints instead of this endpoint
1304
+ * It is recommended to use the cancelHFOrder() endpoint instead of this endpoint
1310
1305
  */
1311
1306
  cancelOrderById(params: {
1312
1307
  orderId: string;
@@ -1315,7 +1310,7 @@ export declare class SpotClient extends BaseRestClient {
1315
1310
  }>>;
1316
1311
  /**
1317
1312
  * @deprecated This method is deprecated.
1318
- * It is recommended to use the HF trading endpoints instead of this endpoint
1313
+ * It is recommended to use the cancelHFOrderByClientOid() endpoint instead of this endpoint
1319
1314
  */
1320
1315
  cancelOrderByClientOid(params: {
1321
1316
  clientOid: string;
@@ -1325,19 +1320,19 @@ export declare class SpotClient extends BaseRestClient {
1325
1320
  }>>;
1326
1321
  /**
1327
1322
  * @deprecated This method is deprecated.
1328
- * It is recommended to use the HF trading endpoints instead of this endpoint
1323
+ * It is recommended to use the cancelHFAllOrders() endpoint instead of this endpoint
1329
1324
  */
1330
1325
  cancelAllOrders(params?: CancelAllOrdersRequest): Promise<APISuccessResponse<{
1331
1326
  cancelledOrderIds: string[];
1332
1327
  }>>;
1333
1328
  /**
1334
1329
  * @deprecated This method is deprecated.
1335
- * It is recommended to use the HF trading endpoints instead of this endpoint
1330
+ * It is recommended to use the getHfOrderDetails() endpoint instead of this endpoint
1336
1331
  */
1337
1332
  getOrders(params?: GetOrderListRequest): Promise<APISuccessResponse<SpotOrderList>>;
1338
1333
  /**
1339
1334
  * @deprecated This method is deprecated.
1340
- * It is recommended to use the HF trading endpoints instead of this endpoint
1335
+ * It is recommended to use the getHFOrders() endpoint instead of this endpoint
1341
1336
  */
1342
1337
  getRecentOrders(params?: {
1343
1338
  currentPage?: number;
@@ -1345,14 +1340,14 @@ export declare class SpotClient extends BaseRestClient {
1345
1340
  }): Promise<APISuccessResponse<SpotOrder[]>>;
1346
1341
  /**
1347
1342
  * @deprecated This method is deprecated.
1348
- * It is recommended to use the HF trading endpoints instead of this endpoint
1343
+ * It is recommended to use the getHFOrderDetailsByOrderId() instead of this endpoint
1349
1344
  */
1350
1345
  getOrderByOrderId(params: {
1351
1346
  orderId: string;
1352
1347
  }): Promise<APISuccessResponse<SpotOrder>>;
1353
1348
  /**
1354
1349
  * @deprecated This method is deprecated.
1355
- * It is recommended to use the HF trading endpoints instead of this endpoint
1350
+ * It is recommended to use the getHFOrderDetailsByClientOid() instead of this endpoint
1356
1351
  */
1357
1352
  getOrderByClientOid(params: {
1358
1353
  clientOid: string;
@@ -1364,12 +1359,12 @@ export declare class SpotClient extends BaseRestClient {
1364
1359
  */
1365
1360
  /**
1366
1361
  * @deprecated This method is deprecated.
1367
- * It is recommended to use the HF trading endpoints instead of this endpoint
1362
+ * It is recommended to use the getHFFilledOrders() instead of this endpoint
1368
1363
  */
1369
1364
  getFills(params?: GetFillsRequest): Promise<APISuccessResponse<SpotOrderFills>>;
1370
1365
  /**
1371
1366
  * @deprecated This method is deprecated.
1372
- * It is recommended to use the HF trading endpoints instead of this endpoint
1367
+ * It is recommended to use the getHFFilledOrders() instead of this endpoint
1373
1368
  */
1374
1369
  getRecentFills(): Promise<APISuccessResponse<SpotOrderFill[]>>;
1375
1370
  /**