kucoin-api 2.6.3 → 2.6.4

package/dist/mjs/types/request/uta-types.d.ts

@@ -10,8 +10,15 @@ export interface GetAnnouncementsRequestUTA {
     endTime?: number;
 }
 export interface GetCurrencyRequestUTA {
-    currency?: string;
+    /** Required as of UTA V2 (2026.08.27) */
+    currency: string;
+    chain?: string;
+}
+export interface GetCurrenciesRequestUTA {
+    /** Lowercase chain identifier, e.g. trx */
     chain?: string;
+    /** Uppercase currency codes. Docs send repeated currencyList query params. */
+    currencyList?: string[] | string;
 }
 export interface GetSymbolRequestUTA {
     tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
@@ -37,10 +44,13 @@ export interface GetOrderBookRequestUTA {
     rpiFilter?: 0 | 1;
 }
 export interface GetFiatPriceRequestUTA {
-    /** Fiat base currency, e.g. USD, EUR. Default USD */
-    base?: string;
-    /** Comma-separated crypto symbols, e.g. BTC,ETH. Default returns all */
-    currencies?: string;
+    /** Fiat base currency, e.g. USD, EUR. Required as of UTA V2 (2026.08.27) */
+    base: string;
+    /**
+     * Crypto symbols. UTA V2 expects a string array (2026.08.27).
+     * Comma-separated string still accepted for older callers.
+     */
+    currencies?: string[] | string;
 }
 export interface GetRateLimitRequestUTA {
     /** Comma-separated UIDs to query */
@@ -56,12 +66,20 @@ export interface SetSubAccountsRateLimitRequestUTA {
 export interface GetKlinesRequestUTA {
     tradeType: 'SPOT' | 'FUTURES';
     symbol: string;
+    /**
+     * Replaces `{symbol}-index-price` / `-mark-price` / `-premium-index` suffixes (UTA V2 2026.08.27).
+     * Suffix encoding remains backward compatible.
+     */
+    klineType?: 'TRADE' | 'INDEX' | 'MARK' | 'PREMIUM' | string;
     interval: '1min' | '3min' | '5min' | '15min' | '30min' | '1hour' | '2hour' | '4hour' | '6hour' | '8hour' | '12hour' | '1day' | '1week' | '1month';
     startAt?: number;
     endAt?: number;
 }
 export interface GetCurrentFundingRateRequestUTA {
-    symbol: string;
+    /** Contract symbol. Optional when productType is set (UTA V2 2026.08.27). */
+    symbol?: string;
+    /** Product type when querying by category instead of a single symbol. */
+    productType?: 'COIN-FUTURES' | string;
 }
 export interface GetHistoryFundingRateRequestUTA {
     symbol: string;
@@ -80,6 +98,9 @@ export interface GetClassicAccountRequestUTA {
     currency?: string;
 }
 export interface GetSubAccountRequestUTA {
+    /** UTA V2 request field (2026.08.27). Up to 50 UIDs, comma-separated */
+    uid?: string;
+    /** @deprecated UTA V2 renamed to uid (2026.08.27) */
     UID?: string;
     pageSize?: number;
     lastId?: number;
@@ -93,10 +114,19 @@ export interface FlexTransferRequestUTA {
     clientOid: string;
     currency: string;
     amount: string;
-    type: '0' | '1' | '2' | '3';
+    /** UTA V2 transfer type (2026.08.27). Replaces numeric `type`. */
+    transferType?: 'INTERNAL' | 'PARENT_TO_SUB' | 'SUB_TO_PARENT' | 'SUB_TO_SUB';
+    /** @deprecated UTA V2 uses transferType: 0=INTERNAL, 1=PARENT_TO_SUB, 2=SUB_TO_PARENT, 3=SUB_TO_SUB */
+    type?: '0' | '1' | '2' | '3';
     fromAccountType: 'FUNDING' | 'SPOT' | 'FUTURES' | 'CROSS' | 'ISOLATED' | 'UNIFIED';
     toAccountType: 'FUNDING' | 'SPOT' | 'FUTURES' | 'CROSS' | 'ISOLATED' | 'UNIFIED';
+    /** UTA V2 required isolated-account tag (2026.08.27). Replaces fromAccountSymbol. */
+    fromAccountTag?: string;
+    /** UTA V2 required isolated-account tag (2026.08.27). Replaces toAccountSymbol. */
+    toAccountTag?: string;
+    /** @deprecated UTA V2 uses fromAccountTag */
     fromAccountSymbol?: string;
+    /** @deprecated UTA V2 uses toAccountTag */
     toAccountSymbol?: string;
     fromUid?: string;
     toUid?: string;
@@ -157,13 +187,22 @@ export interface GetDepositAddressRequestUTA {
 }
 export interface GetWithdrawalQuotasRequestUTA {
     currency: string;
+    /** UTA V2 chain identifier (2026.08.27). Replaces chainId. */
+    chain?: string;
+    /** @deprecated UTA V2 renamed to chain */
     chainId?: string;
+    /** Required as of UTA V2 (2026.08.27) */
+    withdrawType?: 'ADDRESS' | 'UID' | 'MAIL' | 'PHONE';
+    isInner?: boolean;
 }
 export interface SubmitWithdrawRequestUTA {
     currency: string;
     toAddress: string;
     amount: string;
     withdrawType: 'ADDRESS' | 'UID' | 'MAIL' | 'PHONE';
+    /** UTA V2 chain identifier (2026.08.27). Replaces chainId. */
+    chain?: string;
+    /** @deprecated UTA V2 renamed to chain */
     chainId?: string;
     memo?: string;
     isInner?: boolean;
@@ -215,6 +254,8 @@ export interface PlaceOrderRequestUTA {
     autoBorrow?: boolean;
     autoRepay?: boolean;
     tags?: string;
+    /** Broker tag, max 50 chars. Decoupled from capped tags (2026.09.21) */
+    brokerTag?: string;
     triggerDirection?: 'DOWN' | 'UP';
     triggerPrice?: string;
     triggerPriceType?: 'TP' | 'IP' | 'MP';
@@ -264,6 +305,20 @@ export interface GetTradeHistoryRequestUTA {
     endAt?: number;
     lastId?: string;
     pageSize?: number;
+    /** Query all trade kinds (UTA V2 2026.08.27), e.g. NORMAL / ADL / LIQUID / SETTLEMENT */
+    fillType?: string;
+}
+export interface AmendOrderRequestUTA {
+    symbol: string;
+    orderId?: string;
+    clientOid?: string;
+    newPrice?: number | string;
+    newSize?: number | string;
+    tpTriggerPrice?: string;
+    slTriggerPrice?: string;
+}
+export interface GetIndexPriceRequestUTA {
+    symbol: string;
 }
 export interface CancelOrderRequestUTA {
     tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';

package/dist/mjs/types/response/broker.types.d.ts

@@ -104,3 +104,24 @@ export interface BrokerWithdrawalRecord {
     createdAt: number;
     updatedAt: number;
 }
+export interface SetBrokerMarkupFeeResponse {
+    effectiveType: string;
+    subUids: string | null;
+    tradeType: string;
+    makerMarkUp: string;
+    takerMarkUp: string;
+    effectAt: number;
+    createdAt: number;
+}
+export interface BrokerMarkupFeeItem {
+    uid?: number;
+    spotMakerMarkUp: string;
+    spotTakerMarkUp: string;
+    futuresMakerMarkUp: string;
+    futuresTakerMarkUp: string;
+    updatedAt: number;
+}
+export interface GetBrokerMarkupFeeResponse {
+    defaultMarkUp: BrokerMarkupFeeItem;
+    items: BrokerMarkupFeeItem[];
+}

package/dist/mjs/types/response/futures.types.d.ts

@@ -186,6 +186,10 @@ export interface FuturesSymbolInfo {
     mmrLimit: number;
     mmrLevConstant: number;
     supportCross: boolean;
+    assetClass?: string;
+    subMarketType?: string;
+    /** @deprecated Prefer assetClass and subMarketType (2026.09.21) */
+    marketType?: string;
 }
 export interface TickerDetail {
     sequence: number;

package/dist/mjs/types/response/spot-trading.d.ts

@@ -67,6 +67,10 @@ export interface SymbolInfo {
     callauctionSecondStageStartTime: number | null;
     callauctionThirdStageStartTime: number | null;
     tradingStartTime: number | null;
+    assetClass?: string;
+    subMarketType?: string;
+    /** @deprecated Prefer assetClass and subMarketType (2026.09.21) */
+    marketType?: string;
 }
 export interface Ticker {
     sequence: string;

package/dist/mjs/types/response/uta-types.d.ts

@@ -25,26 +25,43 @@ export interface CurrencyChainUTA {
     minWithdrawFee: string;
     isWithdrawEnabled: boolean;
     isDepositEnabled: boolean;
-    confirms: number;
+    confirms?: number;
     preConfirms: number;
-    contractAddress: string;
+    contractAddress?: string;
     withdrawPrecision: number;
     maxWithdrawSize: string | null;
     maxDepositSize: string | null;
     needTag: boolean;
-    chainId: string;
+    /** @deprecated UTA V2 renamed to chain (2026.08.27) */
+    chainId?: string;
+    /** UTA V2 chain identifier (2026.08.27). Replaces chainId. */
+    chain?: string;
+    addressRegex?: string;
+    memoRegex?: string;
+    depositFeeRate?: string;
+    depositTierFee?: string;
+    fixedDepositFee?: string;
+    maxDepositFee?: string;
+    maxWithdrawFee?: string;
+    isMemoRequired?: boolean;
 }
 export interface GetCurrencyResponseUTA {
     currency: string;
     name: string;
     fullName: string;
     precision: number;
-    confirms: number | null;
-    contractAddress: string | null;
-    isMarginEnabled: boolean;
-    isDebitEnabled: boolean;
+    confirms?: number | null;
+    contractAddress?: string | null;
+    /** Removed from UTA V2 Get Currencies currency-level payload (2026.08.27) */
+    isMarginEnabled?: boolean;
+    /** Removed from UTA V2 Get Currencies currency-level payload (2026.08.27) */
+    isDebitEnabled?: boolean;
+    /** UTA V2 chain list (2026.08.27). Replaces items. */
     list: CurrencyChainUTA[];
+    /** @deprecated UTA V2 renamed to list */
+    items?: CurrencyChainUTA[];
 }
+export type GetCurrenciesResponseUTA = GetCurrencyResponseUTA[];
 export interface SymbolUTA {
     symbol: string;
     name?: string;
@@ -59,10 +76,11 @@ export interface SymbolUTA {
     quoteOrderStep?: string;
     tickSize?: string | number;
     feeCurrency?: string;
-    tradingStatus?: string;
+    tradingStatus?: string | 'TradingEnabled' | 'TradingDisabled' | 'Init' | 'Open' | 'PrepareSettled' | 'BeingSettled' | 'Settled' | 'Paused' | 'Closed' | 'CancelOnly';
     marginMode?: string;
     priceLimitRatio?: string;
-    feeCategory?: number;
+    /** UTA V2: classA / classB / classC. Numeric 1/2/3 remains on older payloads. */
+    feeCategory?: number | 'classA' | 'classB' | 'classC' | string;
     makerFeeCoefficient?: string;
     takerFeeCoefficient?: string;
     st?: boolean;
@@ -70,8 +88,8 @@ export interface SymbolUTA {
     contractType?: string;
     isInverse?: boolean;
     launchTime?: number;
-    expiryTime?: number | null;
-    settlementTime?: number | null;
+    expiryTime?: number | string | null;
+    settlementTime?: number | string | null;
     maxPrice?: string | number;
     lotSize?: string | number;
     /**
@@ -83,7 +101,7 @@ export interface SymbolUTA {
     makerFeeRate?: string | number;
     takerFeeRate?: string | number;
     settlementFeeRate?: string | number | null;
-    maxLeverage?: number;
+    maxLeverage?: number | string;
     indexSourceExchanges?: string[];
     k?: string | number;
     m?: string | number;
@@ -100,6 +118,16 @@ export interface SymbolUTA {
     displaySymbol?: string;
     /** Display base currency for Futures (added 2025.12.26 & 2026.01.12) */
     displayBaseCurrency?: string;
+    maxMarketOrderSize?: string;
+    preMarketToPerpDate?: number | string | null;
+    minFunds?: string;
+    callauctionIsEnabled?: boolean;
+    callauctionPriceFloor?: string | null;
+    callauctionPriceCeiling?: string | null;
+    callauctionFirstStageStartTime?: number | string | null;
+    callauctionSecondStageStartTime?: number | string | null;
+    callauctionThirdStageStartTime?: number | string | null;
+    tradingStartTime?: number | string | null;
 }
 export interface GetSymbolResponseUTA {
     tradeType: string;
@@ -180,10 +208,10 @@ export interface GetKlinesResponseUTA {
 }
 export interface GetCurrentFundingRateResponseUTA {
     symbol: string;
-    nextFundingRate: number;
+    nextFundingRate: number | string;
     fundingTime: number;
-    fundingRateCap: number;
-    fundingRateFloor: number;
+    fundingRateCap: number | string;
+    fundingRateFloor: number | string;
     /** Current funding settlement interval (ms); as of 2026.04.19 */
     currentGranularity: number;
     /** New interval after change (ms); as of 2026.04.19 */
@@ -191,6 +219,21 @@ export interface GetCurrentFundingRateResponseUTA {
     /** When newGranularity takes effect (ms); as of 2026.04.19 */
     newGranularityStartTime: number;
 }
+export interface GetIndexPriceDecompositionUTA {
+    exchange: string;
+    price: string;
+    weight: string;
+}
+export interface GetIndexPriceItemUTA {
+    symbol: string;
+    granularity: number;
+    ts: number;
+    indexPrice: string;
+    decompositionList?: GetIndexPriceDecompositionUTA[];
+}
+export interface GetIndexPriceResponseUTA {
+    items: GetIndexPriceItemUTA[];
+}
 export interface FundingRateHistoryItemUTA {
     fundingRate: number;
     ts: number;
@@ -252,7 +295,10 @@ export interface GetServiceStatusResponseUTA {
  */
 export interface AccountCurrencyUTA {
     currency: string;
-    hold: string;
+    /** @deprecated UTA V2 renamed to locked (2026.08.27) */
+    hold?: string;
+    /** UTA V2 locked amount (2026.08.27). Replaces hold. */
+    locked?: string;
     available: string;
     balance: string;
     equity: string;
@@ -269,7 +315,9 @@ export interface AccountCurrencyUTA {
     isolatedOrderMargin?: string;
     isolatedFundingFeeMargin?: string;
     isolatedUnPnl?: string;
+    /** @deprecated UTA V2 renamed to liabilityPrincipal (2026.08.27) */
     liabilityPrinciple?: string;
+    liabilityPrincipal?: string;
     liabilityInterest?: string;
     unrealisedPnl?: string;
 }
@@ -295,11 +343,28 @@ export interface GetAccountOverviewResponseUTA {
 }
 export interface SubAccountUserUTA {
     uid: number;
-    accountList: {
+    /** @deprecated UTA V2 renamed to accounts (2026.08.27) */
+    accountList?: {
         accountType: 'FUNDING' | 'SPOT' | 'FUTURES' | 'CROSS' | 'ISOLATED' | 'OPTIONS' | 'UNIFIED';
         accountSubType: string | null;
         currencyList: AccountCurrencyUTA[];
     }[];
+    /** UTA V2 accounts list (2026.08.27). Replaces accountList. OPTIONS removed. */
+    accounts?: {
+        accountType: 'FUNDING' | 'SPOT' | 'FUTURES' | 'CROSS' | 'ISOLATED' | 'UNIFIED';
+        /** UTA V2 renamed from accountSubType */
+        subAccountType?: string | null;
+        /** @deprecated UTA V2 renamed to subAccountType */
+        accountSubType?: string | null;
+        /** UTA V2 renamed from currencyList */
+        currencies?: AccountCurrencyUTA[];
+        /** @deprecated UTA V2 renamed to currencies */
+        currencyList?: AccountCurrencyUTA[];
+        /** UTA V2 renamed from liabilityPrinciple */
+        liabilityPrincipal?: string;
+        /** @deprecated UTA V2 renamed to liabilityPrincipal */
+        liabilityPrinciple?: string;
+    }[];
 }
 export interface GetSubAccountResponseUTA {
     ts: number;
@@ -366,14 +431,20 @@ export interface GetInterestHistoryResponseUTA {
 }
 export interface DepositAddressUTA {
     address: string;
-    memo: string;
-    chainId: string;
-    to: 'FUNDING' | 'SPOT' | 'UNIFIED';
+    memo?: string;
+    /** @deprecated UTA V2 renamed to chain (2026.08.27) */
+    chainId?: string;
+    /** UTA V2 chain identifier (2026.08.27). Replaces chainId. */
+    chain?: string;
+    /** @deprecated UTA V2 renamed to toAccountType (2026.08.27) */
+    to?: 'FUNDING' | 'SPOT' | 'UNIFIED';
+    /** UTA V2 destination account type (2026.08.27). Replaces to. */
+    toAccountType?: 'FUNDING' | 'SPOT' | 'UNIFIED';
     currency: string;
     contractAddress: string;
     chainName: string;
     expirationDate: string;
-    remark: string;
+    remark?: string;
 }
 export interface WithdrawalQuotasUTA {
     currency: string;
@@ -382,16 +453,27 @@ export interface WithdrawalQuotasUTA {
     quotaCurrency: string;
     limitQuotaCurrencyAmount: string;
     usedQuotaCurrencyAmount: string;
-    remainAmount: string;
-    availableAmount: string;
-    withdrawMinFee: string;
-    innerWithdrawMinFee: string;
+    remainAmount?: string;
+    availableAmount?: string;
+    withdrawMinFee?: string;
+    innerWithdrawMinFee?: string;
+    /** UTA V2 remaining quota (2026.08.27). Replaces remainAmount. */
+    remainingQuotaAmount?: string;
+    /** UTA V2 available withdraw amount (2026.08.27). Replaces availableAmount. */
+    availableWithdrawAmount?: string;
+    /** UTA V2 min withdraw fee (2026.08.27). Replaces withdrawMinFee. */
+    minWithdrawFee?: string;
+    /** UTA V2 min inner withdraw fee (2026.08.27). Replaces innerWithdrawMinFee. */
+    minInnerWithdrawFee?: string;
     withdrawMinSize: string;
     isWithdrawEnabled: boolean;
     precision: number;
     reason: string | null;
     lockedAmount: string;
-    chainId: string;
+    /** @deprecated UTA V2 renamed to chain (2026.08.27) */
+    chainId?: string;
+    /** UTA V2 chain identifier (2026.08.27). Replaces chainId. */
+    chain?: string;
     chainName: string;
 }
 export interface SubmitWithdrawResponseUTA {
@@ -497,7 +579,8 @@ export interface OrderDetailsUTA {
      * Time in Force. Added 'RPI' as of 2025.01.02
      */
     timeInForce: 'GTC' | 'IOC' | 'GTT' | 'FOK' | 'RPI';
-    cancelReason?: number;
+    /** UTA V1+V2: enum value instead of descriptive cancellation reason (2026.08.27) */
+    cancelReason?: number | string;
     cancelSize: string;
     cancelAfter?: number;
     triggerDirection?: 'UP' | 'DOWN';
@@ -511,6 +594,8 @@ export interface OrderDetailsUTA {
     slOrderPrice?: string;
     postOnly?: boolean;
     tags?: string;
+    /** Broker tag, max 50 chars (2026.09.21) */
+    brokerTag?: string;
     triggerOrderId?: string;
     /** Order creation time in nanoseconds (standardized as of 2026.01.12) */
     orderTime: number;
@@ -555,6 +640,19 @@ export interface TradeHistoryItemUTA {
     executionTime: number;
     /** Whether it is an RPI trade (added 2025.01.02, Futures only) */
     isRpiTrade?: boolean;
+    /**
+     * Fill PnL. Empty string when data is before 2026.09.05 (UTC-8) (2026.09.21).
+     * When fillType is ADL/LIQUID/SETTLEMENT, size is a positive value (2026.08.20).
+     */
+    fillPnl?: string;
+    clientOid?: string;
+    marginMode?: 'ISOLATED' | 'CROSS';
+    tradeType?: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';
+    orderType?: 'LIMIT' | 'MARKET';
+}
+export interface AmendOrderResponseUTA {
+    orderId: string;
+    clientOid: string | null;
 }
 export interface GetTradeHistoryResponseUTA {
     lastId: number;

package/dist/mjs/types/websockets/ws-events.d.ts

@@ -77,10 +77,73 @@ export interface WsUTAFundingFeePublicPush {
         s: string;
         fR?: string;
         fT?: number;
+        /** Current funding rate (UTA V2 `funding-fee` channel) */
+        fr?: string;
+        /** Funding time (UTA V2) */
+        ft?: number;
+        /** Last settled funding fee rate (UTA V2 2026.08.27) */
+        lfr?: string;
+        nt?: number;
+        gl?: number;
+        fc?: string;
+        ff?: string;
         M?: number;
         [key: string]: string | number | boolean | undefined;
     };
 }
+/**
+ * UTA WebSocket public All Funding Fee Rates channel (`channel: funding-fee-all-symbols`).
+ * Added 2026.08.27.
+ * @see https://www.kucoin.com/docs-new/3470412w0
+ */
+export interface WsUTAAllFundingFeeRatesPublicPush {
+    T: string;
+    P: number;
+    d: WsUTAFundingFeePublicPush['d'][];
+}
+/**
+ * UTA WebSocket private execution push (`channel: execution`).
+ * Field `fP` added 2026.09.21. Empty before 2026.09.05 (UTC-8).
+ * When fT is ADL/LIQUID/SETTLEMENT, q is a positive value (2026.08.20).
+ * @see https://www.kucoin.com/docs-new/3470407w0
+ */
+export interface WsUTAExecutionPushData {
+    oi?: string;
+    s?: string;
+    S?: string;
+    oT?: string;
+    p?: string;
+    q?: string;
+    ti?: string;
+    E?: number;
+    lR?: string;
+    f?: string;
+    fC?: string;
+    fT?: string;
+    ci?: string;
+    /** Fill PnL. Empty string when data is before 2026.09.05 (UTC-8) */
+    fP?: string;
+    [key: string]: string | number | boolean | undefined;
+}
+export interface WsUTAExecutionPush {
+    T: string;
+    P: number;
+    d: WsUTAExecutionPushData;
+}
+/**
+ * UTA WebSocket private order push (`channel: order` / `orderAll`).
+ * Field `brokerTag` added 2026.09.21.
+ * @see https://www.kucoin.com/docs-new/3470228w0
+ */
+export interface WsUTAOrderPushData {
+    brokerTag?: string;
+    [key: string]: string | number | boolean | undefined;
+}
+export interface WsUTAOrderPush {
+    T: string;
+    P: number;
+    d: WsUTAOrderPushData;
+}
 /**
  * UTA WebSocket public Mark Price channel (`channel: markPrice`, FUTURES).
  * Added 2026.07.01.