okx-api 1.5.0 → 1.5.2

package/lib/rest-client.js

@@ -99,6 +99,10 @@ class RestClient extends BaseRestClient_1.default {
     getAccountInstruments(params) {
         return this.getPrivate('/api/v5/account/instruments', params);
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getBalance(ccy) {
         return this.getPrivate('/api/v5/account/balance', { ccy });
     }
@@ -108,6 +112,10 @@ class RestClient extends BaseRestClient_1.default {
     getPositionsHistory(params) {
         return this.getPrivate('/api/v5/account/positions-history', params);
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getAccountPositionRisk(instType) {
         return this.getPrivate('/api/v5/account/account-position-risk', {
             instType,
@@ -142,6 +150,10 @@ class RestClient extends BaseRestClient_1.default {
     getAccountConfiguration() {
         return this.getPrivate('/api/v5/account/config');
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     setPositionMode(posMode) {
         return this.postPrivate('/api/v5/account/set-position-mode', { posMode });
     }
@@ -159,7 +171,8 @@ class RestClient extends BaseRestClient_1.default {
         return this.postPrivate('/api/v5/account/position/margin-balance', params);
     }
     /**
-     * @deprecated - Use getLeverageV2() instead, which uses an object for all parameters.
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
      */
     getLeverage(instId, mgnMode) {
         return this.getPrivate('/api/v5/account/leverage-info', {
@@ -174,8 +187,8 @@ class RestClient extends BaseRestClient_1.default {
         return this.getPrivate('/api/v5/account/adjust-leverage-info', params);
     }
     /**
-     * @deprecated - Use getMaxLoanV2() instead, which uses an object for all parameters.
-     * In future, getMaxLoan() will also use an object for params (breaking change if you continue using getMaxLoan() as is)
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
      */
     getMaxLoan(instId, mgnMode, mgnCcy, ccy) {
         return this.getPrivate('/api/v5/account/max-loan', {
@@ -189,8 +202,8 @@ class RestClient extends BaseRestClient_1.default {
         return this.getPrivate('/api/v5/account/max-loan', params);
     }
     /**
-     * @deprecated - Use getFeeRatesV2() instead, which uses an object for all parameters.
-     * In future, getFeeRates() will also use an object for params (breaking change if you continue using getFeeRates() as is)
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
      */
     getFeeRates(instType, instId, uly, instFamily, ruleType) {
         return this.getPrivate('/api/v5/account/trade-fee', {
@@ -207,18 +220,34 @@ class RestClient extends BaseRestClient_1.default {
     getInterestAccrued(params) {
         return this.getPrivate('/api/v5/account/interest-accrued', params);
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getInterestRate(ccy) {
         return this.getPrivate('/api/v5/account/interest-rate', { ccy });
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     setGreeksDisplayType(greeksType) {
         return this.postPrivate('/api/v5/account/set-greeks', { greeksType });
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     setIsolatedMode(isoMode, type) {
         return this.postPrivate('/api/v5/account/set-isolated-mode', {
             isoMode,
             type,
         });
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getMaxWithdrawals(ccy) {
         return this.getPrivate('/api/v5/account/max-withdrawal', { ccy });
     }
@@ -231,6 +260,10 @@ class RestClient extends BaseRestClient_1.default {
     getQuickMarginBorrowRepayHistory(params) {
         return this.getPrivate('/api/v5/account/quick-margin-borrow-repay-history', params);
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     borrowRepayVIPLoan(ccy, side, amt, ordId) {
         return this.postPrivate('/api/v5/account/borrow-repay', {
             ccy,
@@ -299,6 +332,10 @@ class RestClient extends BaseRestClient_1.default {
     updateRiskOffsetAmount(params) {
         return this.postPrivate('/api/v5/account/set-riskOffset-amt', params);
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getGreeks(ccy) {
         return this.getPrivate('/api/v5/account/greeks', { ccy });
     }
@@ -393,11 +430,16 @@ class RestClient extends BaseRestClient_1.default {
         return this.getPrivate('/api/v5/trade/easy-convert-currency-list', params);
     }
     /**
+     *
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     *
      * Place easy convert : Convert small currencies to mainstream currencies.
      * Only applicable to the crypto balance less than $10.
      *
      * Maximum 5 currencies can be selected in one order.
      * If there are multiple currencies, separate them with commas in the "from" field.
+     *
      */
     submitEasyConvert(fromCcys, toCcy, source) {
         return this.postPrivate('/api/v5/trade/easy-convert', {
@@ -411,6 +453,10 @@ class RestClient extends BaseRestClient_1.default {
         return this.getPrivate('/api/v5/trade/easy-convert-history', params);
     }
     /**
+     *
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     *
      * Get one-click repay currency list : Get list of debt currency data and repay currencies.
      * Debt currencies include both cross and isolated debts.
      */
@@ -420,6 +466,9 @@ class RestClient extends BaseRestClient_1.default {
         });
     }
     /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     *
      * Trade one-click repay to repay cross debts.
      * Isolated debts are not applicable.
      * The maximum repayment amount is based on the remaining available balance of funding and trading accounts.
@@ -480,6 +529,10 @@ class RestClient extends BaseRestClient_1.default {
     placeGridAlgoOrder(params) {
         return this.postPrivate('/api/v5/tradingBot/grid/order-algo', params);
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     amendGridAlgoOrder(algoId, instId, triggerPx) {
         return this.postPrivate('/api/v5/tradingBot/grid/amend-order-algo', Object.assign({ algoId,
             instId }, triggerPx));
@@ -502,30 +555,49 @@ class RestClient extends BaseRestClient_1.default {
     getGridAlgoOrderHistory(params) {
         return this.getPrivate('/api/v5/tradingBot/grid/orders-algo-history', params);
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getGridAlgoOrderDetails(algoOrdType, algoId) {
         return this.getPrivate('/api/v5/tradingBot/grid/orders-algo-details', {
             algoOrdType,
             algoId,
         });
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getGridAlgoSubOrders(algoOrdType, algoId, type, groupId, pagination) {
         return this.getPrivate('/api/v5/tradingBot/grid/sub-orders', Object.assign({ algoOrdType,
             algoId,
             type,
             groupId }, pagination));
     }
-    /** Only contract grid supports this method */
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getGridAlgoOrderPositions(algoOrdType, algoId) {
         return this.getPrivate('/api/v5/tradingBot/grid/positions', {
             algoOrdType,
             algoId,
         });
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     spotGridWithdrawIncome(algoId) {
         return this.postPrivate('/api/v5/tradingBot/grid/withdraw-income', {
             algoId,
         });
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     computeGridMarginBalance(algoId, type, amt) {
         return this.postPrivate('/api/v5/tradingBot/grid/compute-margin-balance', {
             algoId,
@@ -533,6 +605,10 @@ class RestClient extends BaseRestClient_1.default {
             amt,
         });
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     adjustGridMarginBalance(algoId, type, change) {
         return this.postPrivate('/api/v5/tradingBot/grid/margin-balance', Object.assign({ algoId,
             type }, change));
@@ -540,6 +616,10 @@ class RestClient extends BaseRestClient_1.default {
     adjustGridInvestment(params) {
         return this.postPrivate('/api/v5/tradingBot/grid/adjust-investment', params);
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getGridAIParameter(algoOrdType, instId, direction, duration) {
         return this.get('/api/v5/tradingBot/grid/ai-param', {
             algoOrdType,
@@ -766,17 +846,29 @@ class RestClient extends BaseRestClient_1.default {
      * Orderbook trading - Market data endpoints
      *
      */
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getTickers(instrumentType, uly) {
         return this.get('/api/v5/market/tickers', {
             instType: instrumentType,
             uly,
         });
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getTicker(instId) {
         return this.get('/api/v5/market/ticker', {
             instId,
         });
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getOrderBook(instId, sz) {
         return this.get('/api/v5/market/books', { instId, sz });
     }
@@ -784,12 +876,8 @@ class RestClient extends BaseRestClient_1.default {
         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
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
      */
     getCandles(instId, bar = '1m', pagination) {
         return this.get('/api/v5/market/candles', Object.assign({ instId,
@@ -799,12 +887,8 @@ class RestClient extends BaseRestClient_1.default {
         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
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
      */
     getHistoricCandles(instId, bar = '1m', pagination) {
         return this.get('/api/v5/market/history-candles', Object.assign({ instId,
@@ -813,9 +897,17 @@ class RestClient extends BaseRestClient_1.default {
     getHistoricCandlesV2(params) {
         return this.get('/api/v5/market/history-candles', params);
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getTrades(instId, limit) {
         return this.get('/api/v5/market/trades', { instId, limit });
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getHistoricTrades(instId, pagination) {
         return this.get('/api/v5/market/history-trades', Object.assign({ instId }, pagination));
     }
@@ -893,9 +985,17 @@ class RestClient extends BaseRestClient_1.default {
     getPublicRFQBlockTrades(params) {
         return this.get('/api/v5/rfq/public-trades', params);
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getBlockTickers(instType, uly) {
         return this.get('/api/v5/market/block-tickers', { instType, uly });
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getBlockTicker(instId) {
         return this.get('/api/v5/market/block-ticker', { instId });
     }
@@ -960,6 +1060,10 @@ class RestClient extends BaseRestClient_1.default {
      * Public data - rest endpoints
      *
      */
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getInstruments(instType, uly, instFamily, instId) {
         return this.get('/api/v5/public/instruments', {
             instType,
@@ -1022,16 +1126,16 @@ class RestClient extends BaseRestClient_1.default {
     getPremiumHistory(params) {
         return this.get('/api/v5/public/premium-history', params);
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getIndexTickers(params) {
         return this.get('/api/v5/market/index-tickers', Object.assign({}, 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
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
      */
     getIndexCandles(instId, bar = '1m', pagination) {
         return this.get('/api/v5/market/index-candles', Object.assign({ instId,
@@ -1041,12 +1145,8 @@ class RestClient extends BaseRestClient_1.default {
         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
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
      */
     getHistoricIndexCandles(instId, bar = '1m', pagination) {
         return this.get('/api/v5/market/history-index-candles', Object.assign({ instId,
@@ -1056,12 +1156,8 @@ class RestClient extends BaseRestClient_1.default {
         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
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
      */
     getMarkPriceCandles(instId, bar = '1m', pagination) {
         return this.get('/api/v5/market/mark-price-candles', Object.assign({ instId,
@@ -1071,12 +1167,8 @@ class RestClient extends BaseRestClient_1.default {
         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
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
      */
     getHistoricMarkPriceCandles(instId, bar = '1m', pagination) {
         return this.get('/api/v5/market/historic-mark-price-candles', Object.assign({ instId,
@@ -1091,6 +1183,10 @@ class RestClient extends BaseRestClient_1.default {
     getExchangeRate() {
         return this.get('/api/v5/market/exchange-rate');
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getIndexComponents(index) {
         return this.get('/api/v5/market/index-components', { index });
     }
@@ -1098,7 +1194,8 @@ class RestClient extends BaseRestClient_1.default {
         return this.getPrivate('/api/v5/public/economic-calendar', params);
     }
     /**
-     * @deprecated
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
      */
     getPublicBlockTrades(instId) {
         return this.get('/api/v5/market/block-trades', { instId });
@@ -1164,15 +1261,27 @@ class RestClient extends BaseRestClient_1.default {
      * Funding account - REST endpoints
      *
      */
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getCurrencies(ccy) {
         return this.getPrivate('/api/v5/asset/currencies', { ccy });
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getBalances(ccy) {
         return this.getPrivate('/api/v5/asset/balances', { ccy });
     }
     getNonTradableAssets(params) {
         return this.getPrivate('/api/v5/asset/non-tradable-assets', params);
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getAccountAssetValuation(ccy) {
         return this.getPrivate('/api/v5/asset/asset-valuation', { ccy });
     }
@@ -1186,9 +1295,17 @@ class RestClient extends BaseRestClient_1.default {
     getAssetBillsDetails(params) {
         return this.getPrivate('/api/v5/asset/bills', params);
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getLightningDeposits(ccy, amt, to) {
         return this.getPrivate('/api/v5/asset/deposit-lightning', { ccy, amt, to });
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getDepositAddress(ccy) {
         return this.getPrivate('/api/v5/asset/deposit-address', { ccy });
     }
@@ -1198,6 +1315,10 @@ class RestClient extends BaseRestClient_1.default {
     submitWithdraw(params) {
         return this.postPrivate('/api/v5/asset/withdrawal', params);
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     submitWithdrawLightning(ccy, invoice, memo) {
         return this.postPrivate('/api/v5/asset/withdrawal-lightning', {
             ccy,
@@ -1205,6 +1326,10 @@ class RestClient extends BaseRestClient_1.default {
             memo,
         });
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     cancelWithdrawal(wdId) {
         return this.postPrivate('/api/v5/asset/cancel-withdrawal', { wdId });
     }
@@ -1214,7 +1339,8 @@ class RestClient extends BaseRestClient_1.default {
     getDepositWithdrawStatus(params) {
         return this.getPrivate('/api/v5/asset/deposit-withdraw-status', params);
     }
-    /** @deprecated
+    /**
+     * @deprecated
      * use submitEasyConvert() instead
      */
     smallAssetsConvert(ccy) {
@@ -1232,6 +1358,10 @@ class RestClient extends BaseRestClient_1.default {
     getConvertCurrencies() {
         return this.getPrivate('/api/v5/asset/convert/currencies');
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getConvertCurrencyPair(fromCcy, toCcy) {
         return this.getPrivate('/api/v5/asset/convert/currency-pair', {
             fromCcy,
@@ -1256,16 +1386,25 @@ class RestClient extends BaseRestClient_1.default {
     getSubAccountList(params) {
         return this.getPrivate('/api/v5/users/subaccount/list', params);
     }
-    /** Reset the APIKey of a sub-account */
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     resetSubAccountAPIKey(subAcct, apiKey, options) {
         return this.postPrivate('/api/v5/users/subaccount/modify-apikey', Object.assign({ subAcct,
             apiKey }, options));
     }
-    /** Get sub-account trading balance */
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getSubAccountBalances(subAcct) {
         return this.getPrivate('/api/v5/account/subaccount/balances', { subAcct });
     }
-    /** Get sub-account funding balance */
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getSubAccountFundingBalances(subAcct, ccy) {
         return this.getPrivate('/api/v5/asset/subaccount/balances', {
             subAcct,
@@ -1286,14 +1425,20 @@ class RestClient extends BaseRestClient_1.default {
     transferSubAccountBalance(params) {
         return this.postPrivate('/api/v5/asset/subaccount/transfer', params);
     }
-    /** Set Permission Of Transfer Out */
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     setSubAccountTransferOutPermission(subAcct, canTransOut = true) {
         return this.postPrivate('/api/v5/users/subaccount/set-transfer-out', {
             subAcct,
             canTransOut,
         });
     }
-    /** Get custody trading sub-account list */
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getSubAccountCustodyTradingList(subAcct) {
         return this.getPrivate('/api/v5/users/entrust-subaccount-list', {
             subAcct,
@@ -1314,7 +1459,10 @@ class RestClient extends BaseRestClient_1.default {
     getStakingOffers(params) {
         return this.getPrivate('/api/v5/finance/staking-defi/offers', params);
     }
-    /** Earn/staking purchase */
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     submitStake(productId, investData, term) {
         return this.postPrivate('/api/v5/finance/staking-defi/purchase', {
             productId,
@@ -1322,7 +1470,10 @@ class RestClient extends BaseRestClient_1.default {
             term,
         });
     }
-    /** Earn/staking redeem */
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     redeemStake(ordId, protocolType, allowEarlyRedeem) {
         return this.postPrivate('/api/v5/finance/staking-defi/redeem', {
             ordId,
@@ -1330,7 +1481,10 @@ class RestClient extends BaseRestClient_1.default {
             allowEarlyRedeem,
         });
     }
-    /** Earn/staking cancel purchases/redemptions */
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     cancelStakingRequest(ordId, protocolType) {
         return this.postPrivate('/api/v5/finance/staking-defi/cancel', {
             ordId,
@@ -1373,9 +1527,17 @@ class RestClient extends BaseRestClient_1.default {
      * Financial product - simple earn flexible endpoints
      *
      */
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getSavingBalance(ccy) {
         return this.getPrivate('/api/v5/finance/savings/balance', { ccy });
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     savingsPurchaseRedemption(ccy, amt, side, rate) {
         return this.postPrivate('/api/v5/finance/savings/purchase-redempt', {
             ccy,
@@ -1384,6 +1546,10 @@ class RestClient extends BaseRestClient_1.default {
             rate,
         });
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     setLendingRate(ccy, rate) {
         return this.postPrivate('/api/v5/finance/savings/set-lending-rate', {
             ccy,
@@ -1393,6 +1559,10 @@ class RestClient extends BaseRestClient_1.default {
     getLendingHistory(params) {
         return this.getPrivate('/api/v5/finance/savings/lending-history', params);
     }
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getPublicBorrowInfo(ccy) {
         return this.get('/api/v5/finance/savings/lending-rate-summary', { ccy });
     }
@@ -1467,6 +1637,10 @@ class RestClient extends BaseRestClient_1.default {
      * Status endpoints (public)
      *
      */
+    /**
+     * @deprecated Breaking change: this function will change soon to accept a single object for all REST API parameters.
+     * See issue https://github.com/tiagosiebler/okx-api/issues/88 for more details.
+     */
     getSystemStatus(state) {
         return this.get('/api/v5/system/status', { state });
     }