kucoin-api 2.6.2 → 2.6.4

package/dist/mjs/UnifiedAPIClient.d.ts

@@ -1,8 +1,8 @@
 import { BaseRestClient } from './lib/BaseRestClient.js';
 import type { RestClientType } from './lib/requestUtils.js';
-import type { AddSubAccountApiRequestUTA, AddSubAccountRequestUTA, BatchCancelOrdersBySymbolRequestUTA, BatchCancelOrdersRequestUTA, BatchModifyMarginModeRequestUTA, BatchPlaceOrderRequestUTA, CancelOrderRequestUTA, FlexTransferRequestUTA, GetAccountLedgerRequestUTA, GetAccountPositionTiersRequestUTA, GetAnnouncementsRequestUTA, GetBorrowingRatesAndLimitsRequestUTA, GetCallAuctionInfoRequestUTA, GetClassicAccountRequestUTA, GetCurrencyRequestUTA, GetCurrentFundingRateRequestUTA, GetDCPRequestUTA, GetDepositAddressRequestUTA, GetDepositHistoryRequestUTA, GetFeeRateRequestUTA, GetFiatPriceRequestUTA, GetHistoryFundingRateRequestUTA, GetInterestHistoryRequestUTA, GetInterestRateIndexRequestUTA, GetKlinesRequestUTA, GetLeverageRequestUTA, GetOpenOrderListRequestUTA, GetOrderBookRequestUTA, GetOrderDetailsRequestUTA, GetOrderHistoryRequestUTA, GetPositionListRequestUTA, GetPositionsHistoryRequestUTA, GetPrivateFundingFeeHistoryRequestUTA, GetRateLimitRequestUTA, GetServiceStatusRequestUTA, GetSubAccountListRequestUTA, GetSubAccountRequestUTA, GetSymbolRequestUTA, GetThirdPartyCustodyCurrenciesRequestUTA, GetThirdPartyCustodyQuotaRequestUTA, GetTickerRequestUTA, GetTradeHistoryRequestUTA, GetTradesRequestUTA, GetTransferQuotasRequestUTA, GetWithdrawalHistoryRequestUTA, GetWithdrawalQuotasRequestUTA, ModifyIsolatedFuturesMarginRequestUTA, ModifyLeverageRequestUTA, ModifyMarginCrossLeverageRequestUTA, PlaceOrderRequestUTA, SetAccountModeRequestUTA, SetDCPRequestUTA, SetKcsFeeDeductionRequestUTA, SetSubAccountsRateLimitRequestUTA, SetSubAccountTransferPermissionRequestUTA, SubmitWithdrawRequestUTA } from './types/request/uta-types.js';
+import type { AddSubAccountApiRequestUTA, AddSubAccountRequestUTA, AmendOrderRequestUTA, BatchCancelOrdersBySymbolRequestUTA, BatchCancelOrdersRequestUTA, BatchModifyMarginModeRequestUTA, BatchPlaceOrderRequestUTA, CancelOrderRequestUTA, FlexTransferRequestUTA, GetAccountLedgerRequestUTA, GetAccountPositionTiersRequestUTA, GetAnnouncementsRequestUTA, GetBorrowingRatesAndLimitsRequestUTA, GetCallAuctionInfoRequestUTA, GetClassicAccountRequestUTA, GetCurrenciesRequestUTA, GetCurrencyRequestUTA, GetCurrentFundingRateRequestUTA, GetDCPRequestUTA, GetDepositAddressRequestUTA, GetDepositHistoryRequestUTA, GetFeeRateRequestUTA, GetFiatPriceRequestUTA, GetHistoryFundingRateRequestUTA, GetIndexPriceRequestUTA, GetInterestHistoryRequestUTA, GetInterestRateIndexRequestUTA, GetKlinesRequestUTA, GetLeverageRequestUTA, GetOpenOrderListRequestUTA, GetOrderBookRequestUTA, GetOrderDetailsRequestUTA, GetOrderHistoryRequestUTA, GetPositionListRequestUTA, GetPositionsHistoryRequestUTA, GetPrivateFundingFeeHistoryRequestUTA, GetRateLimitRequestUTA, GetServiceStatusRequestUTA, GetSubAccountListRequestUTA, GetSubAccountRequestUTA, GetSymbolRequestUTA, GetThirdPartyCustodyCurrenciesRequestUTA, GetThirdPartyCustodyQuotaRequestUTA, GetTickerRequestUTA, GetTradeHistoryRequestUTA, GetTradesRequestUTA, GetTransferQuotasRequestUTA, GetWithdrawalHistoryRequestUTA, GetWithdrawalQuotasRequestUTA, ModifyIsolatedFuturesMarginRequestUTA, ModifyLeverageRequestUTA, ModifyMarginCrossLeverageRequestUTA, PlaceOrderRequestUTA, SetAccountModeRequestUTA, SetDCPRequestUTA, SetKcsFeeDeductionRequestUTA, SetSubAccountsRateLimitRequestUTA, SetSubAccountTransferPermissionRequestUTA, SubmitWithdrawRequestUTA } from './types/request/uta-types.js';
 import type { APISuccessResponse } from './types/response/shared.types.js';
-import type { AddSubAccountApiResponseUTA, AddSubAccountResponseUTA, ApiKeyInfoUTA, BatchCancelOrdersBySymbolResponseUTA, BatchCancelOrdersResponseUTA, BatchModifyMarginModeResponseUTA, BatchPlaceOrderResponseUTA, BorrowableCurrencyUTA, CancelOrderResponseUTA, DCPResponseUTA, DepositAddressUTA, FlexTransferResponseUTA, GetAccountLedgerResponseClassicUTA, GetAccountLedgerResponseUTA, GetAccountModeResponseUTA, GetAccountOverviewResponseUTA, GetAnnouncementsResponseUTA, GetBorrowingRatesAndLimitsResponseUTA, GetCallAuctionInfoResponseUTA, GetClassicAccountResponseUTA, GetCrossMarginConfigResponseUTA, GetCurrencyResponseUTA, GetCurrentFundingRateResponseUTA, GetDepositHistoryResponseUTA, GetFeeRateResponseUTA, GetFiatPriceResponseUTA, GetHistoryFundingRateResponseUTA, GetInterestHistoryResponseUTA, GetInterestRateIndexResponseUTA, GetKlinesResponseUTA, GetLeverageItemUTA, GetOpenOrderListResponseUTA, GetOrderBookResponseUTA, GetOrderHistoryResponseUTA, GetPositionsHistoryResponseUTA, GetPrivateFundingFeeHistoryResponseUTA, GetRateLimitCapResponseUTA, GetRateLimitResponseUTA, GetServiceStatusResponseUTA, GetSubAccountListResponseUTA, GetSubAccountResponseUTA, GetSymbolResponseUTA, GetTickerResponseUTA, GetTradeHistoryResponseUTA, GetTradesResponseUTA, GetTradeStatisticsResponseUTA, GetTransferQuotasResponseUTA, GetWithdrawalHistoryResponseUTA, KYCRegionUTA, ModifyIsolatedFuturesMarginResponseUTA, ModifyMarginCrossLeverageResponseUTA, OrderDetailsUTA, PlaceOrderResponseUTA, PositionTierUTA, PositionUTA, SetKcsFeeDeductionResponseUTA, SetSubAccountsRateLimitResponseUTA, SubAccountTransferPermissionUTA, SubmitWithdrawResponseUTA, ThirdPartyCustodyCurrencyUTA, ThirdPartyCustodyQuotaUTA, WithdrawalQuotasUTA } from './types/response/uta-types.js';
+import type { AddSubAccountApiResponseUTA, AddSubAccountResponseUTA, AmendOrderResponseUTA, ApiKeyInfoUTA, BatchCancelOrdersBySymbolResponseUTA, BatchCancelOrdersResponseUTA, BatchModifyMarginModeResponseUTA, BatchPlaceOrderResponseUTA, BorrowableCurrencyUTA, CancelOrderResponseUTA, DCPResponseUTA, DepositAddressUTA, FlexTransferResponseUTA, GetAccountLedgerResponseClassicUTA, GetAccountLedgerResponseUTA, GetAccountModeResponseUTA, GetAccountOverviewResponseUTA, GetAnnouncementsResponseUTA, GetBorrowingRatesAndLimitsResponseUTA, GetCallAuctionInfoResponseUTA, GetClassicAccountResponseUTA, GetCrossMarginConfigResponseUTA, GetCurrenciesResponseUTA, GetCurrencyResponseUTA, GetCurrentFundingRateResponseUTA, GetDepositHistoryResponseUTA, GetFeeRateResponseUTA, GetFiatPriceResponseUTA, GetHistoryFundingRateResponseUTA, GetIndexPriceResponseUTA, GetInterestHistoryResponseUTA, GetInterestRateIndexResponseUTA, GetKlinesResponseUTA, GetLeverageItemUTA, GetOpenOrderListResponseUTA, GetOrderBookResponseUTA, GetOrderHistoryResponseUTA, GetPositionsHistoryResponseUTA, GetPrivateFundingFeeHistoryResponseUTA, GetRateLimitCapResponseUTA, GetRateLimitResponseUTA, GetServiceStatusResponseUTA, GetSubAccountListResponseUTA, GetSubAccountResponseUTA, GetSymbolResponseUTA, GetTickerResponseUTA, GetTradeHistoryResponseUTA, GetTradesResponseUTA, GetTradeStatisticsResponseUTA, GetTransferQuotasResponseUTA, GetWithdrawalHistoryResponseUTA, KYCRegionUTA, ModifyIsolatedFuturesMarginResponseUTA, ModifyMarginCrossLeverageResponseUTA, OrderDetailsUTA, PlaceOrderResponseUTA, PositionTierUTA, PositionUTA, SetKcsFeeDeductionResponseUTA, SetSubAccountsRateLimitResponseUTA, SubAccountTransferPermissionUTA, SubmitWithdrawResponseUTA, ThirdPartyCustodyCurrencyUTA, ThirdPartyCustodyQuotaUTA, WithdrawalQuotasUTA } from './types/response/uta-types.js';
 /**
  * Unified Trading Account Client
  *
@@ -26,7 +26,12 @@ export declare class UnifiedAPIClient extends BaseRestClient {
      * Get Currency
      * Request the currency details of a specified currency via this endpoint.
      */
-    getCurrency(params?: GetCurrencyRequestUTA): Promise<APISuccessResponse<GetCurrencyResponseUTA>>;
+    getCurrency(params: GetCurrencyRequestUTA): Promise<APISuccessResponse<GetCurrencyResponseUTA>>;
+    /**
+     * Get Currencies
+     * Currency and chain-level deposit/withdrawal configuration.
+     */
+    getCurrencies(params?: GetCurrenciesRequestUTA): Promise<APISuccessResponse<GetCurrenciesResponseUTA>>;
     /**
      * Get Third-Party Custody Currencies
      * Query settlement currencies supported by third-party (OES) custodian institutions.
@@ -57,11 +62,16 @@ export declare class UnifiedAPIClient extends BaseRestClient {
      * Get the Kline of the symbol. Data are returned in grouped buckets based on requested type.
      */
     getKlines(params: GetKlinesRequestUTA): Promise<APISuccessResponse<GetKlinesResponseUTA>>;
+    /**
+     * Get Index Price
+     * Index price snapshots (updated once per second).
+     */
+    getIndexPrice(params: GetIndexPriceRequestUTA): Promise<APISuccessResponse<GetIndexPriceResponseUTA>>;
     /**
      * Get Current Funding Rate
      * Get current Futures funding fee rate.
      */
-    getCurrentFundingRate(params: GetCurrentFundingRateRequestUTA): Promise<APISuccessResponse<GetCurrentFundingRateResponseUTA>>;
+    getCurrentFundingRate(params?: GetCurrentFundingRateRequestUTA): Promise<APISuccessResponse<GetCurrentFundingRateResponseUTA | GetCurrentFundingRateResponseUTA[]>>;
     /**
      * Get History Funding Rate
      * Query the Futures funding rate at each settlement time point within a certain time range.
@@ -91,7 +101,7 @@ export declare class UnifiedAPIClient extends BaseRestClient {
      * Get Fiat Price (UTA)
      * Request the fiat price of currencies for available trading pairs. Added 2026.07.01.
      */
-    getFiatPrice(params?: GetFiatPriceRequestUTA): Promise<APISuccessResponse<GetFiatPriceResponseUTA>>;
+    getFiatPrice(params: GetFiatPriceRequestUTA): Promise<APISuccessResponse<GetFiatPriceResponseUTA>>;
     /**
      * Get Interest Rate Index (UTA)
      * Interest rate index records by symbol. Added 2026.07.17.
@@ -203,7 +213,7 @@ export declare class UnifiedAPIClient extends BaseRestClient {
      * Modify Leverage Margin Cross (UTA)
      * Update leverage for a currency in UTA cross margin.
      */
-    modifyMarginCrossLeverage(params: ModifyMarginCrossLeverageRequestUTA, accountMode?: 'unified'): Promise<APISuccessResponse<ModifyMarginCrossLeverageResponseUTA>>;
+    modifyMarginCrossLeverage(params: ModifyMarginCrossLeverageRequestUTA, accountMode?: 'classic' | 'unified'): Promise<APISuccessResponse<ModifyMarginCrossLeverageResponseUTA>>;
     /**
      * Get Leverage (UTA)
      * Query leverage for MARGIN (currency) or FUTURES (symbol).
@@ -213,7 +223,7 @@ export declare class UnifiedAPIClient extends BaseRestClient {
      * Get Deposit Address
      * Return a deposit address; when both currency and chain are provided,
      * the address will be created if it does not exist.
-     * URL unified to GET /api/ua/v1/asset/deposit/address as of 2026.01.17.
+     * URL unified to GET /api/ua/v2/asset/deposit/address as of 2026.01.17.
      */
     getDepositAddress(params: GetDepositAddressRequestUTA): Promise<APISuccessResponse<DepositAddressUTA[]>>;
     /**
@@ -309,10 +319,15 @@ export declare class UnifiedAPIClient extends BaseRestClient {
      * Note: closeOrder supported for closing futures position by symbol.
      */
     placeOrder(params: PlaceOrderRequestUTA, accountMode?: 'classic' | 'unified'): Promise<APISuccessResponse<PlaceOrderResponseUTA>>;
+    /**
+     * Amend Order
+     * Modify price, size, or TP/SL trigger prices. Futures only. Provide orderId or clientOid.
+     */
+    amendOrder(params: AmendOrderRequestUTA): Promise<APISuccessResponse<AmendOrderResponseUTA>>;
     /**
      * Batch Place Order (Classic)
      * This interface can be used for placing batch orders.
-     * URL changed to /api/ua/v1/{accountMode}/order/place-batch as of 2026.01.17.
+     * URL changed to /api/ua/v2/{accountMode}/order/place-batch as of 2026.01.17.
      * Note: timeInForce supports 'RPI' value for Futures as of 2025.01.02.
      */
     batchPlaceOrder(params: BatchPlaceOrderRequestUTA, accountMode?: 'classic' | 'unified'): Promise<APISuccessResponse<BatchPlaceOrderResponseUTA>>;