kucoin-api 2.0.0 → 2.0.1

package/dist/cjs/types/request/spot-funding.d.ts

@@ -14,8 +14,6 @@ export interface CreateDepositAddressV3Request {
 export interface GetMarginBalanceRequest {
     quoteCurrency?: string;
     queryType?: 'MARGIN' | 'MARGIN_V2' | 'ALL';
-    currentPage?: number;
-    pageSize?: number;
 }
 export interface GetIsolatedMarginBalanceRequest {
     symbol?: string;

package/dist/cjs/types/request/spot-trading.d.ts

@@ -22,30 +22,22 @@ export interface GetSpotKlinesRequest {
  *
  */
 export interface SubmitHFOrderRequest {
-    clientOid?: string;
-    symbol: string;
     type: 'limit' | 'market';
+    symbol: string;
     side: 'buy' | 'sell';
-    stp?: 'CN' | 'CO' | 'CB' | 'DC';
+    clientOid?: string;
+    stp?: 'DC' | 'CO' | 'CN' | 'CB';
     tags?: string;
     remark?: string;
-}
-export interface SubmitMultipleHFOrdersRequest {
-    clientOid?: string;
-    symbol: string;
-    type: 'limit' | 'market';
+    price?: string;
+    size?: string;
     timeInForce?: 'GTC' | 'GTT' | 'IOC' | 'FOK';
-    stp?: 'CN' | 'CO' | 'CB' | 'DC';
-    side: 'buy' | 'sell';
-    price: string;
-    size: string;
     cancelAfter?: number;
     postOnly?: boolean;
     hidden?: boolean;
     iceberg?: boolean;
     visibleSize?: string;
-    tags?: string;
-    remark?: string;
+    funds?: string;
 }
 export interface ModifyHFOrderRequest {
     symbol: string;
@@ -154,14 +146,13 @@ export interface GetFillsRequest {
  *
  */
 export interface SubmitStopOrderRequest {
-    clientOid: string;
-    side: 'buy' | 'sell';
     symbol: string;
-    type?: 'limit' | 'market';
+    side: 'buy' | 'sell';
+    stopPrice: string;
+    type: 'limit' | 'market';
+    clientOid?: string;
+    stp?: 'DC' | 'CO' | 'CN' | 'CB';
     remark?: string;
-    stop?: 'loss' | 'entry';
-    stopPrice?: string;
-    stp?: 'CN' | 'CO' | 'CB' | 'DC';
     tradeType?: 'TRADE' | 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE';
     price?: string;
     size?: string;

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

@@ -58,9 +58,17 @@ export interface AccountSummary {
     availableBalanceTotal: number;
     currency: string;
 }
-export type SubBalance = AccountBalance & {
+export interface FuturesSubAccount {
     accountName: string;
-};
+    accountEquity: number;
+    unrealisedPNL: number;
+    marginBalance: number;
+    positionMargin: number;
+    orderMargin: number;
+    frozenFunds: number;
+    availableBalance: number;
+    currency: string;
+}
 /**
  * REST - FUNDING - TRANSFER
  */
@@ -110,7 +118,7 @@ export interface FuturesTransferRecords {
 export interface FuturesSymbolInfo {
     symbol: string;
     rootSymbol: string;
-    type: string;
+    type: 'FFWCSX' | 'FFICSX';
     firstOpenDate: number;
     expireDate: number | null;
     settleDate: number | null;
@@ -136,16 +144,17 @@ export interface FuturesSymbolInfo {
     isDeleverage: boolean;
     isQuanto: boolean;
     isInverse: boolean;
-    markMethod: string;
-    fairMethod: string;
+    markMethod: 'FairPrice';
+    fairMethod: 'FundingRate';
     fundingBaseSymbol: string;
     fundingQuoteSymbol: string;
     fundingRateSymbol: string;
     indexSymbol: string;
-    settlementSymbol: string;
-    status: string;
+    settlementSymbol: string | null;
+    status: 'Init' | 'Open' | 'BeingSettled' | 'Settled' | 'Paused' | 'Closed' | 'CancelOnly';
     fundingFeeRate: number;
     predictedFundingFeeRate: number;
+    fundingRateGranularity: number;
     openInterest: string;
     turnoverOf24h: number;
     volumeOf24h: number;
@@ -163,9 +172,12 @@ export interface FuturesSymbolInfo {
     highPrice: number;
     priceChgPct: number;
     priceChg: number;
+    k: number;
+    m: number;
+    f: number;
+    mmrLimit: number;
+    mmrLevConstant: number;
     supportCross: boolean;
-    buyLimit: number;
-    sellLimit: number;
 }
 export interface TickerDetail {
     sequence: number;
@@ -193,8 +205,8 @@ export interface MarketTradeDetail {
 export interface FullOrderBookDetail {
     symbol: string;
     sequence: number;
-    asks: [string, number][];
-    bids: [string, number][];
+    asks: [number, number][];
+    bids: [number, number][];
     ts: number;
 }
 export type FuturesKline = [
@@ -250,18 +262,18 @@ export interface PremiumIndexItem {
 export interface FuturesOrder {
     id: string;
     symbol: string;
-    type: string;
-    side: string;
+    type: 'market' | 'limit';
+    side: 'buy' | 'sell';
     price: string;
     size: number;
     value: string;
     dealValue: string;
     dealSize: number;
-    stp: string;
+    stp: 'CN' | 'CO' | 'CB' | '';
     stop: string;
-    stopPriceType: string;
+    stopPriceType: 'TP' | 'MP' | 'IP' | '';
     stopTriggered: boolean;
-    stopPrice: string | null;
+    stopPrice: number | null;
     timeInForce: string;
     postOnly: boolean;
     hidden: boolean;
@@ -269,23 +281,23 @@ export interface FuturesOrder {
     leverage: string;
     forceHold: boolean;
     closeOrder: boolean;
-    visibleSize: number | null;
+    visibleSize: number;
     clientOid: string;
     remark: string | null;
-    tags: string | null;
+    tags: string;
     isActive: boolean;
     cancelExist: boolean;
     createdAt: number;
     updatedAt: number;
-    endAt: number;
+    endAt: number | null;
     orderTime: number;
     settleCurrency: string;
-    status: string;
+    marginMode: 'ISOLATED' | 'CROSS';
+    avgDealPrice: string;
     filledSize: number;
     filledValue: string;
+    status: 'open' | 'done';
     reduceOnly: boolean;
-    marginMode: 'ISOLATED' | 'CROSS';
-    avgDealPrice: string;
 }
 export interface BatchCancelOrderResult {
     orderId: string | null;
@@ -316,25 +328,27 @@ export interface FuturesFill {
     symbol: string;
     tradeId: string;
     orderId: string;
-    side: string;
-    liquidity: string;
+    side: 'buy' | 'sell';
+    liquidity: 'taker' | 'maker';
     forceTaker: boolean;
     price: string;
     size: number;
     value: string;
+    openFeePay: string;
+    closeFeePay: string;
+    stop: string;
     feeRate: string;
     fixFee: string;
     feeCurrency: string;
-    stop: string;
+    marginMode: 'ISOLATED' | 'CROSS';
     fee: string;
-    orderType: string;
-    tradeType: string;
-    createdAt: number;
     settleCurrency: string;
-    openFeePay: string;
-    closeFeePay: string;
+    orderType: 'market' | 'limit';
+    displayType: 'limit' | 'market' | 'limit_stop' | 'market_stop';
+    tradeType: 'trade' | 'cancel' | 'liquid' | 'adl' | 'settlement';
+    subTradeType: string | null;
     tradeTime: number;
-    marginMode: 'ISOLATED' | 'CROSS';
+    createdAt: number;
 }
 export interface FuturesFills {
     currentPage: number;
@@ -363,10 +377,7 @@ export interface MaxOpenSize {
 export interface FuturesPosition {
     id: string;
     symbol: string;
-    autoDeposit: boolean;
-    maintMarginReq: number;
-    riskLimit: number;
-    realLeverage: number;
+    marginMode: 'CROSS' | 'ISOLATED';
     crossMode: boolean;
     delevPercentage: number;
     openingTimestamp: number;
@@ -374,36 +385,41 @@ export interface FuturesPosition {
     currentQty: number;
     currentCost: number;
     currentComm: number;
-    unrealisedCost: number;
+    realisedGrossPnl: number;
     realisedGrossCost: number;
     realisedCost: number;
+    unrealisedCost: number;
+    unrealisedPnlPcnt: number;
+    unrealisedPnl: number;
+    unrealisedRoePcnt: number;
     isOpen: boolean;
     markPrice: number;
     markValue: number;
     posCost: number;
-    posCross: number;
     posInit: number;
-    posComm: number;
-    posLoss: number;
     posMargin: number;
-    posMaint: number;
-    maintMargin: number;
-    realisedGrossPnl: number;
     realisedPnl: number;
-    unrealisedPnl: number;
-    unrealisedPnlPcnt: number;
-    unrealisedRoePcnt: number;
     avgEntryPrice: number;
     liquidationPrice: number;
     bankruptPrice: number;
     settleCurrency: string;
-    maintainMargin: number;
-    userId: number;
-    riskLimitLevel: number;
-    marginMode: 'ISOLATED' | 'CROSS';
-    positionSide: string;
-    posFunding: number;
+    isInverse: boolean;
+    positionSide: 'BOTH';
     leverage: number;
+    autoDeposit?: boolean;
+    maintMarginReq?: number;
+    riskLimit?: number;
+    realLeverage?: number;
+    posCross?: number;
+    posCrossMargin?: number;
+    posComm?: number;
+    posCommCommon?: number;
+    posLoss?: number;
+    posFunding?: number;
+    posMaint?: number;
+    maintMargin?: number;
+    maintainMargin?: number;
+    riskLimitLevel?: number;
 }
 export interface AddMargin {
     id: string;
@@ -487,28 +503,26 @@ export interface FuturesAccountFundingRateHistory {
     positionCost: number;
     funding: number;
     settleCurrency: string;
+    context: string;
+    marginMode: 'ISOLATED' | 'CROSS';
 }
 export interface FuturesClosedPosition {
     closeId: string;
-    positionId: string;
-    uid: number;
     userId: string;
     symbol: string;
     settleCurrency: string;
     leverage: string;
     type: string;
-    side: string | null;
-    closeSize: number | null;
     pnl: string;
     realisedGrossCost: string;
     withdrawPnl: string;
-    roe: number | null;
     tradeFee: string;
     fundingFee: string;
     openTime: number;
     closeTime: number;
-    openPrice: number | null;
-    closePrice: number | null;
+    openPrice: string;
+    closePrice: string;
+    marginMode: 'CROSS' | 'ISOLATED';
 }
 export interface FuturesClosedPositions {
     currentPage: number;
@@ -517,4 +531,50 @@ export interface FuturesClosedPositions {
     totalPage: number;
     items: FuturesClosedPosition[];
 }
+/**
+ *
+ * Copy Trading
+ *
+ */
+export interface CopyTradePosition {
+    id: string;
+    symbol: string;
+    autoDeposit: boolean;
+    maintMarginReq: string;
+    riskLimit: number;
+    realLeverage: string;
+    crossMode: boolean;
+    marginMode: string;
+    positionSide: string;
+    leverage: string;
+    delevPercentage: number;
+    openingTimestamp: number;
+    currentTimestamp: number;
+    currentQty: number;
+    currentCost: string;
+    currentComm: string;
+    unrealisedCost: string;
+    realisedGrossCost: string;
+    realisedCost: string;
+    isOpen: boolean;
+    markPrice: string;
+    markValue: string;
+    posCost: string;
+    posCross: string;
+    posInit: string;
+    posComm: string;
+    posLoss: string;
+    posMargin: string;
+    posMaint: string;
+    maintMargin: string;
+    realisedGrossPnl: string;
+    realisedPnl: string;
+    unrealisedPnl: string;
+    unrealisedPnlPcnt: string;
+    unrealisedRoePcnt: string;
+    avgEntryPrice: string;
+    liquidationPrice: string;
+    bankruptPrice: string;
+    settleCurrency: string;
+}
 export {};

package/dist/cjs/types/response/spot-account.d.ts

@@ -1,19 +1,21 @@
 export interface SpotAccountSummary {
     level: number;
     subQuantity: number;
-    maxDefaultSubQuantity: number;
-    maxSubQuantity: number;
     spotSubQuantity: number;
     marginSubQuantity: number;
     futuresSubQuantity: number;
+    optionSubQuantity: number;
+    maxSubQuantity: number;
+    maxDefaultSubQuantity: number;
     maxSpotSubQuantity: number;
     maxMarginSubQuantity: number;
     maxFuturesSubQuantity: number;
+    maxOptionSubQuantity: number;
 }
 export interface Balances {
     id: string;
     currency: string;
-    type: 'main' | 'trade' | 'trade_hf' | 'margin';
+    type: 'main' | 'trade';
     balance: string;
     available: string;
     holds: string;
@@ -29,9 +31,10 @@ export interface SpotAccountTransaction {
     currency: string;
     amount: string;
     fee: string;
+    tax: string;
     balance: string;
-    accountType: 'TRADE_HF';
-    bizType: 'TRANSFER' | 'TRADE_EXCHANGE';
+    accountType: string;
+    bizType: string;
     direction: 'out' | 'in';
     createdAt: string;
     context: string;
@@ -53,6 +56,7 @@ export interface AccountHFMarginTransactions {
     bizType: 'TRANSFER' | 'MARGIN_EXCHANGE' | 'ISOLATED_EXCHANGE' | 'LIQUIDATION' | 'ASSERT_RETURN';
     direction: 'out' | 'in';
     createdAt: string;
+    tax: string;
     context: string;
 }
 /**
@@ -60,37 +64,45 @@ export interface AccountHFMarginTransactions {
  * Sub-Account
  *
  */
+export interface SubAccountsV2 {
+    currentPage: number;
+    pageSize: number;
+    totalNum: number;
+    totalPage: number;
+    items: SubAccountInfo[];
+}
 export interface SubAccountInfo {
     userId: string;
-    uid: string | number;
+    uid: number;
     subName: string;
+    status: number;
     type: number;
-    remarks: string | null;
     access: string;
-    status?: number;
-    createdAt?: number;
-}
-export interface SubAccountBalance {
-    currency: string;
-    balance: string;
-    available: string;
-    holds: string;
-    baseCurrency: string;
-    baseCurrencyPrice: string;
-    baseAmount: string;
+    createdAt: number;
+    remarks: string;
+    tradeTypes: string[];
+    openedTradeTypes: string[];
+    hostedStatus: null | string;
 }
-export interface SubAccountsV2 {
+export interface CreateSubAccount {
     currentPage: number;
     pageSize: number;
     totalNum: number;
     totalPage: number;
-    items: SubAccountInfo[];
+    items: SubAccountItem[];
 }
-export interface CreateSubAccount {
+export interface SubAccountItem {
+    userId: string;
     uid: number;
     subName: string;
-    remarks: string;
+    status: number;
+    type: number;
     access: string;
+    createdAt: number;
+    remarks: string;
+    tradeTypes: string[];
+    openedTradeTypes: string[];
+    hostedStatus: null | string;
 }
 export interface SubAccountBalances {
     subUserId: string;
@@ -99,6 +111,15 @@ export interface SubAccountBalances {
     tradeAccounts: SubAccountBalance[];
     marginAccounts: SubAccountBalance[];
 }
+export interface SubAccountBalance {
+    currency: string;
+    balance: string;
+    available: string;
+    holds: string;
+    baseCurrency: string;
+    baseCurrencyPrice: string;
+    baseAmount: string;
+}
 export interface SubAccountBalancesV2 {
     currentPage: number;
     pageSize: number;
@@ -110,6 +131,24 @@ export interface SubAccountBalancesV2 {
         mainAccounts: SubAccountBalance[];
     }[];
 }
+export interface SubAccountBalanceItemV2 {
+    subUserId: string;
+    subName: string;
+    mainAccounts: SubAccountV2Details[];
+    tradeAccounts: SubAccountV2Details[];
+    marginAccounts: SubAccountV2Details[];
+    tradeHFAccounts: string[];
+}
+export interface SubAccountV2Details {
+    currency?: string;
+    balance?: string;
+    available?: string;
+    holds?: string;
+    baseCurrency?: string;
+    baseCurrencyPrice?: string;
+    baseAmount?: string;
+    tag?: string;
+}
 /**
  *
  * Sub-Account API
@@ -117,17 +156,26 @@ export interface SubAccountBalancesV2 {
  *
  */
 export interface SubAccountAPIInfo {
+    subName: string;
+    remark: string;
     apiKey: string;
-    createdAt: number;
-    ipWhitelist: string;
+    apiVersion: number;
     permission: string;
-    remark: string;
-    subName: string;
+    ipWhitelist: string;
+    createdAt: number;
+    uid: number;
+    isMaster: boolean;
 }
-export type CreateSubAPI = SubAccountAPIInfo & {
+export interface CreateSubAPI {
+    subName: string;
+    remark: string;
+    apiKey: string;
     apiSecret: string;
+    apiVersion: number;
     passphrase: string;
-};
+    permission: string;
+    createdAt: number;
+}
 export interface UpdateSubAPI {
     apiKey: string;
     ipWhitelist: string;

package/dist/cjs/types/response/spot-funding.d.ts

@@ -34,13 +34,6 @@ export interface MarginAccountDetail {
     borrowEnabled: boolean;
     transferInEnabled: boolean;
 }
-export interface IsolatedMarginAssetDetail {
-    symbol: string;
-    debtRatio: string;
-    status: 'EFFECTIVE' | 'BANKRUPTCY' | 'LIQUIDATION' | 'REPAY' | 'BORROW';
-    baseAsset: MarginAssetDetail;
-    quoteAsset: MarginAssetDetail;
-}
 export interface MarginBalance {
     totalAssetOfQuoteCurrency: string;
     totalLiabilityOfQuoteCurrency: string;
@@ -54,6 +47,13 @@ export interface IsolatedMarginBalance {
     timestamp: number;
     assets: IsolatedMarginAssetDetail[];
 }
+export interface IsolatedMarginAssetDetail {
+    symbol: string;
+    debtRatio: string;
+    status: 'EFFECTIVE' | 'BANKRUPTCY' | 'LIQUIDATION' | 'REPAY' | 'BORROW';
+    baseAsset: MarginAssetDetail;
+    quoteAsset: MarginAssetDetail;
+}
 /**
  *
  * Deposit
@@ -70,26 +70,12 @@ export type DepositAddressV2 = DepositAddress & {
 export interface DepositAddressV3 {
     address: string;
     memo: string;
-    chainName: string;
     chainId: string;
-    contractAddress: string;
+    to: 'MAIN' | 'TRADE';
     expirationDate: number;
-    to: 'main' | 'trade';
-    currency: string;
-}
-export interface DepositItem {
-    address: string;
-    memo: string;
-    amount: string;
-    fee: string;
     currency: string;
-    chain: string;
-    isInner: boolean;
-    walletTxId: string;
-    status: 'PROCESSING' | 'SUCCESS' | 'FAILURE';
-    remark: string;
-    createdAt: number;
-    updatedAt: number;
+    contractAddress: string;
+    chainName: string;
 }
 export interface HistoricalDepositItem {
     currency: string;
@@ -106,6 +92,21 @@ export interface Deposits {
     totalPage: number;
     items: DepositItem[];
 }
+export interface DepositItem {
+    currency?: string;
+    chain?: string;
+    status?: 'PROCESSING' | 'SUCCESS' | 'FAILURE';
+    address?: string;
+    memo?: string;
+    isInner?: boolean;
+    amount?: string;
+    fee?: string;
+    walletTxId?: string | null;
+    createdAt?: number;
+    updatedAt?: number;
+    remark?: string;
+    arrears?: boolean;
+}
 export interface V1HistoricalDeposits {
     currentPage: number;
     pageSize: number;
@@ -166,21 +167,22 @@ export interface HistoricalWithdrawalsV1 {
     items: HistoricalWithdrawal[];
 }
 export interface WithdrawalQuotas {
+    currency: string;
     limitBTCAmount: string;
+    usedBTCAmount: string;
     quotaCurrency: string;
-    chain: string;
+    limitQuotaCurrencyAmount: string;
+    usedQuotaCurrencyAmount: string;
     remainAmount: string;
+    availableAmount: string;
+    withdrawMinFee: string;
     innerWithdrawMinFee: string;
-    usedBTCAmount: string;
-    limitQuotaCurrencyAmount: string;
     withdrawMinSize: string;
-    withdrawMinFee: string;
+    isWithdrawEnabled: boolean;
     precision: number;
+    chain: string;
     reason: string | null;
-    usedQuotaCurrencyAmount: string;
-    currency: string;
-    availableAmount: string;
-    isWithdrawEnabled: boolean;
+    lockedAmount: string;
 }
 /**
  *