kucoin-api 2.5.1 → 2.5.3

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

@@ -43,6 +43,7 @@ export interface BrokerSubAccountApi {
 }
 export type BrokerTransferAccountType = 'MAIN' | 'TRADE' | 'CONTRACT' | 'MARGIN' | 'ISOLATED';
 export type BrokerTransferStatus = 'PROCESSING' | 'SUCCESS' | 'FAILURE';
+export type BrokerDepositStatus = 'PROCESSING' | 'SUCCESS' | 'FAILURE' | 'PRE_SUCCESS' | 'WAIT_TRM_MGT' | 'TRM_MGT_REJECTED' | 'ROLLBACKING' | 'ROLLBACK' | 'WAIT_RISK_MGT' | 'RISK_MGT_REJECTED';
 export interface BrokerTransferHistory {
     orderId: string;
     currency: string;
@@ -67,12 +68,25 @@ export interface BrokerDepositRecord {
     currency: string;
     isInner: boolean;
     walletTxId: string;
-    status: BrokerTransferStatus;
+    status: BrokerDepositStatus;
     remark: string;
     chain: string;
     createdAt: number;
     updatedAt: number;
+    statusRemark?: string;
+    preConfirms?: number;
+    confirms?: number;
+    currentConfirms?: number;
+}
+export interface FastApiWithdrawApplyInitialResponse {
+    transactionId: string;
+    allFactors: string[][];
+    sentFactors: string[][];
+}
+export interface FastApiWithdrawApplyCompleteResponse {
+    withdrawalId: string;
 }
+export type FastApiWithdrawApplyResponse = FastApiWithdrawApplyInitialResponse | FastApiWithdrawApplyCompleteResponse;
 export type BrokerWithdrawalStatus = 'PROCESSING' | 'WALLET_PROCESSING' | 'REVIEW' | 'SUCCESS' | 'FAILURE';
 export interface BrokerWithdrawalRecord {
     id: string;

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

@@ -362,7 +362,7 @@ export interface FuturesFill {
     settleCurrency: string;
     orderType: 'market' | 'limit';
     displayType: 'limit' | 'market' | 'limit_stop' | 'market_stop';
-    tradeType: 'trade' | 'cancel' | 'liquid' | 'adl' | 'settlement';
+    tradeType: 'trade' | 'liquid' | 'adl' | 'settlement';
     subTradeType: string | null;
     /** Trade time (execution time), standardized to nanoseconds as of 2026.01.12 */
     tradeTime: number;

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

@@ -174,6 +174,12 @@ export interface GetCurrentFundingRateResponseUTA {
     fundingTime: number;
     fundingRateCap: number;
     fundingRateFloor: number;
+    /** Current funding settlement interval (ms); as of 2026.04.19 */
+    currentGranularity: number;
+    /** New interval after change (ms); as of 2026.04.19 */
+    newGranularity: number;
+    /** When newGranularity takes effect (ms); as of 2026.04.19 */
+    newGranularityStartTime: number;
 }
 export interface FundingRateHistoryItemUTA {
     fundingRate: number;
@@ -183,6 +189,43 @@ export interface GetHistoryFundingRateResponseUTA {
     symbol: string;
     list: FundingRateHistoryItemUTA[];
 }
+export interface ModifyMarginCrossLeverageResponseUTA {
+    currency?: string;
+    leverage?: string;
+}
+/** One row from Get Leverage (UTA) — margin uses currency, futures uses symbol */
+export interface GetLeverageItemUTA {
+    leverage: string;
+    marginMode: string;
+    currency?: string;
+    symbol?: string;
+}
+export interface PrivateFundingFeeHistoryItemUTA {
+    symbol: string;
+    marginMode: 'CROSS' | 'ISOLATED';
+    fundingRate: string;
+    markPrice: string;
+    size: string;
+    positionValue: string;
+    fundingFee: string;
+    settleCurrency: string;
+    settlementTime: number;
+}
+export interface GetPrivateFundingFeeHistoryResponseUTA {
+    lastId: number;
+    items: PrivateFundingFeeHistoryItemUTA[];
+}
+export interface GetBorrowingRatesAndLimitsResponseUTA {
+    currentRateHourly: string;
+    currentRateDaily: string;
+    borrowLimitTotal: string;
+    borrowLimitTotalHold: string;
+    borrowLimitHold: string;
+    interestFreeBorrowLimit: string;
+}
+export interface BorrowableCurrencyUTA {
+    currency: string;
+}
 export interface GetCrossMarginConfigResponseUTA {
     maxLeverage: number;
     alertRiskRatio: string;
@@ -203,6 +246,8 @@ export interface AccountCurrencyUTA {
     available: string;
     balance: string;
     equity: string;
+    /** Potential borrow reserved by open orders (UTA; as of 2026.04.19) */
+    potentialBorrow?: string;
     liability?: string;
     totalCrossMargin?: string;
     crossPosMargin?: string;
@@ -251,7 +296,7 @@ export interface GetSubAccountResponseUTA {
 export interface GetTransferQuotasResponseUTA {
     currency: string;
     transferable: string;
-    accountType: string;
+    accountType: 'FUNDING' | 'SPOT' | 'FUTURES' | 'ISOLATED' | 'UNIFIED';
 }
 export interface FlexTransferResponseUTA {
     orderId: string;
@@ -281,6 +326,7 @@ export interface AccountLedgerItemUTA {
     currency: string;
     direction: 'IN' | 'OUT';
     businessType: string;
+    /** Change in funds balance. Always positive as of 2026.04.28; use direction (IN/OUT) for flow. */
     amount: string;
     balance: string;
     fee: string;
@@ -310,18 +356,78 @@ export interface DepositAddressUTA {
     address: string;
     memo: string;
     chainId: string;
-    to: 'MAIN' | 'TRADE';
+    to: 'FUNDING' | 'SPOT' | 'UNIFIED';
     currency: string;
     contractAddress: string;
     chainName: string;
     expirationDate: string;
     remark: string;
 }
+export interface WithdrawalQuotasUTA {
+    currency: string;
+    limitBTCAmount: string;
+    usedBTCAmount: string;
+    quotaCurrency: string;
+    limitQuotaCurrencyAmount: string;
+    usedQuotaCurrencyAmount: string;
+    remainAmount: string;
+    availableAmount: string;
+    withdrawMinFee: string;
+    innerWithdrawMinFee: string;
+    withdrawMinSize: string;
+    isWithdrawEnabled: boolean;
+    precision: number;
+    reason: string | null;
+    lockedAmount: string;
+    chainId: string;
+    chainName: string;
+}
+export interface SubmitWithdrawResponseUTA {
+    withdrawalId: string;
+}
+export interface AddSubAccountResponseUTA {
+    uid: number;
+    subName: string;
+    remarks: string;
+    access: string;
+}
+export interface AddSubAccountApiResponseUTA {
+    subName: string;
+    remark: string;
+    apiKey: string;
+    apiSecret: string;
+    apiVersion: number;
+    passphrase: string;
+    permission: string;
+    ipWhitelist?: string;
+    createdAt: number;
+}
+export interface KYCRegionUTA {
+    code: string;
+    enName: string;
+}
+export interface ApiKeyInfoUTA {
+    uid: number;
+    parentUid?: number;
+    region: string;
+    kycStatus: 0 | 1;
+    subName?: string;
+    remark: string;
+    apiKey: string;
+    apiVersion: number;
+    permission: string;
+    ipWhitelist?: string;
+    isMaster: boolean;
+    createdAt: number;
+    expiredAt?: number | null;
+    thirdPartyApp?: string;
+    siteType?: 'global' | 'turkey' | 'australia' | 'europe' | 'thailand';
+}
 /**
  * Order Response Types
  */
 export interface PlaceOrderResponseUTA {
-    tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
+    tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';
     orderId: string;
     clientOid: string;
     /** Timestamp when system completes order request in nanoseconds. Classic mode not supported */
@@ -339,11 +445,11 @@ export interface BatchPlaceOrderItemResponseUTA {
     msg?: string;
 }
 export interface BatchPlaceOrderResponseUTA {
-    tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
+    tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';
     items: BatchPlaceOrderItemResponseUTA[];
 }
 export interface OrderDetailsUTA {
-    tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
+    tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';
     orderId: string;
     clientOid: string;
     /**
@@ -404,12 +510,12 @@ export interface GetOpenOrderListResponseUTA {
     pageSize?: number;
     totalNum?: number;
     totalPage?: number;
-    tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
+    tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';
     items: OrderDetailsUTA[];
 }
 export interface GetOrderHistoryResponseUTA {
     lastId: number;
-    tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
+    tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';
     items: OrderDetailsUTA[];
 }
 export interface TradeHistoryItemUTA {
@@ -435,11 +541,11 @@ export interface TradeHistoryItemUTA {
 }
 export interface GetTradeHistoryResponseUTA {
     lastId: number;
-    tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
+    tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';
     items: TradeHistoryItemUTA[];
 }
 export interface CancelOrderResponseUTA {
-    tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
+    tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';
     orderId?: string;
     clientOid?: string;
     /** Timestamp when system completes order cancellation request (nanoseconds). Only for unified accounts */
@@ -454,7 +560,7 @@ export interface BatchCancelOrderItemResponseUTA {
     ts?: number;
 }
 export interface BatchCancelOrdersResponseUTA {
-    tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
+    tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';
     items: BatchCancelOrderItemResponseUTA[];
 }
 /** Batch cancel by symbol - Classic response (orderId list) */
@@ -490,6 +596,8 @@ export interface PositionUTA {
     size: string;
     entryPrice: string;
     positionValue: string;
+    /** Margin occupied by the futures position */
+    positionMargin: string;
     markPrice: string;
     leverage: string;
     unrealizedPnL: string;
@@ -499,6 +607,12 @@ export interface PositionUTA {
     maintenanceMargin: string;
     /** Timestamp when position was first opened (nanoseconds, standardized as of 2026.01.12) */
     creationTime: number;
+    /** Estimated liquidation price (as of 2026.04.09) */
+    liquidationPrice: string;
+    /** ADL ranking percentile (0.12 = 12%). Added 2026.05.15 */
+    adlPercentage: string;
+    /** Isolated futures risk ratio (0.65 = 65%). Empty for cross margin positions */
+    riskRatio: string;
 }
 export interface PositionHistoryItemUTA {
     closeId: string;
@@ -523,6 +637,19 @@ export interface GetPositionsHistoryResponseUTA {
     items: PositionHistoryItemUTA[];
     lastId?: number;
 }
+/** Row from Get Third-Party Custody Currencies */
+export interface ThirdPartyCustodyCurrencyUTA {
+    custodian: string;
+    currency: string;
+    precision: number;
+}
+/** Row from Get Third-Party Custody Account Currency Limits */
+export interface ThirdPartyCustodyQuotaUTA {
+    custodian: string;
+    currency: string;
+    /** Remaining custodial quota (shared across custodian sub-accounts under master) */
+    custodyQuota: string;
+}
 export interface PositionTierUTA {
     symbol: string;
     tier: number;
@@ -532,3 +659,16 @@ export interface PositionTierUTA {
     initialMarginRate: string;
     maintainMarginRate: string;
 }
+export interface BatchModifyMarginModeItemUTA {
+    symbol: string;
+    marginMode: string;
+    code: string;
+    msg: string;
+}
+export interface BatchModifyMarginModeResponseUTA {
+    ts: number;
+    items: BatchModifyMarginModeItemUTA[];
+}
+export interface ModifyIsolatedFuturesMarginResponseUTA {
+    ts: number;
+}