kucoin-api 0.0.2 → 1.0.0

package/dist/cjs/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "commonjs"
+}

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

@@ -0,0 +1,183 @@
+/**
+ * REST - ACCOUNT  - BASIC INFO
+ * Get Account Ledgers - Futures
+ */
+export interface GetTransactionsRequest {
+    startAt?: number;
+    endAt?: number;
+    type?: 'RealisedPNL' | 'Deposit' | 'Withdrawal' | 'Transferin' | 'TransferOut';
+    offset?: number;
+    maxCount?: number;
+    currency?: string;
+    forward?: boolean;
+}
+/**
+ * REST - ACCOUNT  - SUBACCOUNT API
+ */
+export interface GetSubAPIsRequest {
+    apiKey?: string;
+    subName: string;
+}
+export interface CreateSubAPIRequest {
+    subName: string;
+    passphrase: string;
+    remark: string;
+    permission?: string;
+    ipWhitelist?: string;
+    expire?: string;
+}
+export interface UpdateSubAPIRequest {
+    subName: string;
+    apiKey: string;
+    passphrase: string;
+    permission?: string;
+    ipWhitelist?: string;
+    expire?: string;
+}
+export interface DeleteSubAPIRequest {
+    apiKey: string;
+    passphrase: string;
+    subName: string;
+}
+/**
+ * REST - FUNDING - FUNDING OVERVIEW
+ */
+/**
+ * REST - FUNDING - TRANSFER
+ */
+export interface SubmitTransfer {
+    amount: number;
+    currency: string;
+    recAccountType: 'MAIN' | 'TRADE';
+}
+export interface GetTransfersRequest {
+    startAt?: number;
+    endAt?: number;
+    status?: 'PROCESSING' | 'SUCCESS' | 'FAILURE';
+    queryStatus?: 'PROCESSING' | 'SUCCESS' | 'FAILURE'[];
+    currency?: string;
+    currentPage?: number;
+    pageSize?: number;
+}
+/**
+ *
+ * Futures Market Data
+ *
+ */
+export interface GetKlinesRequest {
+    symbol: string;
+    granularity: number;
+    from?: number;
+    to?: number;
+}
+export interface GetInterestRatesRequest {
+    symbol: string;
+    startAt?: number;
+    endAt?: number;
+    reverse?: boolean;
+    offset?: number;
+    forward?: boolean;
+    maxCount?: number;
+}
+/**
+ *
+ ***********
+ * Account
+ ***********
+ *
+ */
+/**
+ *
+ * Orders
+ *
+ */
+export interface Order {
+    clientOid: string;
+    side?: 'buy' | 'sell';
+    symbol: string;
+    leverage?: string;
+    type?: 'market' | 'limit';
+    remark?: string;
+    stop?: 'down' | 'up';
+    stopPriceType?: 'TP' | 'IP' | 'MP';
+    stopPrice?: string;
+    reduceOnly?: boolean;
+    postOnly?: boolean;
+    closeOrder?: boolean;
+    forceHold?: boolean;
+    stp?: 'CN' | 'CO' | 'CB';
+    price?: string;
+    size?: number;
+    timeInForce?: 'GTC' | 'IOC';
+    hidden?: boolean;
+    iceberg?: boolean;
+    visibleSize?: number;
+}
+export interface GetOrdersRequest {
+    status?: 'active' | 'done';
+    symbol?: string;
+    side?: 'buy' | 'sell';
+    type?: 'limit' | 'market' | 'limit_stop' | 'market_stop';
+    startAt?: number;
+    endAt?: number;
+    currentPage?: number;
+    pageSize?: number;
+}
+export interface GetStopOrdersRequest {
+    symbol?: string;
+    side?: 'buy' | 'sell';
+    type?: 'limit' | 'market';
+    startAt?: number;
+    endAt?: number;
+    currentPage?: number;
+    pageSize?: number;
+}
+/**
+ *
+ * Futures Fills
+ *
+ */
+export interface AccountFillsRequest {
+    orderId?: string;
+    symbol?: string;
+    side?: 'buy' | 'sell';
+    type?: 'limit' | 'market' | 'limit_stop' | 'market_stop';
+    startAt?: number;
+    endAt?: number;
+    currentPage?: number;
+    pageSize?: number;
+}
+/**
+ *
+ * Futures Positions
+ *
+ */
+export interface MaxOpenSizeRequest {
+    symbol: string;
+    price: number;
+    leverage: number;
+}
+/**
+ *
+ * Futures risk limit
+ *
+ */
+/**
+ *
+ * Futures funding fees
+ *
+ */
+export interface GetFundingRatesRequest {
+    symbol: string;
+    from: number;
+    to: number;
+}
+export interface GetFundingHistoryRequest {
+    symbol: string;
+    startAt?: number;
+    endAt?: number;
+    reverse?: boolean;
+    offset?: number;
+    forward?: boolean;
+    maxCount?: number;
+}

package/dist/cjs/types/request/futures.types.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * REST - ACCOUNT  - BASIC INFO
+ * Get Account Ledgers - Futures
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=futures.types.js.map

package/dist/cjs/types/request/futures.types.js.map

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

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

@@ -0,0 +1,56 @@
+export interface GetBalancesRequest {
+    currency?: string;
+    type?: 'main' | 'trade' | 'margin' | 'trade_hf';
+}
+export interface GetSpotTransactionsRequest {
+    currency?: string;
+    direction?: 'in' | 'out';
+    bizType?: 'DEPOSIT' | 'WITHDRAW' | 'TRANSFER' | 'SUB_TRANSFER' | 'TRADE_EXCHANGE' | 'MARGIN_EXCHANGE' | 'KUCOIN_BONUS' | 'BROKER_TRANSFER' | 'REBATE';
+    startAt?: number;
+    endAt?: number;
+}
+export interface AccountHFTransactionsRequest {
+    currency?: string;
+    direction?: 'in' | 'out';
+    bizType?: 'TRANSFER' | 'TRADE_EXCHANGE';
+    lastId?: number;
+    limit?: number;
+    startAt?: number;
+    endAt?: number;
+}
+export interface AccountHFMarginTransactionsRequest {
+    currency?: string;
+    direction?: 'in' | 'out';
+    bizType?: 'TRANSFER' | 'MARGIN_EXCHANGE' | 'ISOLATED_EXCHANGE' | 'LIQUIDATION' | 'ASSERT_RETURN';
+    lastId?: number;
+    limit?: number;
+    startAt?: number;
+    endAt?: number;
+}
+export interface CreateSubAccountRequest {
+    password: string;
+    remarks?: string;
+    subName: string;
+    access: string;
+}
+export interface CreateSubAccountAPIRequest {
+    subName: string;
+    passphrase: string;
+    remark: string;
+    permission?: string;
+    ipWhitelist?: string;
+    expire?: string;
+}
+export interface UpdateSubAccountAPIRequest {
+    subName: string;
+    apiKey: string;
+    passphrase: string;
+    permission?: string;
+    ipWhitelist?: string;
+    expire?: string;
+}
+export interface DeleteSubAccountAPIRequest {
+    apiKey: string;
+    passphrase: string;
+    subName: string;
+}

package/dist/cjs/types/request/spot-account.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=spot-account.js.map

package/dist/cjs/types/request/spot-account.js.map

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

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

@@ -0,0 +1,27 @@
+/**
+ *
+ * EARN
+ *
+ */
+export interface SubscribeEarnFixedIncomeRequest {
+    productId: string;
+    amount: string;
+    accountType: 'MAIN' | 'TRADE';
+}
+export interface InitiateRedemptionRequest {
+    orderId: string;
+    amount: string;
+    fromAccountType?: 'MAIN' | 'TRADE';
+    confirmPunishRedeem?: '1';
+}
+export interface GetEarnRedeemPreviewRequest {
+    orderId: string;
+    fromAccountType?: 'MAIN' | 'TRADE';
+}
+export interface GetEarnFixedIncomeHoldAssetsRequest {
+    currentPage?: number;
+    pageSize?: number;
+    productId?: string;
+    productCategory?: string;
+    currency?: string;
+}

package/dist/cjs/types/request/spot-earn.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ *
+ * EARN
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=spot-earn.js.map

package/dist/cjs/types/request/spot-earn.js.map

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

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

@@ -0,0 +1,88 @@
+/**
+ *
+ ***********
+ * Funding
+ ***********
+ *
+ */
+export interface GetMarginBalanceRequest {
+    quoteCurrency?: string;
+    queryType?: 'MARGIN' | 'MARGIN_V2' | 'ALL';
+}
+export interface GetIsolatedMarginBalanceRequest {
+    symbol?: string;
+    quoteCurrency?: string;
+    queryType?: 'ISOLATED' | 'ISOLATED_V2' | 'ALL';
+}
+/**
+ *
+ * Deposit
+ *
+ */
+export interface GetDepositsRequest {
+    currency?: string;
+    startAt?: number;
+    endAt?: number;
+    status?: 'PROCESSING' | 'SUCCESS' | 'FAILURE';
+}
+/**
+ *
+ * Withdrawals
+ *
+ */
+export interface GetWithdrawalsRequest {
+    currency?: string;
+    status?: 'PROCESSING' | 'WALLET_PROCESSING' | 'SUCCESS' | 'FAILURE';
+    startAt?: number;
+    endAt?: number;
+}
+export interface ApplyWithdrawRequest {
+    currency: string;
+    address: string;
+    amount: number;
+    memo?: string;
+    isInner?: boolean;
+    remark?: string;
+    chain?: string;
+    feeDeductType?: 'INTERNAL' | 'EXTERNAL';
+}
+/**
+ *
+ * Transfer
+ *
+ */
+export interface GetTransferableRequest {
+    currency: string;
+    type: 'MAIN' | 'TRADE' | 'TRADE_HF' | 'MARGIN' | 'ISOLATED';
+    tag?: string;
+}
+export interface FlexTransferRequest {
+    clientOid: string;
+    currency?: string;
+    amount: string;
+    fromUserId?: string;
+    fromAccountType: 'MAIN' | 'TRADE' | 'CONTRACT' | 'MARGIN' | 'ISOLATED' | 'TRADE_HF' | 'MARGIN_V2' | 'ISOLATED_V2';
+    fromAccountTag?: string;
+    type: 'INTERNAL' | 'PARENT_TO_SUB' | 'SUB_TO_PARENT';
+    toUserId?: string;
+    toAccountType: 'MAIN' | 'TRADE' | 'CONTRACT' | 'MARGIN' | 'ISOLATED' | 'TRADE_HF' | 'MARGIN_V2' | 'ISOLATED_V2';
+    toAccountTag?: string;
+}
+export interface submitTransferMasterSubRequest {
+    clientOid: string;
+    currency: string;
+    amount: string;
+    direction: 'OUT' | 'IN';
+    accountType?: 'MAIN' | 'TRADE' | 'TRADE_HF' | 'MARGIN' | 'CONTRACT';
+    subAccountType?: 'MAIN' | 'TRADE' | 'TRADE_HF' | 'MARGIN' | 'CONTRACT';
+    subUserId: string;
+}
+export interface InnerTransferRequest {
+    clientOid: string;
+    currency: string;
+    from: 'main' | 'trade' | 'trade_hf' | 'margin' | 'isolated' | 'margin_v2' | 'isolated_v2' | 'contract';
+    to: 'main' | 'trade' | 'trade_hf' | 'margin' | 'isolated' | 'margin_v2' | 'isolated_v2' | 'contract';
+    amount: string;
+    fromTag?: string;
+    toTag?: string;
+}

package/dist/cjs/types/request/spot-funding.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ *
+ ***********
+ * Funding
+ ***********
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=spot-funding.js.map

package/dist/cjs/types/request/spot-funding.js.map

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

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

@@ -0,0 +1,169 @@
+/**
+ *
+ ***********
+ * Margin Trading
+ ***********
+ *
+ */
+/**
+ *
+ * Margin HF trade
+ *
+ */
+export interface SubmitHFMarginOrderRequest {
+    clientOid: string;
+    side: 'buy' | 'sell';
+    symbol: string;
+    type?: 'limit' | 'market';
+    stp?: 'CN' | 'CO' | 'CB' | 'DC';
+    isIsolated?: boolean;
+    autoBorrow?: boolean;
+    autoRepay?: boolean;
+    price?: string;
+    size?: string;
+    timeInForce?: 'GTC' | 'GTT' | 'IOC' | 'FOK';
+    cancelAfter?: number;
+    postOnly?: boolean;
+    hidden?: boolean;
+    iceberg?: boolean;
+    visibleSize?: string;
+    funds?: string;
+}
+export interface HFMarginRequestOrder {
+    symbol: string;
+    tradeType: 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE';
+}
+export interface GetHFMarginFilledRequest {
+    symbol: string;
+    tradeType: 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE';
+    side?: 'buy' | 'sell';
+    type?: 'limit' | 'market';
+    startAt?: number;
+    endAt?: number;
+    lastId?: number;
+    limit?: number;
+}
+export interface getHFMarginFillsRequest {
+    orderId?: string;
+    symbol: string;
+    tradeType: 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE';
+    side?: 'buy' | 'sell';
+    type?: 'limit' | 'market';
+    startAt?: number;
+    endAt?: number;
+    lastId?: number;
+    limit?: number;
+}
+/**
+ *
+ * Orders
+ *
+ */
+export interface SubmitMarginOrderRequest {
+    clientOid: string;
+    side: 'buy' | 'sell';
+    symbol: string;
+    type?: 'limit' | 'market';
+    remark?: string;
+    stp?: 'CN' | 'CO' | 'CB' | 'DC';
+    marginModel?: 'cross' | 'isolated';
+    autoBorrow?: boolean;
+    autoRepay?: boolean;
+    price: string;
+    size?: string;
+    timeInForce?: 'GTC' | 'GTT' | 'IOC' | 'FOK';
+    cancelAfter?: number;
+    postOnly?: boolean;
+    hidden?: boolean;
+    iceberg?: boolean;
+    visibleSize?: string;
+    funds?: string;
+}
+/**
+ *
+ * Margin info
+ *
+ */
+export interface MarginRiskLimitRequest {
+    isIsolated: boolean;
+    symbol?: string;
+    currency?: string;
+}
+/**
+ *
+ * Isolated Margin
+ *
+ */
+/**
+ *
+ * Margin trading(v3)
+ *
+ */
+export interface MarginBorrowV3Request {
+    isIsolated?: boolean;
+    symbol?: string;
+    currency: string;
+    size: number;
+    timeInForce: 'IOC' | 'FOK';
+    isHf: boolean;
+}
+export interface MarginRepayV3Request {
+    isIsolated?: boolean;
+    symbol?: string;
+    currency: string;
+    size: number;
+    isHf: boolean;
+}
+export interface MarginHistoryV3Request {
+    currency: string;
+    isIsolated?: boolean;
+    symbol?: string;
+    orderNo?: string;
+    startTime?: number;
+    endTime?: number;
+    currentPage?: number;
+    pageSize?: number;
+}
+export interface MarginInterestRecordsRequest {
+    isIsolated?: boolean;
+    symbol?: string;
+    currency?: string;
+    startTime?: number;
+    endTime?: number;
+    currentPage?: number;
+    pageSize?: number;
+}
+/**
+ *
+ * Lending market(v3)
+ *
+ */
+export interface InitiateLendingSubscriptionV3Request {
+    currency: string;
+    size: string;
+    interestRate: string;
+}
+export interface InitiateLendingRedemptionV3Request {
+    currency: string;
+    size: string;
+    purchaseOrderNo: string;
+}
+export interface ModifyLendingSubscriptionOrdersV3Request {
+    currency: string;
+    purchaseOrderNo: string;
+    interestRate: string;
+}
+export interface GetLendingRedemptionOrdersV3Request {
+    currency: string;
+    redeemOrderNo?: string;
+    status: 'DONE' | 'PENDING';
+    currentPage?: number;
+    pageSize?: number;
+}
+export interface GetLendingSubscriptionOrdersV3Request {
+    currency: string;
+    purchaseOrderNo?: string;
+    status: 'DONE' | 'PENDING';
+    currentPage?: number;
+    pageSize?: number;
+}

package/dist/cjs/types/request/spot-margin-trading.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ *
+ ***********
+ * Margin Trading
+ ***********
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=spot-margin-trading.js.map

package/dist/cjs/types/request/spot-margin-trading.js.map

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