okx-api 1.3.7 → 1.4.0

package/lib/rest-client.d.ts

@@ -1,6 +1,6 @@
 import { AxiosRequestConfig } from 'axios';
 import BaseRestClient from './util/BaseRestClient';
-import { ContractGridDirection, GridAlgoOrderType, GridAlgoSubOrderType, InstrumentType, MarginMode, numberInString, Ticker, AmendOrderRequest, CancelAlgoOrderRequest, OrderIdRequest, ClosePositionRequest, OrderRequest, OrderHistoryRequest, FillsHistoryRequest, AlgoRecentHistoryRequest, AlgoLongHistoryRequest, PaginatedSymbolRequest, OrderResult, CancelledOrderResult, AmendedOrder, ClosedPositions, OrderDetails, OrderListItem, HistoricOrder, OrderFill, AlgoOrderResult, AlgoOrderListItem, HistoricAlgoOrder, BlockCounterParty, CreateBlockRFQRequest, CreateRFQResult, CancelBlockRFQRequest, CancelBlockQuoteResult, CancelMultipleBlockRFQRequest, TimestampObject, ExecuteBlockQuoteResult, ExecuteBlockQuoteRequest, CreateBlockQuoteRequest, CreateBlockQuoteResult, CancelBlockRFQResult, CancelBlockQuoteRequest, CancelMultipleBlockQuoteRequest, BlockRFQResult, GetBlockRFQSParams, GetBlockQuoteParams, GetBlockQuoteResult, FundingCurrency, FundingBalance, AccountAssetValuation, FundTransferResult, FundTransferState, AssetBillDetails, AccountBalance, GetPositionsParams, AccountPosition, GetHistoricPositionParams, HistoricAccountPosition, AccountPositionRisk, AccountBill, AccountConfiguration, AccountPositionModeResult, AccountLeverageResult, AccountMaxOrderAmount, AccountMaxTradableAmount, AccountChangeMarginResult, AccountLevel, AccountLeverage, AccountMaxLoan, AccountModeResult, AccountFeeRate, AccountIsolatedMode, AutoLoanResult, SubAccount, SubAccountAPIReset, SubAccountBalances, SubAccountTransferResult, IndexTicker, OrderBook, Candle, CandleNoVolume, Trade, Pagination, APIResponse, GetGridAlgoOrdersRequest, FundsTransferRequest, WithdrawRequest, WithdrawResponse, ConvertTradeRequest, ConvertQuoteEstimateRequest, SetLeverageRequest, ChangePositionMarginRequest, SubAccountTransferRequest, GridAlgoOrderRequest, StopGridAlgoOrderRequest, APICredentials, RestClientOptions, APIMarket, Instrument, PosMode, AlgoOrderDetailsRequest, AlgoOrderDetailsResult, AmendAlgoOrderRequest, AmendAlgoOrderResult, AlgoOrderRequest, EconomicCalendarData, UnitConvertData, EconomicCalendarRequest, UnitConvertRequest, PositionSide, AdjustLeverageInfo, InterestAccrued, InterestRate, Greeks, AccountRiskState, SystemTime, MaxWithdrawal, WithdrawalHistoryRequest, FundingRateRequest } from './types';
+import { ContractGridDirection, GridAlgoOrderType, GridAlgoSubOrderType, InstrumentType, MarginMode, numberInString, Ticker, AmendOrderRequest, CancelAlgoOrderRequest, OrderIdRequest, ClosePositionRequest, OrderRequest, OrderHistoryRequest, FillsHistoryRequest, AlgoRecentHistoryRequest, AlgoLongHistoryRequest, PaginatedSymbolRequest, OrderResult, CancelledOrderResult, AmendedOrder, ClosedPositions, OrderDetails, OrderListItem, HistoricOrder, OrderFill, AlgoOrderResult, AlgoOrderListItem, HistoricAlgoOrder, BlockCounterParty, CreateBlockRFQRequest, CreateRFQResult, CancelBlockRFQRequest, CancelBlockQuoteResult, CancelMultipleBlockRFQRequest, TimestampObject, ExecuteBlockQuoteResult, ExecuteBlockQuoteRequest, CreateBlockQuoteRequest, CreateBlockQuoteResult, CancelBlockRFQResult, CancelBlockQuoteRequest, CancelMultipleBlockQuoteRequest, BlockRFQResult, GetBlockRFQSParams, GetBlockQuoteParams, GetBlockQuoteResult, FundingCurrency, FundingBalance, AccountAssetValuation, FundTransferResult, FundTransferState, AssetBillDetails, AccountBalance, GetPositionsParams, AccountPosition, GetHistoricPositionParams, HistoricAccountPosition, AccountPositionRisk, AccountBill, AccountConfiguration, AccountPositionModeResult, AccountLeverageResult, AccountMaxOrderAmount, AccountMaxTradableAmount, AccountChangeMarginResult, AccountLevel, AccountLeverage, AccountMaxLoan, AccountModeResult, AccountFeeRate, AccountIsolatedMode, AutoLoanResult, SubAccount, SubAccountAPIReset, SubAccountBalances, SubAccountTransferResult, IndexTicker, OrderBook, Candle, CandleNoVolume, Trade, Pagination, APIResponse, GetGridAlgoOrdersRequest, FundsTransferRequest, WithdrawRequest, WithdrawResponse, ConvertTradeRequest, ConvertQuoteEstimateRequest, SetLeverageRequest, ChangePositionMarginRequest, SubAccountTransferRequest, GridAlgoOrderRequest, StopGridAlgoOrderRequest, APICredentials, RestClientOptions, APIMarket, Instrument, PosMode, AlgoOrderDetailsRequest, AlgoOrderDetailsResult, AmendAlgoOrderRequest, AmendAlgoOrderResult, AlgoOrderRequest, EconomicCalendarData, UnitConvertData, EconomicCalendarRequest, UnitConvertRequest, PositionSide, AdjustLeverageInfo, InterestAccrued, InterestRate, Greeks, AccountRiskState, SystemTime, MaxWithdrawal, WithdrawalHistoryRequest, FundingRateRequest, GetInstrumentsRequest, QuickMarginBorrowRepayRequest, GetQuickMarginBorrowRepayHistoryRequest, GetVIPInterestRequest, VIPInterest, GetVIPLoanOrderListRequest, VIPLoanOrder, GetVIPLoanOrderDetailRequest, VIPLoanOrderDetail, FixedLoanBorrowingLimit, GetFixedLoanBorrowQuoteRequest, FixedLoanBorrowQuote, SubmitFixedLoanBorrowingOrderRequest, UpdateFixedLoanBorrowingOrderRequest, GetFixedLoanBorrowingOrdersListRequest, PositionBuilderRequest, SetMMPConfigRequest, MMPConfig, CancelAllAfterResponse, CloseContractGridPositionRequest, GetRSIBackTestingRequest, SubAccountMaxWithdrawal, GetSubAccountMaxWithdrawalsRequest, GetManagedSubAccountTransferHistoryRequest, ManagedSubAccountTransfer, SetSubAccountLoanAllocationRequest, NonTradableAsset, GetDepositWithdrawStatusRequest, GetPremiumHistoryRequest, GetContractOpenInterestHistoryRequest, GetContractTakerVolumeRequest, GetTopTradersContractLongShortRatioRequest, GetLendingOrderListRequest, GetLendingSubOrderListRequest, LendingOrder, CreateSignalRequest, GetSignalsRequest, CreateSignalBotRequest, AdjustMarginBalanceRequest, AmendTPSLRequest, SetSignalInstrumentsRequest, GetSignalBotRequest, GetSignalBotPositionHistoryRequest, PlaceSubOrderRequest, CancelSubOrderRequest, GetSignalBotSubOrdersRequest, GetSignalBotEventHistoryRequest, GetCurrentSubpositionsRequest, GetSubpositionsHistoryRequest, PlaceCTAlgoOrderRequest, CloseSubpositionRequest, GetCTProfitDetailsRequest, CopySettingsRequest, AmendRecurringBuyOrderRequest, GetRecurringBuyOrderListRequest, PlaceRecurringBuyOrderRequest, SetCTBatchLeverageRequest, GetCTBatchLeverageInfoRequest, GetCTHistoryLeadTradersRequest, GetLeadTraderRanksRequest, LeadTraderPnl, LeadTraderStats, GetLeadTraderStatsRequest, LeadTraderPreference, LeadTraderCurrentPosition, GetLeadTraderPositionsRequest, LeadTraderPositionHistory, GetCopyTradersRequest, GetPrivateLeadTraderRanksRequest, OptionTrade, GetOptionTradesRequest, OptionTrades, BlockMakerInstrumentSettings, SetQuoteProductsRequest, SetMmpConfigRequest, PlaceSpreadOrderRequest, PlaceSpreadOrderResponse, CancelSpreadOrderResponse, UpdateSpreadOrderRequest, UpdateSpreadOrderResponse, SpreadOrder, GetActiveSpreadOrdersRequest, GetSpreadOrderHistoryRequest, GetSpreadOrderHistoryArchiveRequest, GetSpreadTradesRequest, SpreadTrade, SpreadDetails, GetSpreadsRequest, SpreadOrderBook, SpreadTicker, PublicSpreadTrade, GetSpreadCandlesRequest, SpreadCandle, CandleRequest, AccountInstrument, SetMMPConfigResult, CreateSignalResult, GetSignalsResult, CreateSignalBotResult, CancelSignalBotsResult, RecurringBuyOrderResult, RecurringBuyOrder, RecurringBuySubOrder, SubpositionsHistory, CurrentSubposition, GetAccountConfigurationResult, GetCTBatchLeverageInfoResult, GetCTHistoryLeadTradersResult, GetCTMyLeadTradersResult, GetCTProfitDetailsResult, GetCTTotalProfitResult, GetCTUnrealizedProfitResult, GetCopySettingsResult, GetCopyTradersResult, GetCopyTradingConfigResult, GetLeadTraderRanksResult, GetPrivateLeadTraderRanksResult, PlaceCTAlgoOrderResult, SetCTBatchLeverageResult, QuickMarginBorrowRepayRecord, BlockMMPConfig, PublicBlockTrade, QuickMarginBorrowRepayResult, SetMmpConfigResult } from './types';
 import { ASSET_BILL_TYPE } from './constants';
 export declare class RestClient extends BaseRestClient {
     /**
@@ -8,11 +8,6 @@ export declare class RestClient extends BaseRestClient {
      */
     constructor(credentials?: APICredentials | null, environment?: APIMarket, restClientOptions?: RestClientOptions, requestOptions?: AxiosRequestConfig);
     getServerTime(): Promise<number>;
-    /**
-     *
-     * Trade endpoints (private)
-     *
-     */
     submitOrder(params: OrderRequest): Promise<OrderResult[]>;
     submitMultipleOrders(params: OrderRequest[]): Promise<OrderResult[]>;
     cancelOrder(params: OrderIdRequest): Promise<CancelledOrderResult[]>;
@@ -38,6 +33,28 @@ export declare class RestClient extends BaseRestClient {
      * Get history for last 3 months
      */
     getFillsHistory(params: FillsHistoryRequest): Promise<OrderFill[]>;
+    applyTransactionDetailsArchive(params: {
+        year: string;
+        quarter: 'Q1' | 'Q2' | 'Q3' | 'Q4';
+    }): Promise<{
+        result: string;
+        ts: string;
+    }[]>;
+    getTransactionDetailsArchiveLink(params: {
+        year: string;
+        quarter: 'Q1' | 'Q2' | 'Q3' | 'Q4';
+    }): Promise<any[]>;
+    cancelMassOrder(params: {
+        instType: string;
+        instFamily: string;
+    }): Promise<{
+        result: boolean;
+    }[]>;
+    cancelAllAfter(params: {
+        timeOut: string;
+        tag?: string;
+    }): Promise<CancelAllAfterResponse[]>;
+    getAccountRateLimit(): Promise<any[]>;
     placeAlgoOrder(params: AlgoOrderRequest): Promise<AlgoOrderResult[]>;
     getAlgoOrderDetails(params: AlgoOrderDetailsRequest): Promise<AlgoOrderDetailsResult[]>;
     amendAlgoOrder(params: AmendAlgoOrderRequest): Promise<AmendAlgoOrderResult[]>;
@@ -81,14 +98,32 @@ export declare class RestClient extends BaseRestClient {
     cancelMultipleBlockRFQs(params: CancelMultipleBlockRFQRequest): Promise<CancelBlockRFQResult[]>;
     cancelAllRFQs(): Promise<TimestampObject[]>;
     executeBlockQuote(params: ExecuteBlockQuoteRequest): Promise<ExecuteBlockQuoteResult[]>;
+    getQuoteProducts(): Promise<BlockMakerInstrumentSettings[]>;
+    updateBlockQuoteProducts(params: SetQuoteProductsRequest): Promise<{
+        result: boolean;
+    }[]>;
+    resetBlockMmp(): Promise<{
+        ts: string;
+    }[]>;
+    updateBlockMmpConfig(params: SetMmpConfigRequest): Promise<SetMmpConfigResult[]>;
+    getBlockMmpConfig(): Promise<BlockMMPConfig[]>;
     createBlockQuote(params: CreateBlockQuoteRequest): Promise<CreateBlockQuoteResult[]>;
     cancelBlockQuote(params: CancelBlockQuoteRequest): Promise<CancelBlockQuoteResult[]>;
     cancelMultipleBlockQuotes(params: CancelMultipleBlockQuoteRequest): Promise<CancelBlockQuoteResult[]>;
     cancelAllBlockQuotes(): Promise<TimestampObject[]>;
+    cancelAllBlockAfter(params: {
+        timeOut: string;
+    }): Promise<{
+        triggerTime: string;
+        ts: string;
+    }[]>;
     getBlockRFQs(params?: GetBlockRFQSParams): Promise<BlockRFQResult[]>;
     getBlockQuotes(params?: GetBlockQuoteParams): Promise<GetBlockQuoteResult[]>;
     getBlockTrades(params?: any): Promise<any[]>;
     getPublicRFQBlockTrades(params?: any): Promise<any[]>;
+    getBlockPublicTrades(params: {
+        instId: string;
+    }): Promise<PublicBlockTrade[]>;
     /**
      *
      * Funding endpoints (private)
@@ -96,6 +131,9 @@ export declare class RestClient extends BaseRestClient {
      */
     getCurrencies(ccy?: string): Promise<FundingCurrency[]>;
     getBalances(ccy?: string): Promise<FundingBalance[]>;
+    getNonTradableAssets(params?: {
+        ccy?: string;
+    }): Promise<NonTradableAsset[]>;
     getAccountAssetValuation(ccy?: string): Promise<AccountAssetValuation[]>;
     fundsTransfer(params: FundsTransferRequest): Promise<FundTransferResult[]>;
     /** Either parameter transId or clientId is required. */
@@ -119,7 +157,15 @@ export declare class RestClient extends BaseRestClient {
     submitWithdrawLightning(ccy: string, invoice: string, memo?: string): Promise<any[]>;
     cancelWithdrawal(wdId: string): Promise<any[]>;
     getWithdrawalHistory(params?: WithdrawalHistoryRequest): Promise<any[]>;
+    getDepositWithdrawStatus(params: GetDepositWithdrawStatusRequest): Promise<any[]>;
     smallAssetsConvert(ccy: string[]): Promise<any[]>;
+    getExchanges(): Promise<any[]>;
+    applyForMonthlyStatement(params?: {
+        month?: string;
+    }): Promise<any[]>;
+    getMonthlyStatement(params: {
+        month: string;
+    }): Promise<any[]>;
     getSavingBalance(ccy?: string): Promise<any[]>;
     savingsPurchaseRedemption(ccy: string, amt: numberInString, side: 'purchase' | 'redempt', rate: numberInString): Promise<any[]>;
     setLendingRate(ccy: string, rate: numberInString): Promise<any[]>;
@@ -141,6 +187,7 @@ export declare class RestClient extends BaseRestClient {
      * Account endpoints (private)
      *
      */
+    getAccountInstruments(params: GetInstrumentsRequest): Promise<AccountInstrument[]>;
     getBalance(ccy?: string): Promise<AccountBalance[]>;
     getPositions(params?: GetPositionsParams): Promise<AccountPosition[]>;
     getPositionsHistory(params?: GetHistoricPositionParams): Promise<HistoricAccountPosition[]>;
@@ -200,18 +247,70 @@ export declare class RestClient extends BaseRestClient {
     setIsolatedMode(isoMode: 'automatic' | 'autonomy', type: 'MARGIN' | 'CONTRACTS'): Promise<AccountIsolatedMode[]>;
     getMaxWithdrawals(ccy?: string): Promise<MaxWithdrawal[]>;
     getAccountRiskState(): Promise<AccountRiskState[]>;
+    submitQuickMarginBorrowRepay(params: QuickMarginBorrowRepayRequest): Promise<QuickMarginBorrowRepayResult[]>;
+    getQuickMarginBorrowRepayHistory(params: GetQuickMarginBorrowRepayHistoryRequest): Promise<QuickMarginBorrowRepayRecord[]>;
     borrowRepayVIPLoan(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[]>;
+    getVIPLoanOrders(params: GetVIPLoanOrderListRequest): Promise<VIPLoanOrder[]>;
+    getVIPLoanOrder(params: GetVIPLoanOrderDetailRequest): Promise<VIPLoanOrderDetail[]>;
     getBorrowInterestLimits(params?: {
         type?: '1' | '2';
         ccy?: string;
     }): Promise<any[]>;
+    getFixedLoanBorrowLimit(): Promise<FixedLoanBorrowingLimit[]>;
+    getFixedLoanBorrowQuote(params: GetFixedLoanBorrowQuoteRequest): Promise<FixedLoanBorrowQuote[]>;
+    submitFixedLoanBorrowOrder(params: SubmitFixedLoanBorrowingOrderRequest): Promise<{
+        ordId: string;
+    }[]>;
+    updateFixedLoanBorrowOrder(params: UpdateFixedLoanBorrowingOrderRequest): Promise<{
+        ordId: string;
+    }[]>;
+    manualRenewFixedLoanBorrowOrder(params: {
+        ordId: string;
+        maxRate: string;
+    }): Promise<{
+        ordId: string;
+    }[]>;
+    repayFixedLoanBorrowOrder(params: {
+        ordId: string;
+    }): Promise<{
+        ordId: string;
+    }[]>;
+    getFixedLoanBorrowOrders(params: GetFixedLoanBorrowingOrdersListRequest): Promise<any[]>;
+    positionBuilder(params: PositionBuilderRequest): Promise<any[]>;
+    updateRiskOffsetAmount(params: {
+        ccy: string;
+        clSpotInUseAmt: string;
+    }): Promise<{
+        ccy: string;
+        clSpotInUseAmt: string;
+    }[]>;
     getGreeks(ccy?: string): Promise<any[]>;
     getPMLimitation(params: {
         instType: 'SWAP' | 'FUTURES' | 'OPTION';
         uly?: string;
         instFamily?: string;
     }): Promise<any[]>;
+    updateRiskOffsetType(params: {
+        type: '1' | '2' | '3' | '4';
+    }): Promise<{
+        type: '1' | '2' | '3' | '4';
+    }[]>;
+    activateOption(): Promise<{
+        ts: string;
+    }[]>;
+    resetMMPStatus(params: {
+        instType?: 'OPTION';
+        instFamily: string;
+    }): Promise<{
+        result: boolean;
+    }[]>;
+    setMMPConfig(params: SetMMPConfigRequest): Promise<SetMMPConfigResult[]>;
+    getMMPConfig(params?: {
+        instFamily?: string;
+    }): Promise<MMPConfig[]>;
     /**
      *
      * SubAccount endpoints (private)
@@ -229,6 +328,7 @@ export declare class RestClient extends BaseRestClient {
     getSubAccountBalances(subAcct: string): Promise<SubAccountBalances[]>;
     /** Get sub-account funding balance */
     getSubAccountFundingBalances(subAcct: string, ccy?: string): Promise<FundingBalance[]>;
+    getSubAccountMaxWithdrawal(params: GetSubAccountMaxWithdrawalsRequest): Promise<SubAccountMaxWithdrawal[]>;
     /** History of sub-account transfer */
     getSubAccountTransferHistory(params?: {
         ccy?: string;
@@ -238,12 +338,20 @@ export declare class RestClient extends BaseRestClient {
         before?: string;
         limit?: string;
     }): Promise<any[]>;
+    getManagedSubAccountTransferHistory(params: GetManagedSubAccountTransferHistoryRequest): Promise<ManagedSubAccountTransfer[]>;
     /** Master accounts manage the transfers between sub-accounts */
     transferSubAccountBalance(params: SubAccountTransferRequest): Promise<SubAccountTransferResult[]>;
     /** Set Permission Of Transfer Out */
     setSubAccountTransferOutPermission(subAcct: string, canTransOut?: boolean): Promise<any[]>;
     /** Get custody trading sub-account list */
     getSubAccountCustodyTradingList(subAcct?: string): Promise<any[]>;
+    setSubAccountLoanAllocation(params: SetSubAccountLoanAllocationRequest): Promise<{
+        result: boolean;
+    }[]>;
+    getSubAccountBorrowInterestAndLimit(params: {
+        subAcct: string;
+        ccy?: string;
+    }): Promise<any[]>;
     /**
      *
      * Grid trading endpoints (private)
@@ -255,6 +363,17 @@ export declare class RestClient extends BaseRestClient {
         tpTriggerPx?: numberInString;
     }): Promise<any[]>;
     stopGridAlgoOrder(orders: StopGridAlgoOrderRequest[]): Promise<any[]>;
+    closeGridContractPosition(params: CloseContractGridPositionRequest): Promise<any[]>;
+    cancelGridContractCloseOrder(params: {
+        algoId: string;
+        ordId: string;
+    }): Promise<any[]>;
+    instantTriggerGridAlgoOrder(params: {
+        algoId: string;
+    }): Promise<{
+        algoId: string;
+        algoClOrdId: string;
+    }[]>;
     getGridAlgoOrderList(params: GetGridAlgoOrdersRequest): Promise<any[]>;
     getGridAlgoOrderHistory(params: GetGridAlgoOrdersRequest): Promise<any[]>;
     getGridAlgoOrderDetails(algoOrdType: GridAlgoOrderType, algoId: string): Promise<any[]>;
@@ -271,43 +390,20 @@ export declare class RestClient extends BaseRestClient {
         amt?: numberInString;
         percent?: numberInString;
     }): Promise<any[]>;
+    adjustGridInvestment(params: {
+        algoId: string;
+        amt: string;
+    }): Promise<{
+        algoId: string;
+    }[]>;
     getGridAIParameter(algoOrdType: GridAlgoOrderType, instId: string, direction: ContractGridDirection, duration?: '7D' | '30D' | '180D'): Promise<any[]>;
-    /**
-     *
-     * Earn/staking endpoints (private)
-     *
-     */
-    /** Get earn offers */
-    getStakingOffers(params?: {
-        productId?: string;
-        protocolType?: 'staking' | 'defi';
-        ccy?: string;
-    }): Promise<APIResponse<any>>;
-    /** Earn/staking purchase */
-    submitStake(productId: string, investData: {
-        ccy: string;
+    computeGridMinInvestment(params: {
         amt: string;
-    }[], term?: string): Promise<APIResponse<any>>;
-    /** Earn/staking redeem */
-    redeemStake(ordId: string, protocolType: 'staking' | 'defi', allowEarlyRedeem?: boolean): Promise<APIResponse<any>>;
-    /** Earn/staking cancel purchases/redemptions */
-    cancelStakingRequest(ordId: string, protocolType: 'staking' | 'defi'): Promise<APIResponse<any>>;
-    /** Earn/staking get active orders */
-    getActiveStakingOrders(params?: {
-        productId?: string;
-        protocolType?: 'staking' | 'defi';
-        ccy?: string;
-        state?: '8' | '13' | '9' | '1' | '2';
-    }): Promise<APIResponse<any>>;
-    /** Earn/staking get order history */
-    getStakingOrderHistory(params?: {
-        productId?: string;
-        protocolType?: string;
-        ccy?: string;
-        after?: string;
-        before?: string;
-        limit?: string;
-    }): Promise<APIResponse<any>>;
+        ccy: string;
+    }): Promise<any[]>;
+    getRSIBackTesting(params: GetRSIBackTestingRequest): Promise<{
+        triggerNum: string;
+    }[]>;
     /**
      *
      * Market data endpoints (public)
@@ -320,12 +416,70 @@ export declare class RestClient extends BaseRestClient {
         instId?: string;
     }): Promise<IndexTicker[]>;
     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
+     */
     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
+     */
     getHistoricCandles(instId: string, bar?: string, pagination?: Pagination): Promise<Candle[]>;
+    getHistoricCandlesV2(params: CandleRequest): Promise<Candle[]>;
+    /**
+     * @deprecated this method's parameters will change to an object in the next release. Use getIndexCandlesV2 instead.
+     *
+     * @param instId
+     * @param bar
+     * @param pagination
+     * @returns
+     */
     getIndexCandles(instId: 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
+     */
     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
+     */
     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
+     */
     getHistoricMarkPriceCandles(instId: string, bar?: string, pagination?: Pagination): Promise<CandleNoVolume[]>;
+    getHistoricMarkPriceCandlesV2(params: CandleRequest): Promise<CandleNoVolume[]>;
     getTrades(instId: string, limit?: number): Promise<Trade[]>;
     getHistoricTrades(instId: string, pagination?: {
         after?: numberInString;
@@ -333,12 +487,19 @@ export declare class RestClient extends BaseRestClient {
         limit?: numberInString;
         type?: '1' | '2';
     }): Promise<Trade[]>;
+    getOptionTradesByInstrument(params: {
+        instFamily: string;
+    }): Promise<OptionTrade[]>;
+    getOptionTrades(params: GetOptionTradesRequest): Promise<OptionTrades[]>;
     get24hrTotalVolume(): Promise<any[]>;
     getOracle(): Promise<any[]>;
     getExchangeRate(): Promise<any[]>;
     getIndexComponents(index: string): Promise<any[]>;
     getBlockTickers(instType: InstrumentType, uly?: string): Promise<any[]>;
     getBlockTicker(instId: string): Promise<any[]>;
+    /**
+     * @deprecated
+     */
     getPublicBlockTrades(instId: string): Promise<any[]>;
     /**
      *
@@ -363,6 +524,11 @@ export declare class RestClient extends BaseRestClient {
     getUnderlying(params: any): Promise<any[]>;
     getInsuranceFund(params: any): Promise<any[]>;
     getUnitConvert(params: UnitConvertRequest): Promise<UnitConvertData[]>;
+    getOptionTickBands(params: {
+        instType: string;
+        instFamily?: string;
+    }): Promise<any[]>;
+    getPremiumHistory(params: GetPremiumHistoryRequest): Promise<any[]>;
     getEconomicCalendar(params: EconomicCalendarRequest): Promise<EconomicCalendarData[]>;
     /**
      *
@@ -370,13 +536,24 @@ export declare class RestClient extends BaseRestClient {
      *
      */
     getSupportCoin(): Promise<any[]>;
-    getTakerVolume(): Promise<any[]>;
+    getOpenInterestHistory(params: GetContractOpenInterestHistoryRequest): Promise<any[]>;
+    getTakerVolume(params: {
+        instType: string;
+        ccy: string;
+        period?: string;
+        end?: string;
+        begin?: string;
+    }): Promise<any[]>;
+    getContractTakerVolume(params: GetContractTakerVolumeRequest): Promise<any[]>;
     getMarginLendingRatio(params: {
         ccy: string;
         begin?: numberInString;
         end?: numberInString;
         period: '5m' | '1H' | '1D';
     }): Promise<any[]>;
+    getTopTradersAccountRatio(params: GetTopTradersContractLongShortRatioRequest): Promise<any[]>;
+    getTopTradersContractPositionRatio(params: GetTopTradersContractLongShortRatioRequest): Promise<any[]>;
+    getLongShortContractRatio(params: GetTopTradersContractLongShortRatioRequest): Promise<any[]>;
     getLongShortRatio(params: {
         ccy: string;
         begin?: numberInString;
@@ -410,6 +587,306 @@ export declare class RestClient extends BaseRestClient {
         ccy: string;
         period: '8H' | '1D';
     }): Promise<any[]>;
+    /**
+     *
+     * FINANCIAL PRODUCT - On-chain earn endpoints
+     *
+     */
+    /** Get earn offers */
+    getStakingOffers(params?: {
+        productId?: string;
+        protocolType?: 'staking' | 'defi';
+        ccy?: string;
+    }): Promise<any[]>;
+    /** Earn/staking purchase */
+    submitStake(productId: string, investData: {
+        ccy: string;
+        amt: string;
+    }[], term?: string): Promise<any[]>;
+    /** Earn/staking redeem */
+    redeemStake(ordId: string, protocolType: 'staking' | 'defi', allowEarlyRedeem?: boolean): Promise<any[]>;
+    /** Earn/staking cancel purchases/redemptions */
+    cancelStakingRequest(ordId: string, protocolType: 'staking' | 'defi'): Promise<any[]>;
+    /** Earn/staking get active orders */
+    getActiveStakingOrders(params?: {
+        productId?: string;
+        protocolType?: 'staking' | 'defi';
+        ccy?: string;
+        state?: '8' | '13' | '9' | '1' | '2';
+    }): Promise<any[]>;
+    /** Earn/staking get order history */
+    getStakingOrderHistory(params?: {
+        productId?: string;
+        protocolType?: string;
+        ccy?: string;
+        after?: string;
+        before?: string;
+        limit?: string;
+    }): Promise<any[]>;
+    /**
+     *
+     * FINANCIAL PRODUCT - ETH staking endpoints
+     *
+     */
+    purchaseETHStaking(params: {
+        amt: string;
+    }): Promise<any[]>;
+    redeemETHStaking(params: {
+        amt: string;
+    }): Promise<any[]>;
+    getETHStakingBalance(): Promise<any[]>;
+    getETHStakingHistory(params: {
+        type: 'purchase' | 'redeem';
+        status?: 'pending' | 'success' | 'failed';
+        after?: string;
+        before?: string;
+        limit?: string;
+    }): Promise<any[]>;
+    getAPYHistory(params: {
+        days: string;
+    }): Promise<any[]>;
+    /**
+     *
+     * Simple earn fixed endpoints
+     *
+     */
+    getLendingOffers(params?: {
+        ccy?: string;
+        term?: string;
+    }): Promise<any[]>;
+    getLendingAPYHistory(params: {
+        ccy: string;
+        term: string;
+    }): Promise<any[]>;
+    getLendingVolume(params: {
+        ccy: string;
+        term: string;
+    }): Promise<any[]>;
+    placeLendingOrder(params: LendingOrder): Promise<any[]>;
+    amendLendingOrder(params: LendingOrder): Promise<any[]>;
+    getLendingOrders(params: GetLendingOrderListRequest): Promise<any[]>;
+    getLendingSubOrders(params: GetLendingSubOrderListRequest): Promise<any[]>;
+    /**
+     *
+     * Signal bot trading endpoints
+     *
+     */
+    createSignal(params: CreateSignalRequest): Promise<CreateSignalResult[]>;
+    getSignals(params: GetSignalsRequest): Promise<GetSignalsResult[]>;
+    createSignalBot(params: CreateSignalBotRequest): Promise<CreateSignalBotResult[]>;
+    cancelSignalBots(params: {
+        algoId: string;
+    }): Promise<CancelSignalBotsResult[]>;
+    updateSignalMargin(params: AdjustMarginBalanceRequest): Promise<{
+        algoId: string;
+    }[]>;
+    updateSignalTPSL(params: AmendTPSLRequest): Promise<{
+        algoId: string;
+    }[]>;
+    setSignalInstruments(params: SetSignalInstrumentsRequest): Promise<{
+        algoId: string;
+    }[]>;
+    getSignalBotOrder(params: {
+        algoOrdType: string;
+        algoId: string;
+    }): Promise<any[]>;
+    getActiveSignalBot(params: GetSignalBotRequest): Promise<any[]>;
+    getSignalBotHistory(params: GetSignalBotRequest): Promise<any[]>;
+    getSignalBotPositions(params: {
+        algoOrdType: string;
+        algoId: string;
+    }): Promise<any[]>;
+    getSignalBotPositionHistory(params: GetSignalBotPositionHistoryRequest): Promise<any[]>;
+    closeSignalBotPosition(params: {
+        algoId: string;
+        instId: string;
+    }): Promise<{
+        algoId: string;
+    }[]>;
+    placeSignalBotSubOrder(params: PlaceSubOrderRequest): Promise<any[]>;
+    cancelSubOrder(params: CancelSubOrderRequest): Promise<any[]>;
+    getSignalBotSubOrders(params: GetSignalBotSubOrdersRequest): Promise<any[]>;
+    getSignalBotEventHistory(params: GetSignalBotEventHistoryRequest): Promise<any[]>;
+    /**
+     *
+     *  Recurring buy endpoints
+     *
+     */
+    submitRecurringBuyOrder(params: PlaceRecurringBuyOrderRequest): Promise<RecurringBuyOrderResult[]>;
+    amendRecurringBuyOrder(params: AmendRecurringBuyOrderRequest): Promise<RecurringBuyOrderResult[]>;
+    stopRecurringBuyOrder(params: {
+        algoId: string;
+    }): Promise<RecurringBuyOrderResult[]>;
+    getRecurringBuyOrders(params: GetRecurringBuyOrderListRequest): Promise<RecurringBuyOrder[]>;
+    getRecurringBuyOrderHistory(params: GetRecurringBuyOrderListRequest): Promise<RecurringBuyOrder[]>;
+    getRecurringBuyOrderDetails(params: {
+        algoId: string;
+    }): Promise<RecurringBuyOrder[]>;
+    getRecurringBuySubOrders(params: GetRecurringBuyOrderListRequest): Promise<RecurringBuySubOrder[]>;
+    /**
+     *
+     * Copy Trading endpoints
+     *
+     */
+    getCopytradingSubpositions(params?: GetCurrentSubpositionsRequest): Promise<CurrentSubposition[]>;
+    getCopytradingSubpositionsHistory(params?: GetSubpositionsHistoryRequest): Promise<SubpositionsHistory[]>;
+    submitCopytradingAlgoOrder(params: PlaceCTAlgoOrderRequest): Promise<PlaceCTAlgoOrderResult[]>;
+    closeCopytradingSubposition(params: CloseSubpositionRequest): Promise<{
+        subPosId: string;
+        tag: string;
+    }[]>;
+    getCopytradingInstruments(params?: {
+        instType?: 'SPOT' | 'SWAP';
+    }): Promise<{
+        instId: string;
+        enabled: boolean;
+    }[]>;
+    setCopytradingInstruments(params: {
+        instType?: 'SPOT' | 'SWAP';
+        instId: string;
+    }): Promise<{
+        instId: string;
+        enabled: boolean;
+    }[]>;
+    getCopytradingProfitDetails(params?: GetCTProfitDetailsRequest): Promise<GetCTProfitDetailsResult[]>;
+    getCopytradingTotalProfit(params?: {
+        instType?: 'SPOT' | 'SWAP';
+    }): Promise<GetCTTotalProfitResult[]>;
+    getCopytradingUnrealizedProfit(params?: {
+        instType?: 'SPOT' | 'SWAP';
+    }): Promise<GetCTUnrealizedProfitResult[]>;
+    getCopytradingTotalUnrealizedProfit(params?: {
+        instType?: 'SWAP';
+    }): Promise<{
+        instType?: 'SWAP';
+        instId: string;
+    }[]>;
+    applyCopytradingLeadTrading(params: {
+        profitSharingTs: string;
+        totalUnrealizedProfitSharingAmt: string;
+    }): Promise<{
+        result: boolean;
+    }[]>;
+    stopCopytradingLeadTrading(params: {
+        instType?: 'SWAP';
+    }): Promise<{
+        result: boolean;
+    }[]>;
+    updateCopytradingProfitSharing(params: {
+        instType?: 'SWAP';
+        profitSharingRatio: string;
+    }): Promise<{
+        result: boolean;
+    }[]>;
+    getCopytradingAccount(): Promise<GetAccountConfigurationResult[]>;
+    setCopytradingFirstCopy(params: CopySettingsRequest): Promise<{
+        result: boolean;
+    }[]>;
+    updateCopytradingCopySettings(params: CopySettingsRequest): Promise<{
+        result: boolean;
+    }[]>;
+    stopCopytradingCopy(params: {
+        instType?: 'SWAP';
+        uniqueCode: string;
+        subPosCloseType: 'market_close' | 'copy_close' | 'manual_close';
+    }): Promise<{
+        result: boolean;
+    }[]>;
+    getCopytradingCopySettings(params: {
+        instType?: 'SWAP';
+        uniqueCode: string;
+    }): Promise<GetCopySettingsResult[]>;
+    getCopytradingBatchLeverageInfo(params: GetCTBatchLeverageInfoRequest): Promise<GetCTBatchLeverageInfoResult[]>;
+    setCopytradingBatchLeverage(params: SetCTBatchLeverageRequest): Promise<SetCTBatchLeverageResult[]>;
+    getCopytradingMyLeadTraders(params?: {
+        instType?: 'SWAP';
+    }): Promise<GetCTMyLeadTradersResult[]>;
+    getCopytradingLeadTradersHistory(params?: GetCTHistoryLeadTradersRequest): Promise<GetCTHistoryLeadTradersResult[]>;
+    getCopytradingConfig(params?: {
+        instType?: 'SWAP';
+    }): Promise<GetCopyTradingConfigResult[]>;
+    getCopytradingLeadRanks(params?: GetLeadTraderRanksRequest): Promise<GetLeadTraderRanksResult[]>;
+    getCopytradingLeadWeeklyPnl(params: {
+        instType?: 'SWAP';
+        uniqueCode: string;
+    }): Promise<LeadTraderPnl[]>;
+    getCopytradingLeadDailyPnl(params: GetLeadTraderStatsRequest): Promise<LeadTraderPnl[]>;
+    getCopytradingLeadStats(params: GetLeadTraderStatsRequest): Promise<LeadTraderStats[]>;
+    getCopytradingLeadPreferences(params: {
+        instType?: 'SWAP';
+        uniqueCode: string;
+    }): Promise<LeadTraderPreference[]>;
+    getCopytradingLeadOpenPositions(params: GetLeadTraderPositionsRequest): Promise<LeadTraderCurrentPosition[]>;
+    getCopytradingLeadPositionHistory(params: GetLeadTraderPositionsRequest): Promise<LeadTraderPositionHistory[]>;
+    getCopyTraders(params: GetCopyTradersRequest): Promise<GetCopyTradersResult[]>;
+    getCopytradingLeadPrivateRanks(params?: GetPrivateLeadTraderRanksRequest): Promise<GetPrivateLeadTraderRanksResult[]>;
+    getCopytradingLeadPrivateWeeklyPnl(params: {
+        instType?: 'SWAP';
+        uniqueCode: string;
+    }): Promise<LeadTraderPnl[]>;
+    getCopytradingPLeadPrivateDailyPnl(params: GetLeadTraderStatsRequest): Promise<LeadTraderPnl[]>;
+    geCopytradingLeadPrivateStats(params: GetLeadTraderStatsRequest): Promise<LeadTraderStats[]>;
+    getCopytradingLeadPrivatePreferences(params: {
+        instType?: 'SWAP';
+        uniqueCode: string;
+    }): Promise<LeadTraderPreference[]>;
+    getCopytradingLeadPrivateOpenPositions(params: GetLeadTraderPositionsRequest): Promise<LeadTraderCurrentPosition[]>;
+    getCopytradingLeadPrivatePositionHistory(params: GetLeadTraderPositionsRequest): Promise<LeadTraderPositionHistory[]>;
+    getCopyTradersPrivate(params: GetCopyTradersRequest): Promise<GetCopyTradersResult[]>;
+    /**
+     *
+     * Spread trading endpoints
+     *
+     */
+    submitSpreadOrder(params: PlaceSpreadOrderRequest): Promise<PlaceSpreadOrderResponse[]>;
+    cancelSpreadOrder(params?: {
+        ordId?: string;
+        clOrdId?: string;
+    }): Promise<CancelSpreadOrderResponse[]>;
+    cancelAllSpreadOrders(params: {
+        sprdId?: string;
+    }): Promise<{
+        result: boolean;
+    }[]>;
+    updateSpreadOrder(params: UpdateSpreadOrderRequest): Promise<UpdateSpreadOrderResponse[]>;
+    getSpreadOrder(params: {
+        ordId?: string;
+        clOrdId?: string;
+    }): Promise<SpreadOrder[]>;
+    getSpreadActiveOrders(params?: GetActiveSpreadOrdersRequest): Promise<SpreadOrder[]>;
+    getSpreadOrdersRecent(params?: GetSpreadOrderHistoryRequest): Promise<SpreadOrder[]>;
+    getSpreadOrdersArchive(params?: GetSpreadOrderHistoryArchiveRequest): Promise<SpreadOrder[]>;
+    getSpreadTrades(params?: GetSpreadTradesRequest): Promise<SpreadTrade[]>;
+    getSpreads(params?: GetSpreadsRequest): Promise<SpreadDetails[]>;
+    getSpreadOrderBook(params: {
+        sprdId: string;
+        sz?: string;
+    }): Promise<SpreadOrderBook[]>;
+    getSpreadTicker(params: {
+        sprdId: string;
+    }): Promise<SpreadTicker[]>;
+    getSpreadPublicTrades(params?: {
+        sprdId?: string;
+    }): Promise<PublicSpreadTrade[]>;
+    getSpreadCandles(params: GetSpreadCandlesRequest): Promise<SpreadCandle[]>;
+    getSpreadHistoryCandles(params: GetSpreadCandlesRequest): Promise<SpreadCandle[]>;
+    cancelSpreadAllAfter(params: {
+        timeOut: string;
+    }): Promise<{
+        triggerTime: string;
+        ts: string;
+    }[]>;
+    /**
+     *
+     * Affiliate endpoints
+     *
+     */
+    getInviteeDetail(params: {
+        uid: string;
+    }): Promise<any[]>;
+    getAffiliateRebateInfo(params: {
+        apiKey: string;
+    }): Promise<any[]>;
     /**
      *
      * Status endpoints (public)
@@ -421,6 +898,10 @@ export declare class RestClient extends BaseRestClient {
      * Broker endpoints (private)
      *
      */
+    /**
+     *
+     * @deprecated
+     */
     getBrokerAccountInformation(): Promise<any[]>;
     createSubAccount(params: {
         subAcct: string;