okx-api 1.5.8 → 2.0.0

package/lib/rest-client.d.ts

@@ -33,18 +33,14 @@ 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[]>;
+    getBalance(params?: {
+        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[]>;
+    getAccountPositionRisk(params?: {
+        instType?: Omit<'SPOT', InstrumentType>;
+    }): Promise<AccountPositionRisk[]>;
     /** Up to last 7 days */
     getBills(params?: any): Promise<AccountBill[]>;
     /** Last 3 months */
@@ -70,11 +66,9 @@ 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[]>;
+    setPositionMode(params: {
+        posMode: PosMode;
+    }): Promise<AccountPositionModeResult[]>;
     setLeverage(params: SetLeverageRequest): Promise<AccountLeverageResult[]>;
     /** Max buy/sell amount or open amount */
     getMaxBuySellAmount(params: {
@@ -93,11 +87,10 @@ export declare class RestClient extends BaseRestClient {
         unSpotOffset?: boolean;
     }): Promise<AccountMaxTradableAmount[]>;
     changePositionMargin(params: ChangePositionMarginRequest): Promise<AccountChangeMarginResult[]>;
-    /**
-     * @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[]>;
+    getLeverage(params: {
+        instId: string;
+        mgnMode: MarginMode;
+    }): Promise<AccountLeverage[]>;
     getLeverageV2(params: {
         instId?: string;
         ccy?: string;
@@ -111,23 +104,13 @@ export declare class RestClient extends BaseRestClient {
         ccy?: string;
         posSide: PositionSide;
     }): Promise<AdjustLeverageInfo[]>;
-    /**
-     * @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: {
+    getMaxLoan(params: {
         instId: string;
         mgnMode: MarginMode;
         mgnCcy?: string;
         ccy?: string;
     }): Promise<AccountMaxLoan[]>;
-    /**
-     * @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: {
+    getFeeRates(params: {
         instType: InstrumentType;
         instId?: string;
         uly?: string;
@@ -143,34 +126,28 @@ 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[]>;
+    getInterestRate(params?: {
+        ccy?: string;
+    }): Promise<InterestRate[]>;
+    setGreeksDisplayType(params: {
+        greeksType: 'PA' | 'BS';
+    }): Promise<Greeks[]>;
+    setIsolatedMode(params: {
+        isoMode: 'automatic' | 'autonomy';
+        type: 'MARGIN' | 'CONTRACTS';
+    }): Promise<AccountIsolatedMode[]>;
+    getMaxWithdrawals(params?: {
+        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[]>;
+    borrowRepayVIPLoan(params: {
+        ccy: string;
+        side: 'borrow' | 'repay';
+        amt: numberInString;
+        ordId?: string;
+    }): Promise<any[]>;
     getVIPLoanBorrowRepayHistory(params?: any): Promise<any[]>;
     getVIPInterestAccrued(params: GetVIPInterestRequest): Promise<VIPInterest[]>;
     getVIPInterestDeducted(params: GetVIPInterestRequest): Promise<VIPInterest[]>;
@@ -235,11 +212,9 @@ 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[]>;
+    getGreeks(params?: {
+        ccy?: string;
+    }): Promise<any[]>;
     getPMLimitation(params: {
         instType: 'SWAP' | 'FUTURES' | 'OPTION';
         uly?: string;
@@ -312,9 +287,6 @@ 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.
@@ -323,27 +295,30 @@ export declare class RestClient extends BaseRestClient {
      * If there are multiple currencies, separate them with commas in the "from" field.
      *
      */
-    submitEasyConvert(fromCcys: string[], toCcy: string, source?: string): Promise<APIResponse<any>>;
+    submitEasyConvert(params: {
+        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>>;
+    getOneClickRepayCurrencyList(params?: {
+        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.
      */
-    submitOneClickRepay(debtCcys: string[], repayCcy: string): Promise<APIResponse<any>>;
+    submitOneClickRepay(params: {
+        debtCcys: string[];
+        repayCcy: string;
+    }): Promise<APIResponse<any>>;
     /** Get the history and status of one-click repay trades. */
     getOneClickRepayHistory(params?: Pagination): Promise<APIResponse<any>>;
     cancelMassOrder(params: {
@@ -377,13 +352,19 @@ 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;
+    amendGridAlgoOrder(params: {
+        algoId: string;
+        instId: string;
+        slTriggerPx?: string;
+        tpTriggerPx?: string;
+        tpRatio?: string;
+        slRatio?: string;
+        triggerParams?: {
+            triggerAction?: string;
+            triggerStrategy?: string;
+            triggerPx?: string;
+            stopType?: string;
+        }[];
     }): Promise<any[]>;
     stopGridAlgoOrder(orders: StopGridAlgoOrderRequest[]): Promise<any[]>;
     closeGridContractPosition(params: CloseContractGridPositionRequest): Promise<any[]>;
@@ -399,40 +380,34 @@ 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?: {
+    getGridAlgoOrderDetails(params: {
+        algoOrdType: GridAlgoOrderType;
+        algoId: string;
+    }): Promise<any[]>;
+    getGridAlgoSubOrders(params: {
+        algoOrdType: GridAlgoOrderType;
+        algoId: string;
+        type: GridAlgoSubOrderType;
+        groupId?: string;
         after?: numberInString;
         before?: numberInString;
         limit?: number;
     }): 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.
-     */
-    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: {
+    getGridAlgoOrderPositions(params: {
+        algoOrdType: 'contract_grid';
+        algoId: string;
+    }): Promise<any[]>;
+    spotGridWithdrawIncome(params: {
+        algoId: string;
+    }): Promise<any[]>;
+    computeGridMarginBalance(params: {
+        algoId: string;
+        type: 'add' | 'reduce';
+        amt?: numberInString;
+    }): Promise<any[]>;
+    adjustGridMarginBalance(params: {
+        algoId: string;
+        type: 'add' | 'reduce';
         amt?: numberInString;
         percent?: numberInString;
     }): Promise<any[]>;
@@ -442,11 +417,12 @@ 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[]>;
+    getGridAIParameter(params: {
+        algoOrdType: GridAlgoOrderType;
+        instId: string;
+        direction: ContractGridDirection;
+        duration?: '7D' | '30D' | '180D';
+    }): Promise<any[]>;
     computeGridMinInvestment(params: {
         amt: string;
         ccy: string;
@@ -629,47 +605,30 @@ 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[]>;
+    getTickers(params: {
+        instType: InstrumentType;
+        uly?: string;
+        instFamily?: string;
+    }): Promise<Ticker[]>;
+    getTicker(params: {
+        instId: string;
+    }): Promise<Ticker[]>;
+    getOrderBook(params: {
+        instId: string;
+        sz?: numberInString;
+    }): Promise<OrderBook[]>;
     getFullOrderBook(params: {
         instId: string;
         sz?: string;
     }): Promise<OrderBook[]>;
-    /**
-     * @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 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?: {
+    getCandles(params: CandleRequest): Promise<Candle[]>;
+    getHistoricCandles(params: CandleRequest): Promise<Candle[]>;
+    getTrades(params: {
+        instId: string;
+        limit?: number;
+    }): Promise<Trade[]>;
+    getHistoricTrades(params: {
+        instId: string;
         after?: numberInString;
         before?: numberInString;
         limit?: numberInString;
@@ -714,16 +673,13 @@ 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[]>;
+    getBlockTickers(params: {
+        instType: InstrumentType;
+        uly?: string;
+    }): Promise<any[]>;
+    getBlockTicker(params: {
+        instId: string;
+    }): Promise<any[]>;
     getBlockPublicTrades(params: {
         instId: string;
     }): Promise<PublicBlockTrade[]>;
@@ -775,11 +731,12 @@ 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[]>;
+    getInstruments(params: {
+        instType: InstrumentType;
+        uly?: string;
+        instFamily?: string;
+        instId?: string;
+    }): Promise<Instrument[]>;
     getDeliveryExerciseHistory(params: any): Promise<any[]>;
     getOpenInterest(params: any): Promise<any[]>;
     getFundingRate(params: any): Promise<any[]>;
@@ -801,55 +758,23 @@ 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 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 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 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 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[]>;
+    getIndexCandles(params: CandleRequest): Promise<CandleNoVolume[]>;
+    getHistoricIndexCandles(params: CandleRequest): Promise<CandleNoVolume[]>;
+    getMarkPriceCandles(params: CandleRequest): Promise<CandleNoVolume[]>;
+    getHistoricMarkPriceCandles(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[]>;
+    getIndexComponents(params: {
+        index: string;
+    }): Promise<any[]>;
     getEconomicCalendar(params: EconomicCalendarRequest): Promise<EconomicCalendarData[]>;
-    /**
-     * @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[]>;
-    /**
-     * @deprecated
-     */
-    getLiquidationOrders(params: any): Promise<any[]>;
+    getPublicBlockTrades(params: {
+        instId: string;
+    }): Promise<any[]>;
     /**
      *
      * Trading statistics - REST endpoints
@@ -912,24 +837,18 @@ 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[]>;
+    getCurrencies(params: {
+        ccy?: string;
+    }): Promise<FundingCurrency[]>;
+    getBalances(params: {
+        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[]>;
+    getAccountAssetValuation(params: {
+        ccy?: string;
+    }): Promise<AccountAssetValuation[]>;
     fundsTransfer(params: FundsTransferRequest): Promise<FundTransferResult[]>;
     /** Either parameter transId or clientId is required. */
     getFundsTransferState(params: {
@@ -945,35 +864,26 @@ 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[]>;
+    getLightningDeposits(params: {
+        ccy: string;
+        amt: numberInString;
+        to?: '6' | '18';
+    }): Promise<any[]>;
+    getDepositAddress(params: {
+        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[]>;
+    submitWithdrawLightning(params: {
+        ccy: string;
+        invoice: string;
+        memo?: string;
+    }): Promise<any[]>;
+    cancelWithdrawal(params: {
+        wdId: string;
+    }): Promise<any[]>;
     getWithdrawalHistory(params?: WithdrawalHistoryRequest): Promise<any[]>;
     getDepositWithdrawStatus(params: GetDepositWithdrawStatusRequest): Promise<any[]>;
-    /**
-     * @deprecated
-     * use submitEasyConvert() instead
-     */
-    smallAssetsConvert(ccy: string[]): Promise<any[]>;
     getExchanges(): Promise<any[]>;
     applyForMonthlyStatement(params?: {
         month?: string;
@@ -982,11 +892,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[]>;
+    getConvertCurrencyPair(params: {
+        fromCcy: string;
+        toCcy: string;
+    }): Promise<any[]>;
     estimateConvertQuote(params: ConvertQuoteEstimateRequest): Promise<any[]>;
     convertTrade(params: ConvertTradeRequest): Promise<any[]>;
     getConvertHistory(params?: any): Promise<any[]>;
@@ -997,25 +906,20 @@ export declare class RestClient extends BaseRestClient {
      */
     /** View sub-account list */
     getSubAccountList(params?: any): Promise<SubAccount[]>;
-    /**
-     * @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?: {
+    resetSubAccountAPIKey(params: {
+        subAcct: string;
+        apiKey: string;
         label?: string;
         perm?: string;
         ip?: string;
     }): Promise<SubAccountAPIReset[]>;
-    /**
-     * @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[]>;
-    /**
-     * @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[]>;
+    getSubAccountBalances(params: {
+        subAcct: string;
+    }): Promise<SubAccountBalances[]>;
+    getSubAccountFundingBalances(params: {
+        subAcct: string;
+        ccy?: string;
+    }): Promise<FundingBalance[]>;
     getSubAccountMaxWithdrawal(params: GetSubAccountMaxWithdrawalsRequest): Promise<SubAccountMaxWithdrawal[]>;
     /** History of sub-account transfer */
     getSubAccountTransferHistory(params?: {
@@ -1029,16 +933,13 @@ export declare class RestClient extends BaseRestClient {
     getManagedSubAccountTransferHistory(params: GetManagedSubAccountTransferHistoryRequest): Promise<ManagedSubAccountTransfer[]>;
     /** Master accounts manage the transfers between sub-accounts */
     transferSubAccountBalance(params: SubAccountTransferRequest): Promise<SubAccountTransferResult[]>;
-    /**
-     * @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[]>;
-    /**
-     * @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[]>;
+    setSubAccountTransferOutPermission(params: {
+        subAcct: string;
+        canTransOut: boolean;
+    }): Promise<any[]>;
+    getSubAccountCustodyTradingList(params: {
+        subAcct?: string;
+    }): Promise<any[]>;
     setSubAccountLoanAllocation(params: SetSubAccountLoanAllocationRequest): Promise<{
         result: boolean;
     }[]>;
@@ -1057,24 +958,23 @@ export declare class RestClient extends BaseRestClient {
         protocolType?: 'staking' | 'defi';
         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.
-     */
-    submitStake(productId: string, investData: {
-        ccy: string;
-        amt: string;
-    }[], term?: 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.
-     */
-    redeemStake(ordId: string, protocolType: 'staking' | 'defi', allowEarlyRedeem?: boolean): 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.
-     */
-    cancelStakingRequest(ordId: string, protocolType: 'staking' | 'defi'): Promise<any[]>;
+    submitStake(params: {
+        productId: string;
+        investData: {
+            ccy: string;
+            amt: string;
+        }[];
+        term?: string;
+    }): Promise<any[]>;
+    redeemStake(params: {
+        ordId: string;
+        protocolType: 'staking' | 'defi';
+        allowEarlyRedeem?: boolean;
+    }): Promise<any[]>;
+    cancelStakingRequest(params: {
+        ordId: string;
+        protocolType: 'staking' | 'defi';
+    }): Promise<any[]>;
     /** Earn/staking get active orders */
     getActiveStakingOrders(params?: {
         productId?: string;
@@ -1119,27 +1019,23 @@ 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[]>;
+    getSavingBalance(params: {
+        ccy?: string;
+    }): Promise<any[]>;
+    savingsPurchaseRedemption(params: {
+        ccy: string;
+        amt: numberInString;
+        side: 'purchase' | 'redempt';
+        rate: numberInString;
+    }): Promise<any[]>;
+    setLendingRate(params: {
+        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[]>;
+    getPublicBorrowInfo(params: {
+        ccy?: string;
+    }): Promise<any[]>;
     getPublicBorrowHistory(params?: PaginatedSymbolRequest): Promise<any[]>;
     /**
      *
@@ -1194,11 +1090,9 @@ 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[]>;
+    getSystemStatus(params: {
+        state?: 'scheduled' | 'ongoing' | 'pre_open' | 'completed' | 'canceled';
+    }): Promise<any[]>;
     /**
      *
      * Announcement endpoints
@@ -1220,11 +1114,6 @@ export declare class RestClient extends BaseRestClient {
      * Broker endpoints (private)
      *
      */
-    /**
-     *
-     * @deprecated
-     */
-    getBrokerAccountInformation(): Promise<any[]>;
     createSubAccount(params: {
         subAcct: string;
         label?: string;