kucoin-api 2.0.0 → 2.0.2

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

@@ -10,17 +10,6 @@
  * Market data
  *
  */
-interface Chain {
-    chainName: string;
-    withdrawalMinSize: string;
-    withdrawalMinFee: string;
-    isWithdrawEnabled: boolean;
-    isDepositEnabled: boolean;
-    confirms: number;
-    preConfirms: number;
-    contractAddress: string;
-    chainId: string;
-}
 export interface CurrencyInfo {
     currency: string;
     name: string;
@@ -31,10 +20,23 @@ export interface CurrencyInfo {
     isMarginEnabled: boolean;
     isDebitEnabled: boolean;
     chains: Chain[];
+}
+interface Chain {
+    chainName: string;
+    withdrawalMinSize: string;
+    depositMinSize: string | null;
+    withdrawFeeRate: string;
+    withdrawalMinFee: string;
+    isWithdrawEnabled: boolean;
+    isDepositEnabled: boolean;
+    confirms: number;
+    preConfirms: number;
+    contractAddress: string;
     withdrawPrecision: number;
+    maxWithdraw: string | null;
+    maxDeposit: string | null;
     needTag: boolean;
-    maxWithdraw: string;
-    maxDeposit: string;
+    chainId: string;
 }
 export interface SymbolInfo {
     symbol: string;
@@ -42,7 +44,7 @@ export interface SymbolInfo {
     baseCurrency: string;
     quoteCurrency: string;
     feeCurrency: string;
-    market: string;
+    market: 'USDS' | 'BTC' | 'ALTS';
     baseMinSize: string;
     quoteMinSize: string;
     baseMaxSize: string;
@@ -54,6 +56,10 @@ export interface SymbolInfo {
     minFunds: string;
     isMarginEnabled: boolean;
     enableTrading: boolean;
+    feeCategory: 1 | 2 | 3;
+    makerFeeCoefficient: string;
+    takerFeeCoefficient: string;
+    st: boolean;
 }
 export interface Ticker {
     sequence: string;
@@ -65,6 +71,30 @@ export interface Ticker {
     bestBidSize: string;
     time: number;
 }
+export interface AllTickers {
+    time: number;
+    ticker: Ticker[];
+}
+export interface AllTickersItem {
+    symbol: string;
+    symbolName: string;
+    buy: string;
+    bestBidSize: string;
+    sell: string;
+    bestAskSize: string;
+    changeRate: string;
+    changePrice: string;
+    high: string;
+    low: string;
+    vol: string;
+    volValue: string;
+    last: string;
+    averagePrice: string;
+    takerFeeRate: string;
+    makerFeeRate: string;
+    takerCoefficient: string;
+    makerCoefficient: string;
+}
 export interface Symbol24hrStats {
     time: number;
     symbol: string;
@@ -96,15 +126,7 @@ export interface TradeHistory {
     size: string;
     side: string;
 }
-export interface Kline {
-    startAt: string;
-    open: string;
-    close: string;
-    high: string;
-    low: string;
-    volume: string;
-    amount: string;
-}
+export type Kline = [string, string, string, string, string, string, string];
 /**
  *
  * Spot HF trade
@@ -140,7 +162,8 @@ export interface SubmitMultipleHFOrdersSyncResponse {
     clientOid: string;
 }
 export interface SyncCancelHFOrderResponse {
-    orderId: string;
+    clientOid?: string;
+    orderId?: string;
     originSize: string;
     dealSize: string;
     remainSize: string;
@@ -162,12 +185,13 @@ export interface AutoCancelHFOrderSettingQueryResponse {
 }
 export interface HFFilledOrder {
     id: number;
-    symbol: string;
-    tradeId: number;
     orderId: string;
     counterOrderId: string;
-    side: string;
-    liquidity: string;
+    tradeId: number;
+    symbol: string;
+    side: 'buy' | 'sell';
+    liquidity: 'taker' | 'maker';
+    type: 'limit' | 'market';
     forceTaker: boolean;
     price: string;
     size: string;
@@ -177,43 +201,45 @@ export interface HFFilledOrder {
     feeCurrency: string;
     stop: string;
     tradeType: string;
-    type: string;
+    taxRate: string;
+    tax: string;
     createdAt: number;
 }
 export interface HFOrder {
     id: string;
+    clientOid: string;
     symbol: string;
     opType: string;
-    type: string;
-    side: string;
+    type: 'limit' | 'market';
+    side: 'buy' | 'sell';
     price: string;
     size: string;
-    dealSize: string;
-    cancelledSize: string;
-    remainSize: string;
     funds: string;
+    dealSize: string;
     dealFunds: string;
-    cancelledFunds: string;
+    remainSize: string;
     remainFunds: string;
+    cancelledSize: string;
+    cancelledFunds: string;
     fee: string;
     feeCurrency: string;
-    stp: string;
-    timeInForce: string;
+    stp?: 'DC' | 'CO' | 'CN' | 'CB' | null;
+    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;
+    remark?: string | null;
+    tags?: string | null;
     cancelExist: boolean;
+    tradeType: string;
+    inOrderBook: boolean;
+    active: boolean;
+    tax: string;
     createdAt: number;
     lastUpdatedAt: number;
-    tradeType: string;
 }
 /**
  *
@@ -324,37 +350,37 @@ export interface StopOrders {
     items: StopOrderItem[];
 }
 export interface StopOrderItem {
-    id: string;
-    symbol: string;
-    userId: string;
-    status: 'NEW' | 'TRIGGERED';
-    type: 'limit' | 'market';
-    side: 'buy' | 'sell';
-    price: string;
-    size: string;
-    funds: string | null;
-    stp: string | null;
-    timeInForce: 'GTC' | 'GTT' | 'IOC' | 'FOK';
-    cancelAfter: number;
-    postOnly: boolean;
-    hidden: boolean;
-    iceberg: boolean;
-    visibleSize: string | null;
-    channel: string;
-    clientOid: string;
-    remark: string | null;
-    tags: string | null;
-    orderTime: number;
-    domainId: string;
-    tradeSource: 'USER' | 'MARGIN_SYSTEM';
-    tradeType: 'TRADE' | 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE';
-    feeCurrency: string;
-    takerFeeRate: string;
-    makerFeeRate: string;
-    createdAt: number;
-    stop: 'loss' | 'entry';
-    stopTriggerTime: number | null;
-    stopPrice: string;
+    id?: string;
+    symbol?: string;
+    userId?: string;
+    status?: 'NEW' | 'TRIGGERED';
+    type?: 'limit' | 'market' | 'limit_stop' | 'market_stop';
+    side?: 'buy' | 'sell';
+    price?: string;
+    size?: string;
+    funds?: string | null;
+    stp?: string | null;
+    timeInForce?: 'GTC' | 'GTT' | 'IOC' | 'FOK';
+    cancelAfter?: number;
+    postOnly?: boolean;
+    hidden?: boolean;
+    iceberg?: boolean;
+    visibleSize?: string | null;
+    channel?: string;
+    clientOid?: string;
+    remark?: string | null;
+    tags?: string | null;
+    domainId?: string;
+    tradeSource?: 'USER' | 'MARGIN_SYSTEM';
+    tradeType?: 'TRADE' | 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE';
+    feeCurrency?: string;
+    takerFeeRate?: string;
+    makerFeeRate?: string;
+    createdAt?: number;
+    stop?: 'loss' | 'entry';
+    stopTriggerTime?: number | null;
+    stopPrice?: string;
+    orderTime?: number;
 }
 /**
  *

package/dist/cjs/types/websockets/client.d.ts

@@ -1,3 +1,5 @@
+import { AxiosRequestConfig } from 'axios';
+import { RestClientOptions } from '../../lib/requestUtils.js';
 /** General configuration for the WebsocketClient */
 export interface WSClientConfigurableOptions {
     /** Your API key */
@@ -14,6 +16,8 @@ export interface WSClientConfigurableOptions {
     pongTimeout?: number;
     /** Delay in milliseconds before respawning the connection */
     reconnectTimeout?: number;
+    restOptions?: RestClientOptions;
+    requestOptions?: AxiosRequestConfig;
     wsOptions?: {
         protocols?: string[];
         agent?: any;

package/dist/mjs/FuturesClient.d.ts

@@ -1,8 +1,8 @@
 import { AxiosRequestConfig } from 'axios';
 import { BaseRestClient } from './lib/BaseRestClient.js';
 import { RestClientOptions, RestClientType } from './lib/requestUtils.js';
-import { AccountFillsRequest, BatchCancelOrdersRequest, GetFundingHistoryRequest, GetFundingRatesRequest, GetInterestRatesRequest, GetKlinesRequest, GetOrdersRequest, GetStopOrdersRequest, GetTransactionsRequest, MaxOpenSizeRequest, Order, SLTPOrder } from './types/request/futures.types.js';
-import { AccountBalance, AccountSummary, AddMargin, BatchCancelOrderResult, FullOrderBookDetail, FuturesAccountFundingRateHistory, FuturesAccountTransaction, FuturesActiveOrder, FuturesClosedPositions, FuturesCurrentFundingRate, FuturesFill, FuturesFills, FuturesHistoricFundingRate, FuturesKline, FuturesMarkPrice, FuturesOrder, FuturesOrders, FuturesPosition, FuturesRiskLimit, FuturesSymbolInfo, IndexListItem, InterestRateItem, MarketTradeDetail, MaxOpenSize, PremiumIndexItem, SubBalance, SubmitMultipleOrdersFuturesResponse, TickerDetail } from './types/response/futures.types.js';
+import { AccountFillsRequest, BatchCancelOrdersRequest, CopyTradeOrderRequest, CopyTradeSLTPOrderRequest, GetFundingHistoryRequest, GetFundingRatesRequest, GetInterestRatesRequest, GetKlinesRequest, GetOrdersRequest, GetStopOrdersRequest, GetTransactionsRequest, MaxOpenSizeRequest, Order, SLTPOrder } from './types/request/futures.types.js';
+import { AccountBalance, AccountSummary, AddMargin, BatchCancelOrderResult, CopyTradePosition, FullOrderBookDetail, FuturesAccountFundingRateHistory, FuturesAccountTransaction, FuturesActiveOrder, FuturesClosedPositions, FuturesCurrentFundingRate, FuturesFill, FuturesFills, FuturesHistoricFundingRate, FuturesKline, FuturesMarkPrice, FuturesOrder, FuturesOrders, FuturesPosition, FuturesRiskLimit, FuturesSubAccount, FuturesSymbolInfo, IndexListItem, InterestRateItem, MarketTradeDetail, MaxOpenSize, PremiumIndexItem, SubmitMultipleOrdersFuturesResponse, TickerDetail } from './types/response/futures.types.js';
 import { APISuccessResponse, ServiceStatus } from './types/response/shared.types.js';
 import { WsConnectionInfo } from './types/response/ws.js';
 /**
@@ -31,7 +31,7 @@ export declare class FuturesClient extends BaseRestClient {
     }): Promise<APISuccessResponse<AccountBalance>>;
     /**
      * Get Account Ledgers - Futures
-     * This interface can query the ledger records of the futures business line
+     * This endpoint can query the ledger records of the futures business line
      */
     getTransactions(params: GetTransactionsRequest): Promise<APISuccessResponse<{
         hasMore: boolean;
@@ -50,7 +50,7 @@ export declare class FuturesClient extends BaseRestClient {
         currency?: string;
     }): Promise<APISuccessResponse<{
         summary: AccountSummary;
-        accounts: SubBalance[];
+        accounts: FuturesSubAccount[];
     }>>;
     /**
      *
@@ -59,7 +59,7 @@ export declare class FuturesClient extends BaseRestClient {
      */
     /**
      * Get Actual Fee - Futures
-     * This interface is for the actual futures fee rate of the trading pair. The fee rate of your sub-account is the same as that of the master account.
+     * This endpoint is for the actual futures fee rate of the trading pair. The fee rate of your sub-account is the same as that of the master account.
      */
     getTradingPairFee(params: {
         symbol: string;
@@ -208,7 +208,7 @@ export declare class FuturesClient extends BaseRestClient {
     submitMultipleOrders(params: Order[]): Promise<APISuccessResponse<SubmitMultipleOrdersFuturesResponse[]>>;
     /**
      * Add Take Profit And Stop Loss Order
-     * Place take profit and stop loss order supports both take-profit and stop-loss functions, and other functions are exactly the same as the place order interface.
+     * Place take profit and stop loss order supports both take-profit and stop-loss functions, and other functions are exactly the same as the place order endpoint.
      */
     submitSLTPOrder(params: SLTPOrder): Promise<APISuccessResponse<{
         orderId?: string;
@@ -229,6 +229,7 @@ export declare class FuturesClient extends BaseRestClient {
      */
     cancelOrderByClientOid(params: {
         clientOid: string;
+        symbol: string;
     }): Promise<APISuccessResponse<{
         clientOid: string;
     }>>;
@@ -236,9 +237,7 @@ export declare class FuturesClient extends BaseRestClient {
      * Batch Cancel Orders
      * Cancel multiple orders.
      */
-    batchCancelOrders(params: BatchCancelOrdersRequest): Promise<APISuccessResponse<{
-        data: BatchCancelOrderResult[];
-    }>>;
+    batchCancelOrders(params: BatchCancelOrdersRequest): Promise<APISuccessResponse<BatchCancelOrderResult[]>>;
     /**
      * Cancel All Orders
      * Using this endpoint, all open orders (excluding stop orders) can be canceled in batches.
@@ -285,7 +284,7 @@ export declare class FuturesClient extends BaseRestClient {
     }): Promise<APISuccessResponse<FuturesOrder[]>>;
     /**
      * Get Stop Order List
-     * Get the un-triggered stop orders list. Stop orders that have been triggered can be queried through the general order interface
+     * Get the un-triggered stop orders list. Stop orders that have been triggered can be queried through the general order endpoint
      */
     getStopOrders(params?: GetStopOrdersRequest): Promise<APISuccessResponse<FuturesOrders>>;
     /**
@@ -315,7 +314,7 @@ export declare class FuturesClient extends BaseRestClient {
      */
     /**
      * Get Margin Mode
-     * This interface can query the margin mode of the current symbol.
+     * This endpoint can query the margin mode of the current symbol.
      */
     getMarginMode(params: {
         symbol: string;
@@ -355,7 +354,7 @@ export declare class FuturesClient extends BaseRestClient {
     }): Promise<APISuccessResponse<FuturesPosition[]>>;
     /**
      * Get Positions History
-     * This interface can query position history information records.
+     * This endpoint can query position history information records.
      */
     getHistoryPositions(params?: {
         symbol?: string;
@@ -366,14 +365,14 @@ export declare class FuturesClient extends BaseRestClient {
     }): Promise<APISuccessResponse<FuturesClosedPositions>>;
     /**
      * Get Max Withdraw Margin
-     * This interface can query the maximum amount of margin that the current position supports withdrawal.
+     * This endpoint can query the maximum amount of margin that the current position supports withdrawal.
      */
     getMaxWithdrawMargin(params: {
         symbol: string;
-    }): Promise<APISuccessResponse<number>>;
+    }): Promise<APISuccessResponse<string>>;
     /**
      * Get Cross Margin Leverage
-     * This interface can query the current symbol’s cross-margin leverage multiple.
+     * This endpoint can query the current symbol’s cross-margin leverage multiple.
      */
     getCrossMarginLeverage(params: {
         symbol: string;
@@ -383,7 +382,7 @@ export declare class FuturesClient extends BaseRestClient {
     }>>;
     /**
      * Modify Cross Margin Leverage
-     * This interface can modify the current symbol’s cross-margin leverage multiple.
+     * This endpoint can modify the current symbol’s cross-margin leverage multiple.
      */
     changeCrossMarginLeverage(params: {
         symbol: string;
@@ -408,25 +407,22 @@ export declare class FuturesClient extends BaseRestClient {
     withdrawMargin(params: {
         symbol: string;
         withdrawAmount: string;
-    }): Promise<APISuccessResponse<{
-        sybmol: string;
-        withdrawAmount: number;
-    }>>;
+    }): Promise<APISuccessResponse<string>>;
     /**
      * Get Isolated Margin Risk Limit
-     * This interface can be used to obtain information about risk limit level of a specific contract(Only valid for isolated Margin).
+     * This endpoint can be used to obtain information about risk limit level of a specific contract(Only valid for isolated Margin).
      */
     getRiskLimitLevel(params: {
         symbol: string;
     }): Promise<APISuccessResponse<FuturesRiskLimit[]>>;
     /**
      * Modify Isolated Margin Risk Limit
-     * This interface is for the adjustment of the risk limit level(Only valid for isolated Margin).
+     * This endpoint is for the adjustment of the risk limit level(Only valid for isolated Margin).
      */
     updateRiskLimitLevel(params: {
         symbol: string;
         level: number;
-    }): Promise<any>;
+    }): Promise<boolean>;
     /**
      *
      * REST - Futures Trading - Funding Fees
@@ -434,7 +430,7 @@ export declare class FuturesClient extends BaseRestClient {
      */
     /**
      * Get Current Funding Rate
-     * This interface can be used to obtain the current funding rate of the specified symbol.
+     * This endpoint can be used to obtain the current funding rate of the specified symbol.
      */
     getFundingRate(params: {
         symbol: string;
@@ -452,6 +448,115 @@ export declare class FuturesClient extends BaseRestClient {
         dataList: FuturesAccountFundingRateHistory[];
         hasMore: boolean;
     }>>;
+    /**
+     *
+     * REST - Futures Trading - CopyTrading
+     *
+     */
+    /**
+     * Add Order
+     * Place order to the futures trading system for copy trading
+     */
+    submitCopyTradeOrder(params: CopyTradeOrderRequest): Promise<APISuccessResponse<{
+        orderId: string;
+        clientOid: string;
+    }>>;
+    /**
+     * Add Order Test
+     * Order test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint,
+     * and can be used to verify whether the signature is correct and other operations.
+     */
+    submitCopyTradeOrderTest(params: CopyTradeOrderRequest): Promise<APISuccessResponse<{
+        orderId: string;
+        clientOid: string;
+    }>>;
+    /**
+     * Add Take Profit And Stop Loss Order
+     * Place take profit and stop loss order supports both take-profit and stop-loss functions, and other functions are exactly the same as the place order endpoint.
+     */
+    submitCopyTradeSLTPOrder(params: CopyTradeSLTPOrderRequest): Promise<APISuccessResponse<{
+        orderId: string;
+        clientOid: string;
+    }>>;
+    /**
+     * Cancel Order By OrderId
+     * Cancel an order (including a stop order) in copy trading.
+     */
+    cancelCopyTradeOrderById(params: {
+        orderId: string;
+    }): Promise<APISuccessResponse<{
+        cancelledOrderIds: string[];
+    }>>;
+    /**
+     * Cancel Order By Client Order Id
+     * Cancel an order (including a stop order) in copy trading by client order id.
+     */
+    cancelCopyTradeOrderByClientOid(params: {
+        clientOid?: string;
+        symbol: string;
+    }): Promise<APISuccessResponse<{
+        clientOid: string;
+    }>>;
+    /**
+     * Get Max Open Size
+     * Get Maximum Open Position Size.
+     */
+    getCopyTradeMaxOpenSize(params: {
+        symbol: string;
+        maxBuyOpenSize: string;
+        maxSellOpenSize: string;
+    }): Promise<APISuccessResponse<{
+        symbol: string;
+        price: string;
+        leverage: number;
+    }>>;
+    /**
+     * Get Max Withdraw Margin
+     * This endpoint can query the maximum amount of margin that the current position supports withdrawal.
+     */
+    getCopyTradeMaxWithdrawMargin(params: {
+        symbol: string;
+    }): Promise<APISuccessResponse<string>>;
+    /**
+     * Add Isolated Margin
+     * Add Isolated Margin Manually.
+     */
+    addCopyTradeIsolatedMargin(params: {
+        symbol: string;
+        margin: number;
+        bizNo: string;
+    }): Promise<APISuccessResponse<CopyTradePosition>>;
+    /**
+     * Remove Isolated Margin
+     * Remove Isolated Margin Manually.
+     */
+    removeCopyTradeIsolatedMargin(params: {
+        symbol: string;
+        withdrawAmount: string;
+    }): Promise<APISuccessResponse<string>>;
+    /**
+     * Modify Isolated Margin Risk Limit
+     * This endpoint is for the adjustment of the risk limit level(Only valid for isolated Margin).
+     * To adjust the level will cancel the open order, the response can only indicate whether the submit of the adjustment request is successful or not.
+     */
+    modifyCopyTradeRiskLimitLevel(params: {
+        symbol: string;
+        level: number;
+    }): Promise<APISuccessResponse<boolean>>;
+    /**
+     * Modify Isolated Margin Auto-Deposit Status
+     * This endpoint is only applicable to isolated margin and is no longer recommended. It is recommended to use cross margin instead.
+     * @deprecated - It is recommended to use cross margin instead
+     */
+    updateCopyTradeAutoDepositStatus(params: {
+        symbol: string;
+        status: boolean;
+    }): Promise<APISuccessResponse<boolean>>;
+    /**
+     *
+     * REST - Futures - Broker
+     *
+     */
     /**
      * Get download link for broker rebate orders
      *