okx-api 1.3.6 → 1.4.0

package/lib/rest-client.js

@@ -36,11 +36,6 @@ class RestClient extends BaseRestClient_1.default {
             return timestamp;
         });
     }
-    /**
-     *
-     * Trade endpoints (private)
-     *
-     */
     submitOrder(params) {
         return this.postPrivate('/api/v5/trade/order', params);
     }
@@ -92,6 +87,21 @@ class RestClient extends BaseRestClient_1.default {
     getFillsHistory(params) {
         return this.getPrivate('/api/v5/trade/fills-history', params);
     }
+    applyTransactionDetailsArchive(params) {
+        return this.postPrivate('/api/v5/trade/fills-archive', params);
+    }
+    getTransactionDetailsArchiveLink(params) {
+        return this.getPrivate('/api/v5/trade/fills-archive', params);
+    }
+    cancelMassOrder(params) {
+        return this.postPrivate('/api/v5/trade/mass-cancel', params);
+    }
+    cancelAllAfter(params) {
+        return this.postPrivate('/api/v5/trade/cancel-all-after', params);
+    }
+    getAccountRateLimit() {
+        return this.getPrivate('/api/v5/trade/account-rate-limit');
+    }
     placeAlgoOrder(params) {
         return this.postPrivate('/api/v5/trade/order-algo', params);
     }
@@ -181,6 +191,21 @@ class RestClient extends BaseRestClient_1.default {
     executeBlockQuote(params) {
         return this.postPrivate('/api/v5/rfq/execute-quote', params);
     }
+    getQuoteProducts() {
+        return this.getPrivate('/api/v5/rfq/maker-instrument-settings');
+    }
+    updateBlockQuoteProducts(params) {
+        return this.postPrivate('/api/v5/rfq/maker-instrument-settings', params);
+    }
+    resetBlockMmp() {
+        return this.postPrivate('/api/v5/rfq/mmp-reset');
+    }
+    updateBlockMmpConfig(params) {
+        return this.postPrivate('/api/v5/rfq/mmp-config', params);
+    }
+    getBlockMmpConfig() {
+        return this.getPrivate('/api/v5/rfq/mmp-config');
+    }
     createBlockQuote(params) {
         return this.postPrivate('/api/v5/rfq/create-quote', params);
     }
@@ -193,6 +218,9 @@ class RestClient extends BaseRestClient_1.default {
     cancelAllBlockQuotes() {
         return this.postPrivate('/api/v5/rfq/cancel-all-quotes');
     }
+    cancelAllBlockAfter(params) {
+        return this.postPrivate('/api/v5/rfq/cancel-all-after', params);
+    }
     getBlockRFQs(params) {
         return this.getPrivate('/api/v5/rfq/rfqs', params);
     }
@@ -205,6 +233,9 @@ class RestClient extends BaseRestClient_1.default {
     getPublicRFQBlockTrades(params) {
         return this.get('/api/v5/rfq/public-trades', params);
     }
+    getBlockPublicTrades(params) {
+        return this.get('/api/v5/public/block-trades', params);
+    }
     /**
      *
      * Funding endpoints (private)
@@ -216,6 +247,9 @@ class RestClient extends BaseRestClient_1.default {
     getBalances(ccy) {
         return this.getPrivate('/api/v5/asset/balances', { ccy });
     }
+    getNonTradableAssets(params) {
+        return this.getPrivate('/api/v5/asset/non-tradable-assets', params);
+    }
     getAccountAssetValuation(ccy) {
         return this.getPrivate('/api/v5/asset/asset-valuation', { ccy });
     }
@@ -254,8 +288,20 @@ class RestClient extends BaseRestClient_1.default {
     getWithdrawalHistory(params) {
         return this.getPrivate('/api/v5/asset/withdrawal-history', params);
     }
+    getDepositWithdrawStatus(params) {
+        return this.getPrivate('/api/v5/asset/deposit-withdraw-status', params);
+    }
     smallAssetsConvert(ccy) {
-        return this.getPrivate('/api/v5/asset/convert-dust-assets', { ccy });
+        return this.postPrivate('/api/v5/asset/convert-dust-assets', { ccy });
+    }
+    getExchanges() {
+        return this.get('/api/v5/asset/exchange-list');
+    }
+    applyForMonthlyStatement(params) {
+        return this.postPrivate('/api/v5/asset/monthly-statement', params);
+    }
+    getMonthlyStatement(params) {
+        return this.getPrivate('/api/v5/asset/monthly-statement', params);
     }
     getSavingBalance(ccy) {
         return this.getPrivate('/api/v5/finance/savings/balance', { ccy });
@@ -311,6 +357,9 @@ class RestClient extends BaseRestClient_1.default {
      * Account endpoints (private)
      *
      */
+    getAccountInstruments(params) {
+        return this.getPrivate('/api/v5/account/instruments', params);
+    }
     getBalance(ccy) {
         return this.getPrivate('/api/v5/account/balance', { ccy });
     }
@@ -402,6 +451,12 @@ class RestClient extends BaseRestClient_1.default {
     getAccountRiskState() {
         return this.getPrivate('/api/v5/account/risk-state');
     }
+    submitQuickMarginBorrowRepay(params) {
+        return this.postPrivate('/api/v5/account/quick-margin-borrow-repay', params);
+    }
+    getQuickMarginBorrowRepayHistory(params) {
+        return this.getPrivate('/api/v5/account/quick-margin-borrow-repay-history', params);
+    }
     borrowRepayVIPLoan(ccy, side, amt, ordId) {
         return this.postPrivate('/api/v5/account/borrow-repay', {
             ccy,
@@ -413,11 +468,47 @@ class RestClient extends BaseRestClient_1.default {
     getVIPLoanBorrowRepayHistory(params) {
         return this.getPrivate('/api/v5/account/borrow-repay-history', params);
     }
+    getVIPInterestAccrued(params) {
+        return this.getPrivate('/api/v5/account/vip-interest-accrued', params);
+    }
+    getVIPInterestDeducted(params) {
+        return this.getPrivate('/api/v5/account/vip-interest-deducted', params);
+    }
+    getVIPLoanOrders(params) {
+        return this.getPrivate('/api/v5/account/vip-loan-order-list', params);
+    }
+    getVIPLoanOrder(params) {
+        return this.getPrivate('/api/v5/account/vip-loan-order-detail', params);
+    }
     getBorrowInterestLimits(params) {
         return this.getPrivate('/api/v5/account/interest-limits', params);
     }
+    getFixedLoanBorrowLimit() {
+        return this.getPrivate('/api/v5/account/fixed-loan/borrowing-limit');
+    }
+    getFixedLoanBorrowQuote(params) {
+        return this.getPrivate('/api/v5/account/fixed-loan/borrowing-quote', params);
+    }
+    submitFixedLoanBorrowOrder(params) {
+        return this.postPrivate('/api/v5/account/fixed-loan/borrowing-order', params);
+    }
+    updateFixedLoanBorrowOrder(params) {
+        return this.postPrivate('/api/v5/account/fixed-loan/amend-borrowing-order', params);
+    }
+    manualRenewFixedLoanBorrowOrder(params) {
+        return this.postPrivate('/api/v5/account/fixed-loan/manual-reborrow', params);
+    }
+    repayFixedLoanBorrowOrder(params) {
+        return this.postPrivate('/api/v5/account/fixed-loan/repay-borrowing-order', params);
+    }
+    getFixedLoanBorrowOrders(params) {
+        return this.getPrivate('/api/v5/account/fixed-loan/borrowing-orders-list', params);
+    }
     positionBuilder(params) {
-        return this.postPrivate('/api/v5/account/simulated_margin', params);
+        return this.postPrivate('/api/v5/account/position-builder', params);
+    }
+    updateRiskOffsetAmount(params) {
+        return this.postPrivate('/api/v5/account/set-riskOffset-amt', params);
     }
     getGreeks(ccy) {
         return this.getPrivate('/api/v5/account/greeks', { ccy });
@@ -425,6 +516,21 @@ class RestClient extends BaseRestClient_1.default {
     getPMLimitation(params) {
         return this.getPrivate('/api/v5/account/position-tiers', params);
     }
+    updateRiskOffsetType(params) {
+        return this.postPrivate('/api/v5/account/set-riskOffset-type', params);
+    }
+    activateOption() {
+        return this.postPrivate('/api/v5/account/activate-option');
+    }
+    resetMMPStatus(params) {
+        return this.postPrivate('/api/v5/account/mmp-reset', params);
+    }
+    setMMPConfig(params) {
+        return this.postPrivate('/api/v5/account/mmp-config', params);
+    }
+    getMMPConfig(params) {
+        return this.getPrivate('/api/v5/account/mmp-config', params);
+    }
     /**
      *
      * SubAccount endpoints (private)
@@ -450,10 +556,16 @@ class RestClient extends BaseRestClient_1.default {
             ccy,
         });
     }
+    getSubAccountMaxWithdrawal(params) {
+        return this.getPrivate('/api/v5/account/subaccount/max-withdrawal', params);
+    }
     /** History of sub-account transfer */
     getSubAccountTransferHistory(params) {
         return this.getPrivate('/api/v5/asset/subaccount/bills', params);
     }
+    getManagedSubAccountTransferHistory(params) {
+        return this.getPrivate('/api/v5/asset/subaccount/managed-subaccount-bills', params);
+    }
     /** Master accounts manage the transfers between sub-accounts */
     transferSubAccountBalance(params) {
         return this.postPrivate('/api/v5/asset/subaccount/transfer', params);
@@ -471,6 +583,12 @@ class RestClient extends BaseRestClient_1.default {
             subAcct,
         });
     }
+    setSubAccountLoanAllocation(params) {
+        return this.postPrivate('/api/v5/account/subaccount/set-loan-allocation', params);
+    }
+    getSubAccountBorrowInterestAndLimit(params) {
+        return this.getPrivate('/api/v5/account/subaccount/interest-limits', params);
+    }
     /**
      *
      * Grid trading endpoints (private)
@@ -486,6 +604,15 @@ class RestClient extends BaseRestClient_1.default {
     stopGridAlgoOrder(orders) {
         return this.postPrivate('/api/v5/tradingBot/grid/stop-order-algo', orders);
     }
+    closeGridContractPosition(params) {
+        return this.postPrivate('/api/v5/tradingBot/grid/close-position', params);
+    }
+    cancelGridContractCloseOrder(params) {
+        return this.postPrivate('/api/v5/tradingBot/grid/cancel-close-order', params);
+    }
+    instantTriggerGridAlgoOrder(params) {
+        return this.postPrivate('/api/v5/tradingBot/grid/order-instant-trigger', params);
+    }
     getGridAlgoOrderList(params) {
         return this.getPrivate('/api/v5/tradingBot/grid/orders-algo-pending', params);
     }
@@ -527,6 +654,9 @@ class RestClient extends BaseRestClient_1.default {
         return this.postPrivate('/api/v5/tradingBot/grid/margin-balance', Object.assign({ algoId,
             type }, change));
     }
+    adjustGridInvestment(params) {
+        return this.postPrivate('/api/v5/tradingBot/grid/adjust-investment', params);
+    }
     getGridAIParameter(algoOrdType, instId, direction, duration) {
         return this.get('/api/v5/tradingBot/grid/ai-param', {
             algoOrdType,
@@ -535,45 +665,11 @@ class RestClient extends BaseRestClient_1.default {
             duration,
         });
     }
-    /**
-     *
-     * Earn/staking endpoints (private)
-     *
-     */
-    /** Get earn offers */
-    getStakingOffers(params) {
-        return this.getPrivate('/api/v5/finance/staking-defi/offers', params);
-    }
-    /** Earn/staking purchase */
-    submitStake(productId, investData, term) {
-        return this.postPrivate('/api/v5/finance/staking-defi/purchase', {
-            productId,
-            investData,
-            term,
-        });
+    computeGridMinInvestment(params) {
+        return this.post('/api/v5/tradingBot/grid/min-investment', params);
     }
-    /** Earn/staking redeem */
-    redeemStake(ordId, protocolType, allowEarlyRedeem) {
-        return this.postPrivate('/api/v5/finance/staking-defi/redeem', {
-            ordId,
-            protocolType,
-            allowEarlyRedeem,
-        });
-    }
-    /** Earn/staking cancel purchases/redemptions */
-    cancelStakingRequest(ordId, protocolType) {
-        return this.postPrivate('/api/v5/finance/staking-defi/cancel', {
-            ordId,
-            protocolType,
-        });
-    }
-    /** Earn/staking get active orders */
-    getActiveStakingOrders(params) {
-        return this.getPrivate('/api/v5/finance/staking-defi/orders-active', params);
-    }
-    /** Earn/staking get order history */
-    getStakingOrderHistory(params) {
-        return this.getPrivate('/api/v5/finance/staking-defi/orders-history', params);
+    getRSIBackTesting(params) {
+        return this.get('/api/v5/tradingBot/public/rsi-back-testing', params);
     }
     /**
      *
@@ -597,36 +693,111 @@ class RestClient extends BaseRestClient_1.default {
     getOrderBook(instId, sz) {
         return this.get('/api/v5/market/books', { instId, sz });
     }
+    getFullOrderBook(params) {
+        return this.get('/api/v5/market/books-full', params);
+    }
+    /**
+     * @deprecated this method's parameters will change to an object in the next release. Use getCandlesV2 instead.
+     *
+     * @param instId
+     * @param bar
+     * @param pagination
+     * @returns
+     */
     getCandles(instId, bar = '1m', pagination) {
         return this.get('/api/v5/market/candles', Object.assign({ instId,
             bar }, pagination));
     }
+    getCandlesV2(params) {
+        return this.get('/api/v5/market/candles', params);
+    }
+    /**
+     * @deprecated this method's parameters will change to an object in the next release. Use getHistoricCandlesV2 instead.
+     *
+     * @param instId
+     * @param bar
+     * @param pagination
+     * @returns
+     */
     getHistoricCandles(instId, bar = '1m', pagination) {
         return this.get('/api/v5/market/history-candles', Object.assign({ instId,
             bar }, pagination));
     }
+    getHistoricCandlesV2(params) {
+        return this.get('/api/v5/market/history-candles', params);
+    }
+    /**
+     * @deprecated this method's parameters will change to an object in the next release. Use getIndexCandlesV2 instead.
+     *
+     * @param instId
+     * @param bar
+     * @param pagination
+     * @returns
+     */
     getIndexCandles(instId, bar = '1m', pagination) {
         return this.get('/api/v5/market/index-candles', Object.assign({ instId,
             bar }, pagination));
     }
+    getIndexCandlesV2(params) {
+        return this.get('/api/v5/market/index-candles', params);
+    }
+    /**
+     * @deprecated this method's parameters will change to an object in the next release. Use getHistoricIndexCandlesV2 instead.
+     *
+     * @param instId
+     * @param bar
+     * @param pagination
+     * @returns
+     */
     getHistoricIndexCandles(instId, bar = '1m', pagination) {
         return this.get('/api/v5/market/history-index-candles', Object.assign({ instId,
             bar }, pagination));
     }
+    getHistoricIndexCandlesV2(params) {
+        return this.get('/api/v5/market/history-index-candles', params);
+    }
+    /**
+     * @deprecated this method's parameters will change to an object in the next release. Use getMarkPriceCandlesV2 instead.
+     *
+     * @param instId
+     * @param bar
+     * @param pagination
+     * @returns
+     */
     getMarkPriceCandles(instId, bar = '1m', pagination) {
         return this.get('/api/v5/market/mark-price-candles', Object.assign({ instId,
             bar }, pagination));
     }
+    getMarkPriceCandlesV2(params) {
+        return this.get('/api/v5/market/mark-price-candles', params);
+    }
+    /**
+     * @deprecated this method's parameters will change to an object in the next release. Use getHistoricMarkPriceCandlesV2 instead.
+     *
+     * @param instId
+     * @param bar
+     * @param pagination
+     * @returns
+     */
     getHistoricMarkPriceCandles(instId, bar = '1m', pagination) {
         return this.get('/api/v5/market/historic-mark-price-candles', Object.assign({ instId,
             bar }, pagination));
     }
+    getHistoricMarkPriceCandlesV2(params) {
+        return this.get('/api/v5/market/history-mark-price-candles', params);
+    }
     getTrades(instId, limit) {
         return this.get('/api/v5/market/trades', { instId, limit });
     }
     getHistoricTrades(instId, pagination) {
         return this.get('/api/v5/market/history-trades', Object.assign({ instId }, pagination));
     }
+    getOptionTradesByInstrument(params) {
+        return this.get('/api/v5/market/option/instrument-family-trades', params);
+    }
+    getOptionTrades(params) {
+        return this.get('/api/v5/public/option-trades', params);
+    }
     get24hrTotalVolume() {
         return this.get('/api/v5/market/platform-24-volume');
     }
@@ -645,6 +816,9 @@ class RestClient extends BaseRestClient_1.default {
     getBlockTicker(instId) {
         return this.get('/api/v5/market/block-ticker', { instId });
     }
+    /**
+     * @deprecated
+     */
     getPublicBlockTrades(instId) {
         return this.get('/api/v5/market/block-trades', { instId });
     }
@@ -712,6 +886,12 @@ class RestClient extends BaseRestClient_1.default {
     getUnitConvert(params) {
         return this.get('/api/v5/public/convert-contract-coin', params);
     }
+    getOptionTickBands(params) {
+        return this.get('/api/v5/public/instrument-tick-bands', params);
+    }
+    getPremiumHistory(params) {
+        return this.get('/api/v5/public/premium-history', params);
+    }
     getEconomicCalendar(params) {
         return this.getPrivate('/api/v5/public/economic-calendar', params);
     }
@@ -723,12 +903,27 @@ class RestClient extends BaseRestClient_1.default {
     getSupportCoin() {
         return this.get('/api/v5/rubik/stat/trading-data/support-coin');
     }
-    getTakerVolume() {
-        return this.get('/api/v5/rubik/stat/taker-volume');
+    getOpenInterestHistory(params) {
+        return this.get('/api/v5/rubik/stat/contracts/open-interest-history', params);
+    }
+    getTakerVolume(params) {
+        return this.get('/api/v5/rubik/stat/taker-volume', params);
+    }
+    getContractTakerVolume(params) {
+        return this.get('/api/v5/rubik/stat/taker-volume-contract', params);
     }
     getMarginLendingRatio(params) {
         return this.get('/api/v5/rubik/stat/margin/loan-ratio', params);
     }
+    getTopTradersAccountRatio(params) {
+        return this.get('/api/v5/rubik/stat/contracts/long-short-account-ratio-contract-top-trader', params);
+    }
+    getTopTradersContractPositionRatio(params) {
+        return this.get('/api/v5/rubik/stat/contracts/long-short-position-ratio-contract-top-trader', params);
+    }
+    getLongShortContractRatio(params) {
+        return this.get('/api/v5/rubik/stat/contracts/long-short-account-ratio-contract', params);
+    }
     getLongShortRatio(params) {
         return this.get('/api/v5/rubik/stat/contracts/long-short-account-ratio', params);
     }
@@ -750,6 +945,360 @@ class RestClient extends BaseRestClient_1.default {
     getTakerFlow(params) {
         return this.get('/api/v5/rubik/stat/option/taker-block-volume', params);
     }
+    /**
+     *
+     * FINANCIAL PRODUCT - On-chain earn endpoints
+     *
+     */
+    /** Get earn offers */
+    getStakingOffers(params) {
+        return this.getPrivate('/api/v5/finance/staking-defi/offers', params);
+    }
+    /** Earn/staking purchase */
+    submitStake(productId, investData, term) {
+        return this.postPrivate('/api/v5/finance/staking-defi/purchase', {
+            productId,
+            investData,
+            term,
+        });
+    }
+    /** Earn/staking redeem */
+    redeemStake(ordId, protocolType, allowEarlyRedeem) {
+        return this.postPrivate('/api/v5/finance/staking-defi/redeem', {
+            ordId,
+            protocolType,
+            allowEarlyRedeem,
+        });
+    }
+    /** Earn/staking cancel purchases/redemptions */
+    cancelStakingRequest(ordId, protocolType) {
+        return this.postPrivate('/api/v5/finance/staking-defi/cancel', {
+            ordId,
+            protocolType,
+        });
+    }
+    /** Earn/staking get active orders */
+    getActiveStakingOrders(params) {
+        return this.getPrivate('/api/v5/finance/staking-defi/orders-active', params);
+    }
+    /** Earn/staking get order history */
+    getStakingOrderHistory(params) {
+        return this.getPrivate('/api/v5/finance/staking-defi/orders-history', params);
+    }
+    /**
+     *
+     * FINANCIAL PRODUCT - ETH staking endpoints
+     *
+     */
+    purchaseETHStaking(params) {
+        return this.postPrivate('/api/v5/finance/staking-defi/eth/purchase', params);
+    }
+    redeemETHStaking(params) {
+        return this.postPrivate('/api/v5/finance/staking-defi/eth/redeem', params);
+    }
+    getETHStakingBalance() {
+        return this.getPrivate('/api/v5/finance/staking-defi/eth/balance');
+    }
+    getETHStakingHistory(params) {
+        return this.getPrivate('/api/v5/finance/staking-defi/eth/purchase-redeem-history', params);
+    }
+    getAPYHistory(params) {
+        return this.get('/api/v5/finance/staking-defi/eth/apy-history', params);
+    }
+    /**
+     *
+     * Simple earn fixed endpoints
+     *
+     */
+    getLendingOffers(params) {
+        return this.get('/api/v5/finance/fixed-loan/lending-offers', params);
+    }
+    getLendingAPYHistory(params) {
+        return this.get('/api/v5/finance/fixed-loan/lending-apy-history', params);
+    }
+    getLendingVolume(params) {
+        return this.get('/api/v5/finance/fixed-loan/pending-lending-volume', params);
+    }
+    placeLendingOrder(params) {
+        return this.postPrivate('/api/v5/finance/fixed-loan/lending-order', params);
+    }
+    amendLendingOrder(params) {
+        return this.postPrivate('/api/v5/finance/fixed-loan/lending-order', params);
+    }
+    getLendingOrders(params) {
+        return this.getPrivate('/api/v5/finance/fixed-loan/lending-orders-list', params);
+    }
+    getLendingSubOrders(params) {
+        return this.getPrivate('/api/v5/finance/fixed-loan/lending-sub-orders', params);
+    }
+    /**
+     *
+     * Signal bot trading endpoints
+     *
+     */
+    createSignal(params) {
+        return this.postPrivate('/api/v5/tradingBot/signal/create-signal', params);
+    }
+    getSignals(params) {
+        return this.getPrivate('/api/v5/tradingBot/signal/signals', params);
+    }
+    createSignalBot(params) {
+        return this.postPrivate('/api/v5/tradingBot/signal/order-algo', params);
+    }
+    cancelSignalBots(params) {
+        return this.postPrivate('/api/v5/tradingBot/signal/stop-order-algo', params);
+    }
+    updateSignalMargin(params) {
+        return this.postPrivate('/api/v5/tradingBot/signal/margin-balance', params);
+    }
+    updateSignalTPSL(params) {
+        return this.postPrivate('/api/v5/tradingBot/signal/amendTPSL', params);
+    }
+    setSignalInstruments(params) {
+        return this.postPrivate('/api/v5/tradingBot/signal/set-instruments', params);
+    }
+    getSignalBotOrder(params) {
+        return this.getPrivate('/api/v5/tradingBot/signal/orders-algo-details', params);
+    }
+    getActiveSignalBot(params) {
+        return this.getPrivate('/api/v5/tradingBot/signal/orders-algo-details', params);
+    }
+    getSignalBotHistory(params) {
+        return this.getPrivate('/api/v5/tradingBot/signal/orders-algo-history', params);
+    }
+    getSignalBotPositions(params) {
+        return this.getPrivate('/api/v5/tradingBot/signal/positions', params);
+    }
+    getSignalBotPositionHistory(params) {
+        return this.getPrivate('/api/v5/tradingBot/signal/positions-history', params);
+    }
+    closeSignalBotPosition(params) {
+        return this.postPrivate('/api/v5/tradingBot/signal/close-position', params);
+    }
+    placeSignalBotSubOrder(params) {
+        return this.postPrivate('/api/v5/tradingBot/signal/sub-order', params);
+    }
+    cancelSubOrder(params) {
+        return this.postPrivate('/api/v5/tradingBot/signal/cancel-sub-order', params);
+    }
+    getSignalBotSubOrders(params) {
+        return this.getPrivate('/api/v5/tradingBot/signal/sub-orders', params);
+    }
+    getSignalBotEventHistory(params) {
+        return this.getPrivate('/api/v5/tradingBot/signal/event-history', params);
+    }
+    /**
+     *
+     *  Recurring buy endpoints
+     *
+     */
+    submitRecurringBuyOrder(params) {
+        return this.postPrivate('/api/v5/tradingBot/recurring/order-algo', params);
+    }
+    amendRecurringBuyOrder(params) {
+        return this.postPrivate('/api/v5/tradingBot/recurring/amend-order-algo', params);
+    }
+    stopRecurringBuyOrder(params) {
+        return this.postPrivate('/api/v5/tradingBot/recurring/stop-order-algo', params);
+    }
+    getRecurringBuyOrders(params) {
+        return this.getPrivate('/api/v5/tradingBot/recurring/orders-algo-pending', params);
+    }
+    getRecurringBuyOrderHistory(params) {
+        return this.getPrivate('/api/v5/tradingBot/recurring/orders-algo-history', params);
+    }
+    getRecurringBuyOrderDetails(params) {
+        return this.getPrivate('/api/v5/tradingBot/recurring/orders-algo-details', params);
+    }
+    getRecurringBuySubOrders(params) {
+        return this.getPrivate('/api/v5/tradingBot/recurring/sub-orders', params);
+    }
+    /**
+     *
+     * Copy Trading endpoints
+     *
+     */
+    getCopytradingSubpositions(params) {
+        return this.getPrivate('/api/v5/copytrading/current-subpositions', params);
+    }
+    getCopytradingSubpositionsHistory(params) {
+        return this.getPrivate('/api/v5/copytrading/subpositions-history', params);
+    }
+    submitCopytradingAlgoOrder(params) {
+        return this.postPrivate('/api/v5/copytrading/algo-order', params);
+    }
+    closeCopytradingSubposition(params) {
+        return this.postPrivate('/api/v5/copytrading/close-subposition', params);
+    }
+    getCopytradingInstruments(params) {
+        return this.getPrivate('/api/v5/copytrading/instruments', params);
+    }
+    setCopytradingInstruments(params) {
+        return this.postPrivate('/api/v5/copytrading/set-instruments', params);
+    }
+    getCopytradingProfitDetails(params) {
+        return this.getPrivate('/api/v5/copytrading/profit-sharing-details', params);
+    }
+    getCopytradingTotalProfit(params) {
+        return this.getPrivate('/api/v5/copytrading/total-profit-sharing', params);
+    }
+    getCopytradingUnrealizedProfit(params) {
+        return this.getPrivate('/api/v5/copytrading/unrealized-profit-sharing-details', params);
+    }
+    getCopytradingTotalUnrealizedProfit(params) {
+        return this.getPrivate('/api/v5/copytrading/total-unrealized-profit-sharing', params);
+    }
+    applyCopytradingLeadTrading(params) {
+        return this.postPrivate('/api/v5/copytrading/apply-lead-trading', params);
+    }
+    stopCopytradingLeadTrading(params) {
+        return this.postPrivate('/api/v5/copytrading/stop-lead-trading', params);
+    }
+    updateCopytradingProfitSharing(params) {
+        return this.postPrivate('/api/v5/copytrading/amend-profit-sharing-ratio', params);
+    }
+    getCopytradingAccount() {
+        return this.getPrivate('/api/v5/copytrading/config');
+    }
+    setCopytradingFirstCopy(params) {
+        return this.postPrivate('/api/v5/copytrading/first-copy-settings', params);
+    }
+    updateCopytradingCopySettings(params) {
+        return this.postPrivate('/api/v5/copytrading/amend-copy-settings', params);
+    }
+    stopCopytradingCopy(params) {
+        return this.postPrivate('/api/v5/copytrading/stop-copy-trading', params);
+    }
+    getCopytradingCopySettings(params) {
+        return this.getPrivate('/api/v5/copytrading/copy-settings', params);
+    }
+    getCopytradingBatchLeverageInfo(params) {
+        return this.getPrivate('/api/v5/copytrading/batch-leverage-info', params);
+    }
+    setCopytradingBatchLeverage(params) {
+        return this.postPrivate('/api/v5/copytrading/batch-set-leverage', params);
+    }
+    getCopytradingMyLeadTraders(params) {
+        return this.getPrivate('/api/v5/copytrading/current-lead-traders', params);
+    }
+    getCopytradingLeadTradersHistory(params) {
+        return this.getPrivate('/api/v5/copytrading/lead-traders-history', params);
+    }
+    getCopytradingConfig(params) {
+        return this.get('/api/v5/copytrading/public-config', params);
+    }
+    getCopytradingLeadRanks(params) {
+        return this.get('/api/v5/copytrading/public-lead-traders', params);
+    }
+    getCopytradingLeadWeeklyPnl(params) {
+        return this.get('/api/v5/copytrading/public-weekly-pnl', params);
+    }
+    getCopytradingLeadDailyPnl(params) {
+        return this.get('/api/v5/copytrading/public-pnl', params);
+    }
+    getCopytradingLeadStats(params) {
+        return this.get('/api/v5/copytrading/public-stats', params);
+    }
+    getCopytradingLeadPreferences(params) {
+        return this.get('/api/v5/copytrading/public-preference-currency', params);
+    }
+    getCopytradingLeadOpenPositions(params) {
+        return this.get('/api/v5/copytrading/public-current-subpositions', params);
+    }
+    getCopytradingLeadPositionHistory(params) {
+        return this.get('/api/v5/copytrading/public-subpositions-history', params);
+    }
+    getCopyTraders(params) {
+        return this.get('/api/v5/copytrading/public-copy-traders', params);
+    }
+    getCopytradingLeadPrivateRanks(params) {
+        return this.getPrivate('/api/v5/copytrading/lead-traders', params);
+    }
+    getCopytradingLeadPrivateWeeklyPnl(params) {
+        return this.getPrivate('/api/v5/copytrading/weekly-pnl', params);
+    }
+    getCopytradingPLeadPrivateDailyPnl(params) {
+        return this.getPrivate('/api/v5/copytrading/pnl', params);
+    }
+    geCopytradingLeadPrivateStats(params) {
+        return this.getPrivate('/api/v5/copytrading/stats', params);
+    }
+    getCopytradingLeadPrivatePreferences(params) {
+        return this.getPrivate('/api/v5/copytrading/preference-currency', params);
+    }
+    getCopytradingLeadPrivateOpenPositions(params) {
+        return this.getPrivate('/api/v5/copytrading/performance-current-subpositions', params);
+    }
+    getCopytradingLeadPrivatePositionHistory(params) {
+        return this.getPrivate('/api/v5/copytrading/performance-subpositions-history', params);
+    }
+    getCopyTradersPrivate(params) {
+        return this.getPrivate('/api/v5/copytrading/copy-traders', params);
+    }
+    /**
+     *
+     * Spread trading endpoints
+     *
+     */
+    submitSpreadOrder(params) {
+        return this.postPrivate('/api/v5/sprd/order', params);
+    }
+    cancelSpreadOrder(params) {
+        return this.postPrivate('/api/v5/sprd/cancel-order', params);
+    }
+    cancelAllSpreadOrders(params) {
+        return this.postPrivate('/api/v5/sprd/mass-cancel', params);
+    }
+    updateSpreadOrder(params) {
+        return this.postPrivate('/api/v5/sprd/amend-order', params);
+    }
+    getSpreadOrder(params) {
+        return this.getPrivate('/api/v5/sprd/order', params);
+    }
+    getSpreadActiveOrders(params) {
+        return this.getPrivate('/api/v5/sprd/orders-pending', params);
+    }
+    getSpreadOrdersRecent(params) {
+        return this.getPrivate('/api/v5/sprd/orders-history', params);
+    }
+    getSpreadOrdersArchive(params) {
+        return this.getPrivate('/api/v5/sprd/orders-history-archive', params);
+    }
+    getSpreadTrades(params) {
+        return this.getPrivate('/api/v5/sprd/trades', params);
+    }
+    getSpreads(params) {
+        return this.get('/api/v5/sprd/spreads', params);
+    }
+    getSpreadOrderBook(params) {
+        return this.get('/api/v5/sprd/books', params);
+    }
+    getSpreadTicker(params) {
+        return this.get('/api/v5/market/sprd-ticker', params);
+    }
+    getSpreadPublicTrades(params) {
+        return this.get('/api/v5/sprd/public-trades', params);
+    }
+    getSpreadCandles(params) {
+        return this.get('/api/v5/market/sprd-candles', params);
+    }
+    getSpreadHistoryCandles(params) {
+        return this.get('/api/v5/market/sprd-history-candles', params);
+    }
+    cancelSpreadAllAfter(params) {
+        return this.postPrivate('/api/v5/sprd/cancel-all-after', params);
+    }
+    /**
+     *
+     * Affiliate endpoints
+     *
+     */
+    getInviteeDetail(params) {
+        return this.getPrivate('/api/v5/affiliate/invitee/detail', params);
+    }
+    getAffiliateRebateInfo(params) {
+        return this.getPrivate('/api/v5/users/partner/if-rebate', params);
+    }
     /**
      *
      * Status endpoints (public)
@@ -763,7 +1312,10 @@ class RestClient extends BaseRestClient_1.default {
      * Broker endpoints (private)
      *
      */
-    // TODO: add missing broker endpoints
+    /**
+     *
+     * @deprecated
+     */
     getBrokerAccountInformation() {
         return this.getPrivate('/api/v5/broker/nd/info');
     }