okx-api 1.5.0 → 1.5.2

package/lib/rest-client.d.ts

@@ -33,9 +33,17 @@ export declare class RestClient extends BaseRestClient {
      *
      */
     getAccountInstruments(params: GetInstrumentsRequest): Promise<AccountInstrument[]>;
+    /**
+     * @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?: string): Promise<AccountBalance[]>;
     getPositions(params?: GetPositionsParams): Promise<AccountPosition[]>;
     getPositionsHistory(params?: GetHistoricPositionParams): Promise<HistoricAccountPosition[]>;
+    /**
+     * @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?: Omit<'SPOT', InstrumentType>): Promise<AccountPositionRisk[]>;
     /** Up to last 7 days */
     getBills(params?: any): Promise<AccountBill[]>;
@@ -62,6 +70,10 @@ export declare class RestClient extends BaseRestClient {
         quarter: 'Q1' | 'Q2' | 'Q3' | 'Q4';
     }): Promise<AccountHistoryBill[]>;
     getAccountConfiguration(): Promise<AccountConfiguration[]>;
+    /**
+     * @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: PosMode): Promise<AccountPositionModeResult[]>;
     setLeverage(params: SetLeverageRequest): Promise<AccountLeverageResult[]>;
     /** Max buy/sell amount or open amount */
@@ -82,7 +94,8 @@ export declare class RestClient extends BaseRestClient {
     }): Promise<AccountMaxTradableAmount[]>;
     changePositionMargin(params: ChangePositionMarginRequest): Promise<AccountChangeMarginResult[]>;
     /**
-     * @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: string, mgnMode: MarginMode): Promise<AccountLeverage[]>;
     getLeverageV2(params: {
@@ -99,8 +112,8 @@ export declare class RestClient extends BaseRestClient {
         posSide: PositionSide;
     }): Promise<AdjustLeverageInfo[]>;
     /**
-     * @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: string, mgnMode: MarginMode, mgnCcy?: string | undefined, ccy?: string): Promise<AccountMaxLoan[]>;
     getMaxLoanV2(params: {
@@ -110,8 +123,8 @@ export declare class RestClient extends BaseRestClient {
         ccy?: string;
     }): Promise<AccountMaxLoan[]>;
     /**
-     * @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: InstrumentType, instId?: string, uly?: string, instFamily?: string, ruleType?: string): Promise<AccountFeeRate[]>;
     getFeeRatesV2(params: {
@@ -130,13 +143,33 @@ export declare class RestClient extends BaseRestClient {
         before?: string;
         limit?: string;
     }): Promise<InterestAccrued[]>;
+    /**
+     * @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?: string): Promise<InterestRate[]>;
+    /**
+     * @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: 'PA' | 'BS'): Promise<Greeks[]>;
+    /**
+     * @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: 'automatic' | 'autonomy', type: 'MARGIN' | 'CONTRACTS'): Promise<AccountIsolatedMode[]>;
+    /**
+     * @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?: string): Promise<MaxWithdrawal[]>;
     getAccountRiskState(): Promise<AccountRiskState[]>;
     submitQuickMarginBorrowRepay(params: QuickMarginBorrowRepayRequest): Promise<QuickMarginBorrowRepayResult[]>;
     getQuickMarginBorrowRepayHistory(params: GetQuickMarginBorrowRepayHistoryRequest): Promise<QuickMarginBorrowRepayRecord[]>;
+    /**
+     * @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: string, side: 'borrow' | 'repay', amt: numberInString, ordId?: string): Promise<any[]>;
     getVIPLoanBorrowRepayHistory(params?: any): Promise<any[]>;
     getVIPInterestAccrued(params: GetVIPInterestRequest): Promise<VIPInterest[]>;
@@ -202,6 +235,10 @@ export declare class RestClient extends BaseRestClient {
         ccy: string;
         clSpotInUseAmt: string;
     }[]>;
+    /**
+     * @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?: string): Promise<any[]>;
     getPMLimitation(params: {
         instType: 'SWAP' | 'FUTURES' | 'OPTION';
@@ -275,21 +312,33 @@ export declare class RestClient extends BaseRestClient {
         source?: string;
     }): Promise<any>;
     /**
+     *
+     * @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: string[], toCcy: string, source?: string): Promise<APIResponse<any>>;
     /** Get easy convert history : Get the history and status of easy convert trades. */
     getEasyConvertHistory(params?: Pagination): Promise<APIResponse<any>>;
     /**
+     *
+     * @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.
      */
     getOneClickRepayCurrencyList(debtType?: 'cross' | 'isolated'): Promise<APIResponse<any>>;
     /**
+     * @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.
@@ -328,6 +377,10 @@ export declare class RestClient extends BaseRestClient {
      *
      */
     placeGridAlgoOrder(params: GridAlgoOrderRequest): Promise<any[]>;
+    /**
+     * @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: string, instId: string, triggerPx: {
         slTriggerPx?: numberInString;
         tpTriggerPx?: numberInString;
@@ -346,16 +399,39 @@ export declare class RestClient extends BaseRestClient {
     }[]>;
     getGridAlgoOrderList(params: GetGridAlgoOrdersRequest): Promise<any[]>;
     getGridAlgoOrderHistory(params: GetGridAlgoOrdersRequest): Promise<any[]>;
+    /**
+     * @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: GridAlgoOrderType, algoId: string): Promise<any[]>;
+    /**
+     * @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: GridAlgoOrderType, algoId: string, type: GridAlgoSubOrderType, groupId?: string, pagination?: {
         after?: numberInString;
         before?: numberInString;
         limit?: number;
     }): Promise<any[]>;
-    /** 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: 'contract_grid', algoId: string): Promise<any[]>;
+    /**
+     * @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: string): Promise<any[]>;
+    /**
+     * @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: string, type: 'add' | 'reduce', amt?: numberInString): Promise<any[]>;
+    /**
+     * @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: string, type: 'add' | 'reduce', change: {
         amt?: numberInString;
         percent?: numberInString;
@@ -366,6 +442,10 @@ export declare class RestClient extends BaseRestClient {
     }): Promise<{
         algoId: string;
     }[]>;
+    /**
+     * @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: GridAlgoOrderType, instId: string, direction: ContractGridDirection, duration?: '7D' | '30D' | '180D'): Promise<any[]>;
     computeGridMinInvestment(params: {
         amt: string;
@@ -549,34 +629,46 @@ export declare class RestClient extends BaseRestClient {
      * 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: InstrumentType, uly?: string): Promise<Ticker[]>;
+    /**
+     * @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: string): Promise<Ticker[]>;
+    /**
+     * @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: string, sz?: numberInString): Promise<OrderBook[]>;
     getFullOrderBook(params: {
         instId: string;
         sz?: string;
     }): Promise<OrderBook[]>;
     /**
-     * @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: string, bar?: string, pagination?: Pagination): Promise<Candle[]>;
     getCandlesV2(params: CandleRequest): Promise<Candle[]>;
     /**
-     * @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: string, bar?: string, pagination?: Pagination): Promise<Candle[]>;
     getHistoricCandlesV2(params: CandleRequest): Promise<Candle[]>;
+    /**
+     * @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: string, limit?: number): Promise<Trade[]>;
+    /**
+     * @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: string, pagination?: {
         after?: numberInString;
         before?: numberInString;
@@ -622,7 +714,15 @@ export declare class RestClient extends BaseRestClient {
     getBlockQuotes(params?: GetBlockQuoteParams): Promise<GetBlockQuoteResult[]>;
     getBlockTrades(params?: any): Promise<any[]>;
     getPublicRFQBlockTrades(params?: any): Promise<any[]>;
+    /**
+     * @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: InstrumentType, uly?: string): Promise<any[]>;
+    /**
+     * @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: string): Promise<any[]>;
     getBlockPublicTrades(params: {
         instId: string;
@@ -675,6 +775,10 @@ export declare class RestClient extends BaseRestClient {
      * 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: InstrumentType, uly?: string, instFamily?: string, instId?: string): Promise<Instrument[]>;
     getDeliveryExerciseHistory(params: any): Promise<any[]>;
     getOpenInterest(params: any): Promise<any[]>;
@@ -697,56 +801,49 @@ export declare class RestClient extends BaseRestClient {
         instFamily?: string;
     }): Promise<any[]>;
     getPremiumHistory(params: GetPremiumHistoryRequest): Promise<any[]>;
+    /**
+     * @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: {
         quoteCcy?: string;
         instId?: string;
     }): Promise<IndexTicker[]>;
     /**
-     * @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: string, bar?: string, pagination?: Pagination): Promise<CandleNoVolume[]>;
     getIndexCandlesV2(params: CandleRequest): Promise<CandleNoVolume[]>;
     /**
-     * @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: string, bar?: string, pagination?: Pagination): Promise<CandleNoVolume[]>;
     getHistoricIndexCandlesV2(params: CandleRequest): Promise<CandleNoVolume[]>;
     /**
-     * @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: string, bar?: string, pagination?: Pagination): Promise<CandleNoVolume[]>;
     getMarkPriceCandlesV2(params: CandleRequest): Promise<CandleNoVolume[]>;
     /**
-     * @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: string, bar?: string, pagination?: Pagination): Promise<CandleNoVolume[]>;
     getHistoricMarkPriceCandlesV2(params: CandleRequest): Promise<CandleNoVolume[]>;
     getOracle(): Promise<any[]>;
     getExchangeRate(): Promise<any[]>;
+    /**
+     * @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: string): Promise<any[]>;
     getEconomicCalendar(params: EconomicCalendarRequest): Promise<EconomicCalendarData[]>;
     /**
-     * @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: string): Promise<any[]>;
     /**
@@ -815,11 +912,23 @@ export declare class RestClient extends BaseRestClient {
      * 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?: string): Promise<FundingCurrency[]>;
+    /**
+     * @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?: string): Promise<FundingBalance[]>;
     getNonTradableAssets(params?: {
         ccy?: string;
     }): Promise<NonTradableAsset[]>;
+    /**
+     * @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?: string): Promise<AccountAssetValuation[]>;
     fundsTransfer(params: FundsTransferRequest): Promise<FundTransferResult[]>;
     /** Either parameter transId or clientId is required. */
@@ -836,15 +945,32 @@ export declare class RestClient extends BaseRestClient {
         before?: numberInString;
         limit?: numberInString;
     }): Promise<AssetBillDetails[]>;
+    /**
+     * @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: string, amt: numberInString, to?: '6' | '18'): Promise<any[]>;
+    /**
+     * @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: string): Promise<any[]>;
     getDepositHistory(params?: any): Promise<any[]>;
     submitWithdraw(params: WithdrawRequest): Promise<WithdrawResponse[]>;
+    /**
+     * @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: string, invoice: string, memo?: string): Promise<any[]>;
+    /**
+     * @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: string): Promise<any[]>;
     getWithdrawalHistory(params?: WithdrawalHistoryRequest): Promise<any[]>;
     getDepositWithdrawStatus(params: GetDepositWithdrawStatusRequest): Promise<any[]>;
-    /** @deprecated
+    /**
+     * @deprecated
      * use submitEasyConvert() instead
      */
     smallAssetsConvert(ccy: string[]): Promise<any[]>;
@@ -856,6 +982,10 @@ export declare class RestClient extends BaseRestClient {
         month: string;
     }): Promise<any[]>;
     getConvertCurrencies(): Promise<any[]>;
+    /**
+     * @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: string, toCcy: string): Promise<any[]>;
     estimateConvertQuote(params: ConvertQuoteEstimateRequest): Promise<any[]>;
     convertTrade(params: ConvertTradeRequest): Promise<any[]>;
@@ -867,15 +997,24 @@ export declare class RestClient extends BaseRestClient {
      */
     /** View sub-account list */
     getSubAccountList(params?: any): Promise<SubAccount[]>;
-    /** 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: string, apiKey: string, options?: {
         label?: string;
         perm?: string;
         ip?: string;
     }): Promise<SubAccountAPIReset[]>;
-    /** 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: string): Promise<SubAccountBalances[]>;
-    /** 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: string, ccy?: string): Promise<FundingBalance[]>;
     getSubAccountMaxWithdrawal(params: GetSubAccountMaxWithdrawalsRequest): Promise<SubAccountMaxWithdrawal[]>;
     /** History of sub-account transfer */
@@ -890,9 +1029,15 @@ export declare class RestClient extends BaseRestClient {
     getManagedSubAccountTransferHistory(params: GetManagedSubAccountTransferHistoryRequest): Promise<ManagedSubAccountTransfer[]>;
     /** Master accounts manage the transfers between sub-accounts */
     transferSubAccountBalance(params: SubAccountTransferRequest): Promise<SubAccountTransferResult[]>;
-    /** 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: string, canTransOut?: boolean): Promise<any[]>;
-    /** 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?: string): Promise<any[]>;
     setSubAccountLoanAllocation(params: SetSubAccountLoanAllocationRequest): Promise<{
         result: boolean;
@@ -912,14 +1057,23 @@ export declare class RestClient extends BaseRestClient {
         protocolType?: 'staking' | 'defi';
         ccy?: string;
     }): Promise<any[]>;
-    /** 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: string, investData: {
         ccy: string;
         amt: string;
     }[], term?: string): Promise<any[]>;
-    /** 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: string, protocolType: 'staking' | 'defi', allowEarlyRedeem?: boolean): Promise<any[]>;
-    /** 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: string, protocolType: 'staking' | 'defi'): Promise<any[]>;
     /** Earn/staking get active orders */
     getActiveStakingOrders(params?: {
@@ -965,10 +1119,26 @@ export declare class RestClient extends BaseRestClient {
      * 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?: string): Promise<any[]>;
+    /**
+     * @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: string, amt: numberInString, side: 'purchase' | 'redempt', rate: numberInString): Promise<any[]>;
+    /**
+     * @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: string, rate: numberInString): Promise<any[]>;
     getLendingHistory(params?: PaginatedSymbolRequest): Promise<any[]>;
+    /**
+     * @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?: string): Promise<any[]>;
     getPublicBorrowHistory(params?: PaginatedSymbolRequest): Promise<any[]>;
     /**
@@ -1024,6 +1194,10 @@ export declare class RestClient extends BaseRestClient {
      * 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?: 'scheduled' | 'ongoing' | 'pre_open' | 'completed' | 'canceled'): Promise<any[]>;
     /**
      *