kucoin-api 2.0.0 → 2.0.2

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;
 }
 /**
  *

package/dist/cjs/types/response/spot-margin-trading.d.ts

@@ -12,18 +12,26 @@
  */
 export interface HFMarginOrder {
     id: string;
+    clientOid: string;
     symbol: string;
-    opType: 'DEAL';
+    opType: string;
     type: 'limit' | 'market';
     side: 'buy' | 'sell';
     price: string;
     size: string;
     funds: string;
-    dealFunds: string;
     dealSize: string;
+    dealFunds: string;
+    remainSize: string;
+    remainFunds: string;
+    cancelledSize: string;
+    cancelledFunds: string;
     fee: string;
     feeCurrency: string;
-    stp: string;
+    stp?: 'DC' | 'CO' | 'CN' | 'CB' | null;
+    stop?: string | null;
+    stopTriggered: boolean;
+    stopPrice: string;
     timeInForce: 'GTC' | 'GTT' | 'IOC' | 'FOK';
     postOnly: boolean;
     hidden: boolean;
@@ -31,16 +39,17 @@ export interface HFMarginOrder {
     visibleSize: string;
     cancelAfter: number;
     channel: string;
-    clientOid: string;
-    remark: string;
-    tags: string;
-    active: boolean;
-    inOrderBook: boolean;
+    remark?: string | null;
+    tags?: string | null;
     cancelExist: boolean;
+    tradeType: string;
+    inOrderBook: boolean;
+    tax: string;
+    active: boolean;
     createdAt: number;
     lastUpdatedAt: number;
-    tradeType: 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE';
 }
+/** @deprecated not used anymore **/
 export type HFMarginFilledOrder = HFMarginOrder & {
     inOrderBook: boolean;
     active: boolean;
@@ -60,10 +69,12 @@ export interface HFMarginTransactionRecord {
     fee: string;
     feeRate: string;
     feeCurrency: string;
-    type: 'limit' | 'market';
     stop: string;
+    tradeType: 'TRADE' | 'MARGIN_TRADE';
+    tax: string;
+    taxRate: string;
+    type: 'limit' | 'market';
     createdAt: number;
-    tradeType: 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE';
 }
 /**
  *
@@ -80,12 +91,30 @@ export interface SubmitMarginOrderResponse {
  * Margin info
  *
  */
+export interface MarginActivePairsV3 {
+    symbol: string;
+    name: string;
+    enableTrading: boolean;
+    market: string;
+    baseCurrency: string;
+    quoteCurrency: string;
+    baseIncrement: string;
+    baseMinSize: string;
+    baseMaxSize: string;
+    quoteIncrement: string;
+    quoteMinSize: string;
+    quoteMaxSize: string;
+    priceIncrement: string;
+    feeCurrency: string;
+    priceLimitRate: string;
+    minFunds: string;
+}
 export interface MarginLevTokenInfo {
     currency: string;
     netAsset: number;
     targetLeverage: string;
     actualLeverage: string;
-    assetsUnderManagement: string;
+    issuedSize: string;
     basket: string;
 }
 export interface MarginMarkPrice {
@@ -149,6 +178,8 @@ export interface IsolatedMarginSymbolsConfig {
     quoteBorrowEnable: boolean;
     baseTransferInEnable: boolean;
     quoteTransferInEnable: boolean;
+    baseBorrowCoefficient: string;
+    quoteBorrowCoefficient: string;
 }
 export interface IsolatedMarginAccountInfo {
     totalConversionBalance: string;
@@ -183,11 +214,26 @@ export interface AssetDetail {
  * Margin trading(v3)
  *
  */
+export interface MarginSubmitOrderV3Response {
+    orderId: string;
+    clientOid: string;
+    borrowSize: string;
+    loanApplyId: string;
+}
 export interface MarginOrderV3 {
+    timestamp: number;
     orderNo: string;
     actualSize: number;
 }
-export interface MarginHistoryRecord {
+export interface MarginBorrowHistoryV3 {
+    timestamp: number;
+    currentPage: number;
+    pageSize: number;
+    totalNum: number;
+    totalPage: number;
+    items: MarginBorrowHistoryRecord[];
+}
+export interface MarginBorrowHistoryRecord {
     orderNo: string;
     symbol: string;
     currency: string;
@@ -196,13 +242,32 @@ export interface MarginHistoryRecord {
     status: string;
     createdTime: number;
 }
+export interface MarginRepayHistoryV3 {
+    timestamp: number;
+    currentPage: number;
+    pageSize: number;
+    totalNum: number;
+    totalPage: number;
+    items: MarginRepayHistoryRecord[];
+}
+export interface MarginRepayHistoryRecord {
+    orderNo: string;
+    symbol: string | null;
+    currency: string;
+    size: string;
+    principal: string;
+    interest: string;
+    status: string;
+    createdTime: number;
+}
 export interface MarginInterestRecord {
-    createdAt: number;
     currency: string;
-    interestAmount: string;
     dayRatio: string;
+    interestAmount: string;
+    createdTime: number;
 }
 export interface MarginInterestRecords {
+    timestamp: number;
     currentPage: number;
     pageSize: number;
     totalNum: number;

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

@@ -9,8 +9,8 @@ export interface Announcement {
 }
 export interface Announcements {
     totalNum: number;
-    items: Announcement[];
     currentPage: number;
     pageSize: number;
     totalPage: number;
+    items: Announcement[];
 }