kucoin-api 0.0.2 → 1.0.0

package/dist/mjs/types/response/futures.types.js

@@ -0,0 +1,6 @@
+/**
+ * REST - ACCOUNT  - BASIC INFO
+ * Get Account Ledgers - Futures
+ */
+export {};
+//# sourceMappingURL=futures.types.js.map

package/dist/mjs/types/response/futures.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"futures.types.js","sourceRoot":"","sources":["../../../../src/types/response/futures.types.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

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

@@ -0,0 +1,9 @@
+export interface APISuccessResponse<TData> {
+    code: '200000';
+    data: TData;
+}
+export interface APIErrorResponse {
+    msg: string;
+    code: string;
+}
+export type APIResponse<TData> = APISuccessResponse<TData> | APIErrorResponse;

package/dist/mjs/types/response/shared.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=shared.types.js.map

package/dist/mjs/types/response/shared.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.types.js","sourceRoot":"","sources":["../../../../src/types/response/shared.types.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,140 @@
+export interface SpotAccountSummary {
+    level: number;
+    subQuantity: number;
+    maxDefaultSubQuantity: number;
+    maxSubQuantity: number;
+    spotSubQuantity: number;
+    marginSubQuantity: number;
+    futuresSubQuantity: number;
+    maxSpotSubQuantity: number;
+    maxMarginSubQuantity: number;
+    maxFuturesSubQuantity: number;
+}
+export interface Balances {
+    id: string;
+    currency: string;
+    type: 'main' | 'trade' | 'trade_hf' | 'margin';
+    balance: string;
+    available: string;
+    holds: string;
+}
+export interface Account {
+    currency: string;
+    balance: string;
+    available: string;
+    holds: string;
+}
+export interface SpotAccountTransaction {
+    id: string;
+    currency: string;
+    amount: string;
+    fee: string;
+    balance: string;
+    accountType: 'TRADE_HF';
+    bizType: 'TRANSFER' | 'TRADE_EXCHANGE';
+    direction: 'out' | 'in';
+    createdAt: string;
+    context: string;
+}
+export interface SpotAccountTransactions {
+    currentPage: number;
+    pageSize: number;
+    totalNum: number;
+    totalPage: number;
+    items: SpotAccountTransaction[];
+}
+export interface AccountHFMarginTransactions {
+    id: string;
+    currency: string;
+    amount: string;
+    fee: string;
+    balance: string;
+    accountType: 'MARGIN_V2' | 'ISOLATED_V2';
+    bizType: 'TRANSFER' | 'MARGIN_EXCHANGE' | 'ISOLATED_EXCHANGE' | 'LIQUIDATION' | 'ASSERT_RETURN';
+    direction: 'out' | 'in';
+    createdAt: string;
+    context: string;
+}
+/**
+ *
+ * Sub-Account
+ *
+ */
+export interface SubAccountInfo {
+    userId: string;
+    uid: string | number;
+    subName: string;
+    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;
+}
+export interface SubAccountsV2 {
+    currentPage: number;
+    pageSize: number;
+    totalNum: number;
+    totalPage: number;
+    items: SubAccountInfo[];
+}
+export interface CreateSubAccount {
+    uid: number;
+    subName: string;
+    remarks: string;
+    access: string;
+}
+export interface SubAccountBalances {
+    subUserId: string;
+    subName: string;
+    mainAccounts: SubAccountBalance[];
+    tradeAccounts: SubAccountBalance[];
+    marginAccounts: SubAccountBalance[];
+}
+export interface SubAccountBalancesV2 {
+    currentPage: number;
+    pageSize: number;
+    totalNum: number;
+    totalPage: number;
+    items: {
+        subUserId: string;
+        subName: string;
+        mainAccounts: SubAccountBalance[];
+    }[];
+}
+/**
+ *
+ * Sub-Account API
+ *
+ *
+ */
+export interface SubAccountAPIInfo {
+    apiKey: string;
+    createdAt: number;
+    ipWhitelist: string;
+    permission: string;
+    remark: string;
+    subName: string;
+}
+export type CreateSubAPI = SubAccountAPIInfo & {
+    apiSecret: string;
+    passphrase: string;
+};
+export interface UpdateSubAPI {
+    apiKey: string;
+    ipWhitelist: string;
+    permission: string;
+    subName: string;
+}
+export interface DeleteSubAccountAPI {
+    subName: string;
+    apiKey: string;
+}

package/dist/mjs/types/response/spot-account.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=spot-account.js.map

package/dist/mjs/types/response/spot-account.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spot-account.js","sourceRoot":"","sources":["../../../../src/types/response/spot-account.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,74 @@
+/**
+ *
+ * EARN
+ *
+ */
+export interface SubscribeEarnFixedIncomeResponse {
+    orderId: string;
+    orderTxId: string;
+}
+export interface InitiateRedemptionResponse {
+    orderTxId: string;
+    deliverTime: number;
+    status: 'SUCCESS' | 'PENDING';
+    amount: string;
+}
+export interface GetEarnRedeemPreviewResponse {
+    currency: string;
+    redeemAmount: string;
+    penaltyInterestAmount: string;
+    redeemPeriod: number;
+    deliverTime: number;
+    manualRedeemable: boolean;
+    redeemAll: boolean;
+}
+export interface EarnFixedIncomeHoldAsset {
+    orderId: string;
+    productId: string;
+    productCategory: string;
+    productType: string;
+    currency: string;
+    incomeCurrency: string;
+    returnRate: string;
+    holdAmount: string;
+    redeemedAmount: string;
+    redeemingAmount: string;
+    lockStartTime: number;
+    lockEndTime: number | null;
+    purchaseTime: number;
+    redeemPeriod: number;
+    status: 'LOCKED' | 'REDEEMING';
+    earlyRedeemSupported: 0 | 1;
+}
+export interface EarnFixedIncomeHoldAssets {
+    totalNum: number;
+    items: EarnFixedIncomeHoldAsset[];
+    currentPage: number;
+    pageSize: number;
+    totalPage: number;
+}
+export interface EarnProduct {
+    id: string;
+    currency: string;
+    category: 'DEMAND' | 'ACTIVITY' | 'KCS_STAKING' | 'STAKING' | 'ETH2';
+    type: 'TIME' | 'DEMAND';
+    precision: number;
+    productUpperLimit: string;
+    userUpperLimit: string;
+    userLowerLimit: string;
+    redeemPeriod: number;
+    lockStartTime: number;
+    lockEndTime: number | null;
+    applyStartTime: number;
+    applyEndTime: number | null;
+    returnRate: string;
+    incomeCurrency: string;
+    earlyRedeemSupported: 0 | 1;
+    productRemainAmount: string;
+    status: 'ONGOING' | 'PENDING' | 'FULL' | 'INTERESTING';
+    redeemType: 'MANUAL' | 'TRANS_DEMAND' | 'AUTO';
+    incomeReleaseType: 'DAILY' | 'AFTER';
+    interestDate: number;
+    duration: number;
+    newUserOnly: 0 | 1;
+}

package/dist/mjs/types/response/spot-earn.js

@@ -0,0 +1,7 @@
+/**
+ *
+ * EARN
+ *
+ */
+export {};
+//# sourceMappingURL=spot-earn.js.map

package/dist/mjs/types/response/spot-earn.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spot-earn.js","sourceRoot":"","sources":["../../../../src/types/response/spot-earn.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}

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

@@ -0,0 +1,176 @@
+/**
+ *
+ ***********
+ * Funding
+ ***********
+ *
+ */
+export interface MarginAccountBalance {
+    currency: string;
+    totalBalance: string;
+    availableBalance: string;
+    holdBalance: string;
+    liability: string;
+    maxBorrowSize: string;
+}
+export interface MarginAssetDetail {
+    currency: string;
+    borrowEnabled: boolean;
+    repayEnabled: boolean;
+    transferEnabled: boolean;
+    borrowed: string;
+    totalAsset: string;
+    available: string;
+    hold: string;
+    maxBorrowSize: string;
+}
+export interface MarginAccountDetail {
+    totalLiabilityOfQuoteCurrency: string;
+    totalAssetOfQuoteCurrency: string;
+    debtRatio: string;
+    status: 'EFFECTIVE' | 'BANKRUPTCY' | 'LIQUIDATION' | 'REPAY' | 'BORROW';
+    assets: MarginAssetDetail[];
+}
+export interface IsolatedMarginAssetDetail {
+    symbol: string;
+    debtRatio: string;
+    status: 'EFFECTIVE' | 'BANKRUPTCY' | 'LIQUIDATION' | 'REPAY' | 'BORROW';
+    baseAsset: MarginAssetDetail;
+    quoteAsset: MarginAssetDetail;
+}
+export interface MarginBalance {
+    timestamp: number;
+    currentPage: number;
+    pageSize: number;
+    totalNum: number;
+    totalPage: number;
+    items: MarginAccountDetail[];
+}
+export interface IsolatedMarginBalance {
+    totalAssetOfQuoteCurrency: string;
+    totalLiabilityOfQuoteCurrency: string;
+    timestamp: number;
+    assets: IsolatedMarginAssetDetail[];
+}
+/**
+ *
+ * Deposit
+ *
+ */
+export interface DepositAddress {
+    address: string;
+    memo: string;
+    chain: string;
+}
+export type DepositAddressV2 = DepositAddress & {
+    contractAddress: 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;
+}
+export interface HistoricalDepositItem {
+    currency: string;
+    createAt: number;
+    amount: string;
+    walletTxId: string;
+    isInner: boolean;
+    status: 'PROCESSING' | 'SUCCESS' | 'FAILURE';
+}
+export interface Deposits {
+    currentPage: number;
+    pageSize: number;
+    totalNum: number;
+    totalPage: number;
+    items: DepositItem[];
+}
+export interface V1HistoricalDeposits {
+    currentPage: number;
+    pageSize: number;
+    totalNum: number;
+    totalPage: number;
+    items: HistoricalDepositItem[];
+}
+/**
+ *
+ * Withdrawals
+ *
+ */
+interface DetailedWithdrawal {
+    id: string;
+    address: string;
+    memo: string;
+    currency: string;
+    chain: string;
+    amount: string;
+    fee: string;
+    walletTxId: string;
+    isInner: boolean;
+    status: 'PROCESSING' | 'WALLET_PROCESSING' | 'SUCCESS' | 'FAILURE';
+    remark: string;
+    createdAt: number;
+    updatedAt: number;
+}
+interface HistoricalWithdrawal {
+    currency: string;
+    createAt: number;
+    amount: string;
+    address: string;
+    walletTxId: string;
+    isInner: boolean;
+    status: 'PROCESSING' | 'SUCCESS' | 'FAILURE';
+}
+export interface Withdrawals {
+    currentPage: number;
+    pageSize: number;
+    totalNum: number;
+    totalPage: number;
+    items: DetailedWithdrawal[];
+}
+export interface HistoricalWithdrawalsV1 {
+    currentPage: number;
+    pageSize: number;
+    totalNum: number;
+    totalPage: number;
+    items: HistoricalWithdrawal[];
+}
+export interface WithdrawalQuotas {
+    limitBTCAmount: string;
+    quotaCurrency: string;
+    chain: string;
+    remainAmount: string;
+    innerWithdrawMinFee: string;
+    usedBTCAmount: string;
+    limitQuotaCurrencyAmount: string;
+    withdrawMinSize: string;
+    withdrawMinFee: string;
+    precision: number;
+    reason: string | null;
+    usedQuotaCurrencyAmount: string;
+    currency: string;
+    availableAmount: string;
+    isWithdrawEnabled: boolean;
+}
+/**
+ *
+ * Transfer
+ *
+ */
+export interface TransferableFunds {
+    currency: string;
+    balance: string;
+    available: string;
+    holds: string;
+    transferable: string;
+}
+export {};

package/dist/mjs/types/response/spot-funding.js

@@ -0,0 +1,9 @@
+/**
+ *
+ ***********
+ * Funding
+ ***********
+ *
+ */
+export {};
+//# sourceMappingURL=spot-funding.js.map

package/dist/mjs/types/response/spot-funding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spot-funding.js","sourceRoot":"","sources":["../../../../src/types/response/spot-funding.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}

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

@@ -0,0 +1,257 @@
+/**
+ *
+ ***********
+ * Margin Trading
+ ***********
+ *
+ */
+/**
+ *
+ * Margin HF trade
+ *
+ */
+export interface HFMarginOrder {
+    id: string;
+    symbol: string;
+    opType: 'DEAL';
+    type: 'limit' | 'market';
+    side: 'buy' | 'sell';
+    price: string;
+    size: string;
+    funds: string;
+    dealFunds: string;
+    dealSize: string;
+    fee: string;
+    feeCurrency: string;
+    stp: string;
+    timeInForce: 'GTC' | 'GTT' | 'IOC' | 'FOK';
+    postOnly: boolean;
+    hidden: boolean;
+    iceberg: boolean;
+    visibleSize: string;
+    cancelAfter: number;
+    channel: string;
+    clientOid: string;
+    remark: string;
+    tags: string;
+    active: boolean;
+    inOrderBook: boolean;
+    cancelExist: boolean;
+    createdAt: number;
+    lastUpdatedAt: number;
+    tradeType: 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE';
+}
+export type HFMarginFilledOrder = HFMarginOrder & {
+    inOrderBook: boolean;
+    active: boolean;
+};
+export interface HFMarginTransactionRecord {
+    id: number;
+    symbol: string;
+    tradeId: number;
+    orderId: string;
+    counterOrderId: string;
+    side: 'buy' | 'sell';
+    liquidity: 'taker' | 'maker';
+    forceTaker: boolean;
+    price: string;
+    size: string;
+    funds: string;
+    fee: string;
+    feeRate: string;
+    feeCurrency: string;
+    type: 'limit' | 'market';
+    stop: string;
+    createdAt: number;
+    tradeType: 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE';
+}
+/**
+ *
+ * Orders
+ *
+ */
+export interface SubmitMarginOrderResponse {
+    orderId: string;
+    borrowSize?: number;
+    loanApplyId?: string;
+}
+/**
+ *
+ * Margin info
+ *
+ */
+export interface MarginLevTokenInfo {
+    currency: string;
+    netAsset: number;
+    targetLeverage: string;
+    actualLeverage: string;
+    assetsUnderManagement: string;
+    basket: string;
+}
+export interface MarginMarkPrice {
+    symbol: string;
+    timePoint: number;
+    value: number;
+}
+export interface MarginConfigInfo {
+    currencyList: string[];
+    warningDebtRatio: string;
+    liqDebtRatio: string;
+    maxLeverage: number;
+}
+export interface MarginRiskLimit {
+    timestamp: number;
+    currency?: string;
+    symbol?: string;
+    borrowMaxAmount?: string;
+    buyMaxAmount?: string;
+    holdMaxAmount?: string;
+    borrowCoefficient?: string;
+    marginCoefficient?: string;
+    precision?: number;
+    borrowMinAmount?: string;
+    borrowMinUnit?: string;
+    borrowEnabled?: boolean;
+    baseMaxBorrowAmount?: string;
+    quoteMaxBorrowAmount?: string;
+    baseMaxBuyAmount?: string;
+    quoteMaxBuyAmount?: string;
+    baseMaxHoldAmount?: string;
+    quoteMaxHoldAmount?: string;
+    basePrecision?: number;
+    quotePrecision?: number;
+    baseBorrowCoefficient?: string;
+    quoteBorrowCoefficient?: string;
+    baseMarginCoefficient?: string;
+    quoteMarginCoefficient?: string;
+    baseBorrowMinAmount?: string | null;
+    quoteBorrowMinAmount?: string | null;
+    baseBorrowMinUnit?: string | null;
+    quoteBorrowMinUnit?: string | null;
+    baseBorrowEnabled?: boolean;
+    quoteBorrowEnabled?: boolean;
+}
+/**
+ *
+ * Isolated Margin
+ *
+ */
+export interface IsolatedMarginSymbolsConfig {
+    symbol: string;
+    symbolName: string;
+    baseCurrency: string;
+    quoteCurrency: string;
+    maxLeverage: number;
+    flDebtRatio: string;
+    tradeEnable: boolean;
+    autoRenewMaxDebtRatio: string;
+    baseBorrowEnable: boolean;
+    quoteBorrowEnable: boolean;
+    baseTransferInEnable: boolean;
+    quoteTransferInEnable: boolean;
+}
+export interface IsolatedMarginAccountInfo {
+    totalConversionBalance: string;
+    liabilityConversionBalance: string;
+    assets: AssetInfo[];
+}
+export interface SingleIsolatedMarginAccountInfo {
+    symbol: string;
+    status: string;
+    debtRatio: string;
+    baseAsset: AssetDetail;
+    quoteAsset: AssetDetail;
+}
+export interface AssetInfo {
+    symbol: string;
+    status: string;
+    debtRatio: string;
+    baseAsset: AssetDetail;
+    quoteAsset: AssetDetail;
+}
+export interface AssetDetail {
+    currency: string;
+    totalBalance: string;
+    holdBalance: string;
+    availableBalance: string;
+    liability: string;
+    interest: string;
+    borrowableAmount: string;
+}
+/**
+ *
+ * Margin trading(v3)
+ *
+ */
+export interface MarginOrderV3 {
+    orderNo: string;
+    actualSize: number;
+}
+export interface MarginHistoryRecord {
+    orderNo: string;
+    symbol: string;
+    currency: string;
+    size: number;
+    actualSize: number;
+    status: string;
+    createdTime: number;
+}
+export interface MarginInterestRecord {
+    createdAt: number;
+    currency: string;
+    interestAmount: string;
+    dayRatio: string;
+}
+export interface MarginInterestRecords {
+    currentPage: number;
+    pageSize: number;
+    totalNum: number;
+    totalPage: number;
+    items: MarginInterestRecord[];
+}
+/**
+ *
+ * Lending market(v3)
+ *
+ */
+interface LendingMarketItem {
+    currency: string;
+    purchaseEnable: boolean;
+    redeemEnable: boolean;
+    increment: string;
+    minPurchaseSize: string;
+    minInterestRate: string;
+    maxInterestRate: string;
+    interestIncrement: string;
+    maxPurchaseSize: string;
+    marketInterestRate: string;
+    autoPurchaseEnable: boolean;
+}
+export interface LendingCurrencyV3 {
+    currentPage: number;
+    pageSize: number;
+    totalNum: number;
+    totalPage: number;
+    items: LendingMarketItem[];
+}
+export interface LendingOrder {
+    currency: string;
+    purchaseOrderNo: string;
+    redeemOrderNo?: string;
+    redeemAmount?: string;
+    receiptAmount?: string;
+    purchaseAmount?: string;
+    lendAmount?: string;
+    interestRate?: string;
+    incomeAmount?: string;
+    applyTime: number;
+    status: 'DONE' | 'PENDING';
+}
+export interface LendingRedemption {
+    currentPage: number;
+    pageSize: number;
+    totalNum: number;
+    totalPage: number;
+    items: LendingOrder[];
+}
+export {};