kucoin-api/dist/cjs/types/response/spot-account.d.ts

Complete & robust Node.js SDK for Kucoin's REST APIs and WebSockets, with TypeScript & strong end to end tests.

export interface SpotAccountSummary {
    level: number;
    subQuantity: 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';
    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;
    tax: string;
    balance: string;
    accountType: string;
    bizType: string;
    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;
    tax: string;
    context: string;
}
/**
 *
 * Sub-Account
 *
 */
export interface SubAccountsV2 {
    currentPage: number;
    pageSize: number;
    totalNum: number;
    totalPage: number;
    items: SubAccountInfo[];
}
export interface SubAccountInfo {
    userId: string;
    uid: number;
    subName: string;
    status: number;
    type: number;
    access: string;
    createdAt: number;
    remarks: string;
    tradeTypes: string[];
    openedTradeTypes: string[];
    hostedStatus: null | string;
}
export interface CreateSubAccount {
    currentPage: number;
    pageSize: number;
    totalNum: number;
    totalPage: number;
    items: SubAccountItem[];
}
export interface SubAccountItem {
    userId: string;
    uid: number;
    subName: string;
    status: number;
    type: number;
    access: string;
    createdAt: number;
    remarks: string;
    tradeTypes: string[];
    openedTradeTypes: string[];
    hostedStatus: null | string;
}
export interface SubAccountBalances {
    subUserId: string;
    subName: string;
    mainAccounts: SubAccountBalance[];
    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;
    totalNum: number;
    totalPage: number;
    items: {
        subUserId: string;
        subName: string;
        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
 *
 *
 */
export interface SubAccountAPIInfo {
    subName: string;
    remark: string;
    apiKey: string;
    apiVersion: number;
    permission: string;
    ipWhitelist: string;
    createdAt: number;
    uid: number;
    isMaster: boolean;
}
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;
    permission: string;
    subName: string;
}
export interface DeleteSubAccountAPI {
    subName: string;
    apiKey: string;
}