kucoin-api 1.0.23 → 2.0.1

package/dist/cjs/FuturesClient.js

@@ -23,269 +23,508 @@ class FuturesClient extends BaseRestClient_js_1.BaseRestClient {
     generateNewOrderID() {
         return (0, nanoid_1.nanoid)(32);
     }
-    getServerTime() {
-        return this.get('api/v1/timestamp');
-    }
-    getServiceStatus() {
-        return this.get('api/v1/status');
+    /**
+     *
+     * REST - ACCOUNT INFO - Account & Funding
+     *
+     */
+    /**
+     * Get Account - Futures
+     * Request via this endpoint to get the info of the futures account.
+     */
+    getBalance(params) {
+        return this.getPrivate('api/v1/account-overview', params);
     }
     /**
-     * REST - ACCOUNT  - BASIC INFO
      * Get Account Ledgers - Futures
+     * This endpoint can query the ledger records of the futures business line
      */
     getTransactions(params) {
         return this.getPrivate('api/v1/transaction-history', params);
     }
     /**
-     * REST - ACCOUNT  - SUBACCOUNT API
+     *
+     * REST - ACCOUNT INFO - Sub Account
+     *
      */
-    getSubAPIs(params) {
-        return this.getPrivate('api/v1/sub/api-key', params);
-    }
-    createSubAPI(params) {
-        return this.postPrivate('api/v1/sub/api-key', params);
-    }
-    updateSubAPI(params) {
-        return this.postPrivate('api/v1/sub/api-key/update', params);
-    }
-    deleteSubAPI(params) {
-        return this.deletePrivate('api/v1/sub/api-key', params);
-    }
     /**
-     * REST - FUNDING - FUNDING OVERVIEW
+     * Get SubAccount List - Futures Balance(V2)
+     * This endpoint can be used to get Futures sub-account information.
      */
-    getBalance(params) {
-        return this.getPrivate('api/v1/account-overview', params);
-    }
     getSubBalances(params) {
         return this.getPrivate('api/v1/account-overview-all', params);
     }
     /**
-     * REST - FUNDING - TRANSFER
+     *
+     * REST - Account Info - Trade Fee
+     *
      */
     /**
-     * @deprecated This method is deprecated.
-     * It is recommended to use the GET /api/v3/accounts/universal-transfer endpoint instead of this endpoint
+     * Get Actual Fee - Futures
+     * 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.
      */
-    submitTransferOut(params) {
-        return this.postPrivate('api/v3/transfer-out', params);
-    }
-    /**
-     * @deprecated This method is deprecated.
-     * It is recommended to use the GET /api/v3/accounts/universal-transfer endpoint instead of this endpoint
-     */
-    submitTransferIn(params) {
-        return this.postPrivate('api/v1/transfer-in', params);
+    getTradingPairFee(params) {
+        return this.getPrivate('api/v1/trade-fees', params);
     }
     /**
-     * @deprecated This method is deprecated.
+     *
+     * REST - Futures Trading - Market Data
+     *
      */
-    getTransfers(params) {
-        return this.getPrivate('api/v1/transfer-list', params);
-    }
     /**
-     * REST - FUNDING - TRADE FEE
+     * Get Symbol
+     * Get information of specified contracts that can be traded.
+     * This API will return a list of tradable contracts, including some key parameters of the contract such as the symbol name, tick size, mark price,etc.
      */
-    getTradingPairFee(params) {
-        return this.getPrivate('api/v1/trade-fees', params);
+    getSymbol(params) {
+        return this.get(`api/v1/contracts/${params.symbol}`);
     }
     /**
-     *
-     * REST - FUTURES TRADING - Market Data
-     *
+     * Get Symbol
+     * Get information of specified contracts that can be traded.
+     * This API will return a list of tradable contracts, including some key parameters of the contract such as the symbol name, tick size, mark price,etc.
      */
     getSymbols() {
         return this.get('api/v1/contracts/active');
     }
-    getSymbol(params) {
-        return this.get(`api/v1/contracts/${params.symbol}`);
-    }
+    /**
+     * Get Ticker
+     * This endpoint returns "last traded price/size"、"best bid/ask price/size" etc. of a single symbol.
+     */
     getTicker(params) {
         return this.get('api/v1/ticker', params);
     }
+    /**
+     * Get All Tickers
+     * This endpoint returns "last traded price/size"、"best bid/ask price/size" etc. of all symbol.
+     */
     getTickers() {
         return this.get('api/v1/allTickers');
     }
+    /**
+     * Get Full OrderBook
+     * Query for Full orderbook depth data. (aggregated by price)
+     */
     getFullOrderBookLevel2(params) {
         return this.get('api/v1/level2/snapshot', params);
     }
+    /**
+     * Get Part OrderBook
+     * Query for part orderbook depth data. (aggregated by price)
+     */
     getPartOrderBookLevel2Depth20(params) {
         return this.get('api/v1/level2/depth20', params);
     }
+    /**
+     * Get Part OrderBook
+     * Query for part orderbook depth data. (aggregated by price)
+     */
     getPartOrderBookLevel2Depth100(params) {
         return this.get('api/v1/level2/depth100', params);
     }
+    /**
+     * Get Trade History
+     * Request via this endpoint to get the trade history of the specified symbol, the returned quantity is the last 100 transaction records.
+     */
     getMarketTrades(params) {
         return this.get('api/v1/trade/history', params);
     }
+    /**
+     * Get Klines
+     * Get the Kline of the symbol. Data are returned in grouped buckets based on requested type.
+     */
     getKlines(params) {
         return this.get('api/v1/kline/query', params);
     }
-    getInterestRates(params) {
-        return this.get('api/v1/interest/query', params);
+    /**
+     * Get Mark Price
+     * Get the mark price of the symbol.
+     */
+    getMarkPrice(params) {
+        return this.get(`api/v1/mark-price/${params.symbol}/current`);
     }
+    /**
+     * Get Spot Index Price
+     * This endpoint returns the index price of the specified symbol.
+     */
     getIndex(params) {
         return this.get('api/v1/index/query', params);
     }
-    getMarkPrice(params) {
-        return this.get(`api/v1/mark-price/${params.symbol}/current`);
+    /**
+     * Get Interest Rate Index
+     * This endpoint returns the interest rate index of the specified symbol.
+     */
+    getInterestRates(params) {
+        return this.get('api/v1/interest/query', params);
     }
+    /**
+     * Get Premium Index
+     * This endpoint returns the premium index of the specified symbol.
+     */
     getPremiumIndex(params) {
         return this.get('api/v1/premium/query', params);
     }
+    /**
+     * Get 24hr Stats
+     * Get the statistics of the platform futures trading volume in the last 24 hours.
+     */
     get24HourTransactionVolume() {
         return this.get('api/v1/trade-statistics');
     }
+    /**
+     * Get Server Time
+     * Get the API server time. This is the Unix timestamp.
+     */
+    getServerTime() {
+        return this.get('api/v1/timestamp');
+    }
+    /**
+     * Get Service Status
+     * This endpoint returns the status of the API service.
+     */
+    getServiceStatus() {
+        return this.get('api/v1/status');
+    }
     /**
      *
-     * REST - FUTURES TRADING - Orders
+     * REST - Futures Trading - Orders
      *
      */
+    /**
+     * Add Order
+     * Place order to the futures trading system
+     */
     submitOrder(params) {
         return this.postPrivate('api/v1/orders', params);
     }
-    submitNewOrderTest() {
-        return this.postPrivate('api/v1/orders/test');
+    /**
+     * 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.
+     */
+    submitNewOrderTest(params) {
+        return this.postPrivate('api/v1/orders/test', params);
     }
+    /**
+     * Batch Add Orders
+     * Place multiple order to the futures trading system
+     */
+    submitMultipleOrders(params) {
+        return this.postPrivate('api/v1/orders/multi', params);
+    }
+    /**
+     * 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.
+     */
+    submitSLTPOrder(params) {
+        return this.postPrivate('api/v1/st-orders', params);
+    }
+    /**
+     * Cancel Order By OrderId
+     * Cancel an order (including a stop order).
+     */
     cancelOrderById(params) {
         return this.deletePrivate(`api/v1/orders/${params.orderId}`);
     }
+    /**
+     * Cancel Order By Client Order Id
+     * Cancel an order (including a stop order) by client order id.
+     */
     cancelOrderByClientOid(params) {
-        return this.deletePrivate(`api/v1/orders/client-order/${params.clientOid}`);
+        const { clientOid, symbol } = params;
+        return this.deletePrivate(`api/v1/orders/client-order/${clientOid}`, {
+            symbol,
+        });
     }
+    /**
+     * Batch Cancel Orders
+     * Cancel multiple orders.
+     */
     batchCancelOrders(params) {
         return this.deletePrivate('api/v1/orders/multi-cancel', params);
     }
-    submitSLTPOrder(params) {
-        return this.postPrivate('api/v1/st-orders', params);
-    }
-    submitMultipleOrders(params) {
-        return this.postPrivate('api/v1/orders/multi', params);
-    }
     /**
-     * @deprecated, use cancelAllOrdersV3 instead
+     * Cancel All Orders
+     * Using this endpoint, all open orders (excluding stop orders) can be canceled in batches.
      */
-    cancelAllOrders(params) {
-        return this.deletePrivate('api/v1/orders', params);
-    }
     cancelAllOrdersV3(params) {
         return this.deletePrivate('api/v3/orders', params);
     }
+    /**
+     * Cancel All Stop orders
+     * Using this endpoint, all untriggered stop orders can be canceled in batches.
+     */
     cancelAllStopOrders(params) {
         return this.deletePrivate('api/v1/stopOrders', params);
     }
+    /**
+     * Get Order By OrderId
+     * Get order details by order id.
+     */
+    getOrderByOrderId(params) {
+        return this.getPrivate(`api/v1/orders/${params.orderId}`);
+    }
+    /**
+     * Get Order By Client Order Id
+     * Get order details by client order id.
+     */
+    getOrderByClientOrderId(params) {
+        return this.getPrivate(`api/v1/orders/byClientOid`, params);
+    }
+    /**
+     * Get Order List
+     * List your current orders. Any limit order on the exchange order book is in active status.
+     */
     getOrders(params) {
         return this.getPrivate('api/v1/orders', params);
     }
-    getStopOrders(params) {
-        return this.getPrivate('api/v1/stopOrders', params);
-    }
+    /**
+     * Get Recent Closed Orders
+     * Get a list of recent 1000 closed orders in the last 24 hours.
+     */
     getRecentOrders(params) {
         return this.getPrivate('api/v1/recentDoneOrders', params);
     }
-    getOrderByOrderId(params) {
-        return this.getPrivate(`api/v1/orders/${params.orderId}`);
+    /**
+     * Get Stop Order List
+     * Get the un-triggered stop orders list. Stop orders that have been triggered can be queried through the general order endpoint
+     */
+    getStopOrders(params) {
+        return this.getPrivate('api/v1/stopOrders', params);
     }
-    getOrderByClientOrderId(params) {
-        return this.getPrivate(`api/v1/orders/byClientOid`, params);
+    /**
+     * Get Open Order Value
+     * You can query this endpoint to get the the total number and value of the all your active orders.
+     */
+    getOpenOrderStatistics(params) {
+        return this.getPrivate('api/v1/openOrderStatistics', params);
     }
     /**
-     *
-     * REST - FUTURES TRADING - Fills
-     *
+     * Get Recent Trade History
+     * Get a list of recent 1000 fills in the last 24 hours.
      */
+    getRecentFills(params) {
+        return this.getPrivate('api/v1/recentFills', params);
+    }
     /**
+     * Get Trade History
      * Get a list of recent fills.
-     *
-     * If you need to get your recent trade history with low latency, please query endpoint Get List of Orders Completed in 24h.
-     * The requested data is not real-time.
+     * If you need to get your recent trade history with low latency, please query endpoint Get List of Orders Completed in 24h. The requested data is not real-time.
      */
     getFills(params) {
         return this.getPrivate('api/v1/fills', params);
     }
     /**
-     * Get a list of recent 1000 fills in the last 24 hours.
      *
-     * If you need to get your recent traded order history with low latency, you may query this endpoint.
+     * REST - Futures Trading - Positions
+     *
      */
-    getRecentFills(params) {
-        return this.getPrivate('api/v1/recentFills', params);
+    /**
+     * Get Margin Mode
+     * This endpoint can query the margin mode of the current symbol.
+     */
+    getMarginMode(params) {
+        return this.getPrivate('api/v2/position/getMarginMode', params);
     }
-    getOpenOrderStatistics(params) {
-        return this.getPrivate('api/v1/openOrderStatistics', params);
+    /**
+     * Switch Margin Mode
+     * Modify the margin mode of the current symbol.
+     */
+    updateMarginMode(params) {
+        return this.postPrivate('api/v2/position/changeMarginMode', params);
     }
     /**
-     *
-     * REST - FUTURES TRADING - Positions
-     *
+     * Get Max Open Size
+     * Get Maximum Open Position Size.
      */
     getMaxOpenSize(params) {
         return this.getPrivate('api/v2/getMaxOpenSize', params);
     }
+    /**
+     * Get Position Details
+     * Get the position details of a specified position.
+     */
     getPosition(params) {
         return this.getPrivate('api/v1/position', params);
     }
+    /**
+     * Get Position List
+     * Get the position details of a specified position.
+     */
     getPositions(params) {
         return this.getPrivate('api/v1/positions', params);
     }
+    /**
+     * Get Positions History
+     * This endpoint can query position history information records.
+     */
     getHistoryPositions(params) {
         return this.getPrivate('api/v1/history-positions', params);
     }
     /**
-     * @deprecated This method is deprecated.
-     * Currently, it is not recommended to use the Isolated margin + auto deposit margin feature.
-     * It is recommended to switch to the cross margin mode.
-     * Please refer to POST /api/v2/position/changeMarginMode endpoint
+     * Get Max Withdraw Margin
+     * This endpoint can query the maximum amount of margin that the current position supports withdrawal.
      */
-    updateAutoDepositStatus(params) {
-        return this.postPrivate('api/v1/position/margin/auto-deposit-status', params);
-    }
     getMaxWithdrawMargin(params) {
         return this.getPrivate('api/v1/margin/maxWithdrawMargin', params);
     }
-    withdrawMargin(params) {
-        return this.postPrivate('api/v1/margin/withdrawMargin', params);
-    }
-    depositMargin(params) {
-        return this.postPrivate('api/v1/position/margin/deposit-margin', params);
-    }
-    getMarginMode(params) {
-        return this.getPrivate('api/v2/position/getMarginMode', params);
-    }
-    updateMarginMode(params) {
-        return this.postPrivate('api/v2/position/changeMarginMode', params);
-    }
+    /**
+     * Get Cross Margin Leverage
+     * This endpoint can query the current symbol’s cross-margin leverage multiple.
+     */
     getCrossMarginLeverage(params) {
         return this.getPrivate('api/v2/getCrossUserLeverage', params);
     }
+    /**
+     * Modify Cross Margin Leverage
+     * This endpoint can modify the current symbol’s cross-margin leverage multiple.
+     */
     changeCrossMarginLeverage(params) {
         return this.postPrivate('api/v2/changeCrossUserLeverage', params);
     }
     /**
-     *
-     * REST - FUTURES TRADING - Risk limit
-     *
+     * Add Isolated Margin
+     * Add Isolated Margin Manually.
+     */
+    depositMargin(params) {
+        return this.postPrivate('api/v1/position/margin/deposit-margin', params);
+    }
+    /**
+     * Remove Isolated Margin
+     * Remove Isolated Margin Manually.
+     */
+    withdrawMargin(params) {
+        return this.postPrivate('api/v1/margin/withdrawMargin', params);
+    }
+    /**
+     * Get Isolated Margin Risk Limit
+     * This endpoint can be used to obtain information about risk limit level of a specific contract(Only valid for isolated Margin).
      */
     getRiskLimitLevel(params) {
         return this.getPrivate(`api/v1/contracts/risk-limit/${params.symbol}`);
     }
+    /**
+     * Modify Isolated Margin Risk Limit
+     * This endpoint is for the adjustment of the risk limit level(Only valid for isolated Margin).
+     */
     updateRiskLimitLevel(params) {
         return this.postPrivate('api/v1/position/risk-limit-level/change', params);
     }
     /**
      *
-     * REST - FUTURES TRADING - Funding fees
+     * REST - Futures Trading - Funding Fees
      *
      */
+    /**
+     * Get Current Funding Rate
+     * This endpoint can be used to obtain the current funding rate of the specified symbol.
+     */
     getFundingRate(params) {
-        return this.get(`api/v1/funding-rate/${params.symbol}/current`);
+        return this.getPrivate(`api/v1/funding-rate/${params.symbol}/current`);
     }
+    /**
+     * Get Public Funding History
+     * Query the funding rate at each settlement time point within a certain time range of the corresponding contract
+     */
     getFundingRates(params) {
-        return this.get('api/v1/contract/funding-rates', params);
+        return this.getPrivate('api/v1/contract/funding-rates', params);
     }
+    /**
+     * Get Private Funding History
+     * Submit request to get the funding history.
+     */
     getFundingHistory(params) {
         return this.getPrivate('api/v1/funding-history', params);
     }
+    /**
+     *
+     * REST - Futures Trading - CopyTrading
+     *
+     */
+    /**
+     * Add Order
+     * Place order to the futures trading system for copy trading
+     */
+    submitCopyTradeOrder(params) {
+        return this.postPrivate('api/v1/copy-trade/futures/orders', params);
+    }
+    /**
+     * 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) {
+        return this.postPrivate('api/v1/copy-trade/futures/orders/test', params);
+    }
+    /**
+     * 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) {
+        return this.postPrivate('api/v1/copy-trade/futures/st-orders', params);
+    }
+    /**
+     * Cancel Order By OrderId
+     * Cancel an order (including a stop order) in copy trading.
+     */
+    cancelCopyTradeOrderById(params) {
+        return this.deletePrivate('api/v1/copy-trade/futures/orders', params);
+    }
+    /**
+     * Cancel Order By Client Order Id
+     * Cancel an order (including a stop order) in copy trading by client order id.
+     */
+    cancelCopyTradeOrderByClientOid(params) {
+        return this.deletePrivate(`api/v1/copy-trade/futures/orders/client-order`, params);
+    }
+    /**
+     * Get Max Open Size
+     * Get Maximum Open Position Size.
+     */
+    getCopyTradeMaxOpenSize(params) {
+        return this.getPrivate('api/v1/copy-trade/futures/get-max-open-size', params);
+    }
+    /**
+     * Get Max Withdraw Margin
+     * This endpoint can query the maximum amount of margin that the current position supports withdrawal.
+     */
+    getCopyTradeMaxWithdrawMargin(params) {
+        return this.getPrivate('api/v1/copy-trade/futures/position/margin/max-withdraw-margin', params);
+    }
+    /**
+     * Add Isolated Margin
+     * Add Isolated Margin Manually.
+     */
+    addCopyTradeIsolatedMargin(params) {
+        return this.postPrivate('api/v1/copy-trade/futures/position/margin/deposit-margin', params);
+    }
+    /**
+     * Remove Isolated Margin
+     * Remove Isolated Margin Manually.
+     */
+    removeCopyTradeIsolatedMargin(params) {
+        return this.postPrivate('api/v1/copy-trade/futures/position/margin/withdraw-margin', params);
+    }
+    /**
+     * 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) {
+        return this.postPrivate('api/v1/copy-trade/futures/position/risk-limit-level/change', params);
+    }
+    /**
+     * 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) {
+        return this.postPrivate('api/v1/copy-trade/futures/position/margin/auto-deposit-status', params);
+    }
+    /**
+     *
+     * REST - Futures - Broker
+     *
+     */
     /**
      * Get download link for broker rebate orders
      *
@@ -305,6 +544,35 @@ class FuturesClient extends BaseRestClient_js_1.BaseRestClient {
     getPrivateWSConnectionToken() {
         return this.postPrivate('api/v1/bullet-private');
     }
+    /*
+     *
+     * DEPRECATED
+     *
+     */
+    /**
+     * @deprecated - please use universal transfer from SpotClient
+     */
+    submitTransferOut(params) {
+        return this.postPrivate('api/v3/transfer-out', params);
+    }
+    /**
+     * @deprecated - please use universal transfer from SpotClient
+     */
+    submitTransferIn(params) {
+        return this.postPrivate('api/v1/transfer-in', params);
+    }
+    /**
+     * @deprecated - please use universal transfer from SpotClient
+     */
+    getTransfers(params) {
+        return this.getPrivate('api/v1/transfer-list', params);
+    }
+    /**
+     * @deprecated - please use updateMarginMode() instead
+     */
+    updateAutoDepositStatus(params) {
+        return this.postPrivate('api/v1/position/margin/auto-deposit-status', params);
+    }
 }
 exports.FuturesClient = FuturesClient;
 //# sourceMappingURL=FuturesClient.js.map