okx-api 3.1.3 → 3.1.5

package/README.md

@@ -1,6 +1,7 @@
 # Node.js & Typescript OKX (OKEX) API & WebSocket SDK
 
 [![E2E Tests](https://github.com/tiagosiebler/okx-api/actions/workflows/e2etest.yml/badge.svg?branch=master)](https://github.com/tiagosiebler/okx-api/actions/workflows/e2etest.yml)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/tiagosiebler/okx-api)
 [![npm downloads](https://img.shields.io/npm/dt/okx-api)][1]
 [![npm version](https://img.shields.io/npm/v/okx-api)][1]
 [![npm size](https://img.shields.io/bundlephobia/min/okx-api/latest)][1]
@@ -43,6 +44,7 @@ Complete, updated & performant Node.js SDK for the OKX(OKEX) APIs and WebSockets
     - End to end types.
     - See [examples/ws-api-client.ts](./examples/ws-api-client.ts) for a demonstration.
 - Browser support (via webpack bundle - see "Browser Usage" below).
+- QuickStart Guide: https://siebly.io/sdk/okx/javascript
 
 ## Table of Contents
 

package/dist/cjs/index.d.ts

@@ -3,9 +3,11 @@ export * from './rest-client.js';
 export * from './types/rest/client.js';
 export * from './types/rest/shared.js';
 export * from './types/rest/request/account.js';
+export * from './types/rest/request/affiliate.js';
 export * from './types/rest/request/block-trading.js';
 export * from './types/rest/request/convert.js';
 export * from './types/rest/request/copy-trading.js';
+export * from './types/rest/request/dual-investment.js';
 export * from './types/rest/request/funding.js';
 export * from './types/rest/request/grid-trading.js';
 export * from './types/rest/request/public.js';
@@ -14,16 +16,20 @@ export * from './types/rest/request/shared.js';
 export * from './types/rest/request/signal-bot.js';
 export * from './types/rest/request/simple-earn.js';
 export * from './types/rest/request/spread-trading.js';
+export * from './types/rest/request/stable-rewards.js';
 export * from './types/rest/request/subaccount.js';
 export * from './types/rest/request/trade.js';
 export * from './types/rest/response/private-account.js';
+export * from './types/rest/response/private-affiliate.js';
 export * from './types/rest/response/private-block-trading.js';
 export * from './types/rest/response/private-copy-trading.js';
+export * from './types/rest/response/private-dual-investment.js';
 export * from './types/rest/response/private-flexible-loan.js';
 export * from './types/rest/response/private-funding.js';
 export * from './types/rest/response/private-recurring-buy.js';
 export * from './types/rest/response/private-signal-bot.js';
 export * from './types/rest/response/private-spread-trading.js';
+export * from './types/rest/response/private-stable-rewards.js';
 export * from './types/rest/response/private-subaccount.js';
 export * from './types/rest/response/private-trade.js';
 export * from './types/rest/response/public-data.js';

package/dist/cjs/index.js

@@ -21,9 +21,11 @@ __exportStar(require("./types/rest/client.js"), exports);
 __exportStar(require("./types/rest/shared.js"), exports);
 // REST/request
 __exportStar(require("./types/rest/request/account.js"), exports);
+__exportStar(require("./types/rest/request/affiliate.js"), exports);
 __exportStar(require("./types/rest/request/block-trading.js"), exports);
 __exportStar(require("./types/rest/request/convert.js"), exports);
 __exportStar(require("./types/rest/request/copy-trading.js"), exports);
+__exportStar(require("./types/rest/request/dual-investment.js"), exports);
 __exportStar(require("./types/rest/request/funding.js"), exports);
 __exportStar(require("./types/rest/request/grid-trading.js"), exports);
 __exportStar(require("./types/rest/request/public.js"), exports);
@@ -32,17 +34,21 @@ __exportStar(require("./types/rest/request/shared.js"), exports);
 __exportStar(require("./types/rest/request/signal-bot.js"), exports);
 __exportStar(require("./types/rest/request/simple-earn.js"), exports);
 __exportStar(require("./types/rest/request/spread-trading.js"), exports);
+__exportStar(require("./types/rest/request/stable-rewards.js"), exports);
 __exportStar(require("./types/rest/request/subaccount.js"), exports);
 __exportStar(require("./types/rest/request/trade.js"), exports);
 // REST/response
 __exportStar(require("./types/rest/response/private-account.js"), exports);
+__exportStar(require("./types/rest/response/private-affiliate.js"), exports);
 __exportStar(require("./types/rest/response/private-block-trading.js"), exports);
 __exportStar(require("./types/rest/response/private-copy-trading.js"), exports);
+__exportStar(require("./types/rest/response/private-dual-investment.js"), exports);
 __exportStar(require("./types/rest/response/private-flexible-loan.js"), exports);
 __exportStar(require("./types/rest/response/private-funding.js"), exports);
 __exportStar(require("./types/rest/response/private-recurring-buy.js"), exports);
 __exportStar(require("./types/rest/response/private-signal-bot.js"), exports);
 __exportStar(require("./types/rest/response/private-spread-trading.js"), exports);
+__exportStar(require("./types/rest/response/private-stable-rewards.js"), exports);
 __exportStar(require("./types/rest/response/private-subaccount.js"), exports);
 __exportStar(require("./types/rest/response/private-trade.js"), exports);
 __exportStar(require("./types/rest/response/public-data.js"), exports);

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAuC;AACvC,mDAAiC;AACjC,uBAAuB;AACvB,yDAAuC;AACvC,yDAAuC;AACvC,eAAe;AACf,kEAAgD;AAChD,wEAAsD;AACtD,kEAAgD;AAChD,uEAAqD;AACrD,kEAAgD;AAChD,uEAAqD;AACrD,iEAA+C;AAC/C,wEAAsD;AACtD,iEAA+C;AAC/C,qEAAmD;AACnD,sEAAoD;AACpD,yEAAuD;AACvD,qEAAmD;AACnD,gEAA8C;AAC9C,gBAAgB;AAChB,2EAAyD;AACzD,iFAA+D;AAC/D,gFAA8D;AAC9D,iFAA+D;AAC/D,2EAAyD;AACzD,iFAA+D;AAC/D,8EAA4D;AAC5D,kFAAgE;AAChE,8EAA4D;AAC5D,yEAAuD;AACvD,uEAAqD;AACrD,EAAE;AACF,oDAAkC;AAClC,+DAA6C;AAC7C,uEAAqD;AACrD,wEAAsD;AACtD,kEAAgD;AAChD,mEAAiD;AACjD,mEAAiD;AACjD,mDAAiC;AACjC,uDAAqC;AACrC,2DAAyC;AACzC,oDAAkC;AAClC,4DAA0C;AAC1C,wDAAsC;AACtC,+DAA6C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAuC;AACvC,mDAAiC;AACjC,uBAAuB;AACvB,yDAAuC;AACvC,yDAAuC;AACvC,eAAe;AACf,kEAAgD;AAChD,oEAAkD;AAClD,wEAAsD;AACtD,kEAAgD;AAChD,uEAAqD;AACrD,0EAAwD;AACxD,kEAAgD;AAChD,uEAAqD;AACrD,iEAA+C;AAC/C,wEAAsD;AACtD,iEAA+C;AAC/C,qEAAmD;AACnD,sEAAoD;AACpD,yEAAuD;AACvD,yEAAuD;AACvD,qEAAmD;AACnD,gEAA8C;AAC9C,gBAAgB;AAChB,2EAAyD;AACzD,6EAA2D;AAC3D,iFAA+D;AAC/D,gFAA8D;AAC9D,mFAAiE;AACjE,iFAA+D;AAC/D,2EAAyD;AACzD,iFAA+D;AAC/D,8EAA4D;AAC5D,kFAAgE;AAChE,kFAAgE;AAChE,8EAA4D;AAC5D,yEAAuD;AACvD,uEAAqD;AACrD,EAAE;AACF,oDAAkC;AAClC,+DAA6C;AAC7C,uEAAqD;AACrD,wEAAsD;AACtD,kEAAgD;AAChD,mEAAiD;AACjD,mEAAiD;AACjD,mDAAiC;AACjC,uDAAqC;AACrC,2DAAyC;AACzC,oDAAkC;AAClC,4DAA0C;AAC1C,wDAAsC;AACtC,+DAA6C"}

package/dist/cjs/rest-client.d.ts

@@ -1,29 +1,35 @@
 import { ASSET_BILL_TYPE } from './constants/funding.js';
-import { ChangePositionMarginRequest, GetBorrowRepayHistoryRequest, GetFixedLoanBorrowingOrdersListRequest, GetFixedLoanBorrowQuoteRequest, GetHistoricPositionParams, GetInstrumentsRequest, GetPositionsParams, GetQuickMarginBorrowRepayHistoryRequest, GetVIPInterestRequest, GetVIPLoanOrderDetailRequest, GetVIPLoanOrderListRequest, PositionBuilderRequest, PrecheckSetDeltaNeutralRequest, QuickMarginBorrowRepayRequest, SetFeeTypeRequest, SetLeverageRequest, SetMMPConfigRequest, SetSettleCurrencyRequest, SetTradingConfigRequest, SubmitFixedLoanBorrowingOrderRequest, UpdateFixedLoanBorrowingOrderRequest, WithdrawalHistoryRequest } from './types/rest/request/account.js';
+import { BillsHistoryArchiveRequest, ChangePositionMarginRequest, GetAccountBillSubtypesRequest, GetBorrowRepayHistoryRequest, GetFixedLoanBorrowingOrdersListRequest, GetFixedLoanBorrowQuoteRequest, GetHistoricPositionParams, GetInstrumentsRequest, GetPositionsParams, GetQuickMarginBorrowRepayHistoryRequest, GetVIPInterestRequest, GetVIPLoanOrderDetailRequest, GetVIPLoanOrderListRequest, PositionBuilderRequest, PrecheckSetDeltaNeutralRequest, QuickMarginBorrowRepayRequest, SetFeeTypeRequest, SetLeverageRequest, SetMMPConfigRequest, SetSettleCurrencyRequest, SetTradingConfigRequest, SubmitFixedLoanBorrowingOrderRequest, UpdateFixedLoanBorrowingOrderRequest, WithdrawalHistoryRequest } from './types/rest/request/account.js';
+import { GetAffiliateCoInviterLinkListRequest, GetAffiliateInviteeListRequest, GetAffiliateLinkListRequest, GetAffiliatePerformanceSummaryRequest, GetAffiliateSubAffiliateListRequest, GetInviteeDetailRequest } from './types/rest/request/affiliate.js';
 import { CancelBlockQuoteRequest, CancelBlockRFQRequest, CancelMultipleBlockQuoteRequest, CancelMultipleBlockRFQRequest, CreateBlockQuoteRequest, CreateBlockRFQRequest, ExecuteBlockQuoteRequest, GetBlockQuoteParams, GetBlockRFQSParams, SetMmpConfigRequest, SetQuoteProductsRequest } from './types/rest/request/block-trading.js';
 import { ConvertQuoteEstimateRequest, ConvertTradeRequest } from './types/rest/request/convert.js';
 import { CloseSubpositionRequest, CopySettingsRequest, GetCopyTradersRequest, GetCTBatchLeverageInfoRequest, GetCTHistoryLeadTradersRequest, GetCTProfitDetailsRequest, GetCurrentSubpositionsRequest, GetLeadTraderPositionsRequest, GetLeadTraderRanksRequest, GetLeadTraderStatsRequest, GetPrivateLeadTraderRanksRequest, GetSubpositionsHistoryRequest, PlaceCTAlgoOrderRequest, SetCTBatchLeverageRequest } from './types/rest/request/copy-trading.js';
-import { FundingRateRequest, FundsTransferRequest, GetDepositHistoryRequest, GetDepositWithdrawStatusRequest, WithdrawRequest } from './types/rest/request/funding.js';
+import { GetDcdOrderHistoryRequest, GetDcdOrderStatusRequest, GetDcdProductsRequest, RequestDcdQuoteRequest, RequestDcdRedeemQuoteRequest, SubmitDcdRedeemRequest, SubmitDcdTradeRequest } from './types/rest/request/dual-investment.js';
+import { FundingRateRequest, FundsTransferRequest, GetDepositHistoryRequest, GetDepositWithdrawStatusRequest, GetFundingRateRequest, WithdrawRequest } from './types/rest/request/funding.js';
 import { CloseContractGridPositionRequest, GetGridAlgoOrdersRequest, GetRSIBackTestingRequest, GridAlgoOrderRequest, GridAlgoOrderType, MaxGridQuantityRequest, StopGridAlgoOrderRequest } from './types/rest/request/grid-trading.js';
-import { CandleRequest, EconomicCalendarRequest, GetContractOpenInterestHistoryRequest, GetContractTakerVolumeRequest, GetOptionTradesRequest, GetPremiumHistoryRequest, GetTopTradersContractLongShortRatioRequest, UnitConvertRequest } from './types/rest/request/public.js';
+import { CandleRequest, EconomicCalendarRequest, GetContractOpenInterestHistoryRequest, GetContractTakerVolumeRequest, GetEventContractEventsRequest, GetEventContractMarketsRequest, GetEventContractSeriesRequest, GetHistoricalMarketDataRequest, GetOptionTradesRequest, GetPremiumHistoryRequest, GetTopTradersContractLongShortRatioRequest, UnitConvertRequest } from './types/rest/request/public.js';
 import { AmendRecurringBuyOrderRequest, GetRecurringBuyOrderListRequest, PlaceRecurringBuyOrderRequest } from './types/rest/request/recurring-buy.js';
 import { PaginatedSymbolRequest } from './types/rest/request/shared.js';
 import { AdjustMarginBalanceRequest, AmendTPSLRequest, CancelSubOrderRequest, CreateSignalBotRequest, CreateSignalRequest, GetSignalBotEventHistoryRequest, GetSignalBotPositionHistoryRequest, GetSignalBotRequest, GetSignalBotSubOrdersRequest, GetSignalsRequest, PlaceSubOrderRequest, SetSignalInstrumentsRequest } from './types/rest/request/signal-bot.js';
 import { GetLendingOrderListRequest, GetLendingSubOrderListRequest, LendingOrder } from './types/rest/request/simple-earn.js';
 import { GetActiveSpreadOrdersRequest, GetSpreadCandlesRequest, GetSpreadOrderHistoryArchiveRequest, GetSpreadOrderHistoryRequest, GetSpreadsRequest, GetSpreadTradesRequest, PlaceSpreadOrderRequest, UpdateSpreadOrderRequest } from './types/rest/request/spread-trading.js';
+import { GetStableRewardsApyHistoryRequest, GetStableRewardsBalanceRequest, GetStableRewardsProductInfoRequest, GetStableRewardsSubscribeRedeemHistoryRequest, RequestStableRewardsQuoteRequest, SubmitStableRewardsTradeRequest } from './types/rest/request/stable-rewards.js';
 import { GetManagedSubAccountTransferHistoryRequest, GetSubAccountMaxWithdrawalsRequest, SetSubAccountLoanAllocationRequest, SubAccountTransferRequest } from './types/rest/request/subaccount.js';
 import { AlgoLongHistoryRequest, AlgoOrderDetailsRequest, AlgoOrderRequest, AlgoRecentHistoryRequest, AmendAlgoOrderRequest, AmendOrderRequest, CancelAlgoOrderRequest, ClosePositionRequest, FillsHistoryRequest, OrderHistoryRequest, OrderIdRequest, OrderPrecheckRequest, OrderRequest } from './types/rest/request/trade.js';
-import { AccountBalance, AccountBill, AccountChangeMarginResult, AccountConfiguration, AccountFeeRate, AccountHistoryBill, AccountInstrument, AccountIsolatedMode, AccountLeverage, AccountLeverageResult, AccountMaxLoan, AccountMaxOrderAmount, AccountMaxTradableAmount, AccountModeResult, AccountPosition, AccountPositionModeResult, AccountPositionRisk, AccountRiskState, AdjustLeverageInfo, AutoLoanResult, BorrowRepayHistoryItem, FixedLoanBorrowingLimit, FixedLoanBorrowQuote, Greeks, HistoricAccountPosition, InterestAccrued, InterestRate, MaxWithdrawal, MMPConfig, PrecheckSetDeltaNeutralResult, QuickMarginBorrowRepayRecord, QuickMarginBorrowRepayResult, SetFeeTypeResult, SetMMPConfigResult, SetSettleCurrencyResult, SetTradingConfigResult, VIPInterest, VIPLoanOrder, VIPLoanOrderDetail } from './types/rest/response/private-account.js';
+import { AccountBalance, AccountBill, AccountBillTypeDefinition, AccountChangeMarginResult, AccountConfiguration, AccountFeeRate, AccountHistoryBill, AccountInstrument, AccountIsolatedMode, AccountLeverage, AccountLeverageResult, AccountMaxLoan, AccountMaxOrderAmount, AccountMaxTradableAmount, AccountModeResult, AccountPosition, AccountPositionModeResult, AccountPositionRisk, AccountRiskState, AdjustLeverageInfo, AutoLoanResult, BorrowRepayHistoryItem, FixedLoanBorrowingLimit, FixedLoanBorrowQuote, Greeks, HistoricAccountPosition, InterestAccrued, InterestRate, MaxWithdrawal, MMPConfig, PrecheckSetDeltaNeutralResult, QuickMarginBorrowRepayRecord, QuickMarginBorrowRepayResult, SetFeeTypeResult, SetMMPConfigResult, SetSettleCurrencyResult, SetTradingConfigResult, VIPInterest, VIPLoanOrder, VIPLoanOrderDetail } from './types/rest/response/private-account.js';
+import { AffiliateCoInviterLinkListItem, AffiliateInviteeListItem, AffiliateLinkListItem, AffiliatePerformanceSummary, AffiliateSubAffiliateListItem, InviteeDetail } from './types/rest/response/private-affiliate.js';
 import { BlockCounterParty, BlockMakerInstrumentSettings, BlockMMPConfig, BlockRFQResult, BlockTradeResult, CancelBlockQuoteResult, CancelBlockRFQResult, CreateBlockQuoteResult, CreateRFQResult, ExecuteBlockQuoteResult, GetBlockQuoteResult, PublicBlockTrade, SetMmpConfigResult } from './types/rest/response/private-block-trading.js';
 import { CurrentSubposition, GetAccountConfigurationResult, GetCopySettingsResult, GetCopyTradersResult, GetCopyTradingConfigResult, GetCTBatchLeverageInfoResult, GetCTHistoryLeadTradersResult, GetCTMyLeadTradersResult, GetCTProfitDetailsResult, GetCTTotalProfitResult, GetCTUnrealizedProfitResult, GetLeadTraderRanksResult, GetPrivateLeadTraderRanksResult, LeadTraderCurrentPosition, LeadTraderPnl, LeadTraderPositionHistory, LeadTraderPreference, LeadTraderStats, PlaceCTAlgoOrderResult, SetCTBatchLeverageResult, SubpositionsHistory } from './types/rest/response/private-copy-trading.js';
-import { AccruedInterestItem, AccruedInterestRequest, AdjustCollateralRequest, CollateralAssetsResponse, LoanHistoryItem, LoanHistoryRequest, LoanInfo, MaxLoanRequest, MaxLoanResponse } from './types/rest/response/private-flexible-loan.js';
+import { DcdCurrencyPair, DcdOrderHistoryItem, DcdOrderStatus, DcdProduct, DcdQuote, DcdRedeemQuote, DcdRedeemResult, DcdTradeResult } from './types/rest/response/private-dual-investment.js';
+import { AccruedInterestItem, AccruedInterestRequest, AdjustCollateralRequest, CollateralAssetsResponse, GetFlexibleLoanCollateralAssetsRequest, GetLoanInfoRequest, LoanHistoryItem, LoanHistoryRequest, LoanInfo, MaxLoanRequest, MaxLoanResponse } from './types/rest/response/private-flexible-loan.js';
 import { AccountAssetValuation, AssetBillDetails, DepositHistory, FundingBalance, FundingCurrency, FundTransferResult, FundTransferState, NonTradableAsset, WithdrawResponse } from './types/rest/response/private-funding.js';
 import { RecurringBuyOrder, RecurringBuyOrderResult, RecurringBuySubOrder } from './types/rest/response/private-recurring-buy.js';
 import { CancelSignalBotsResult, CreateSignalBotResult, CreateSignalResult, GetSignalsResult } from './types/rest/response/private-signal-bot.js';
 import { CancelSpreadOrderResponse, PlaceSpreadOrderResponse, PublicSpreadTrade, SpreadCandle, SpreadDetails, SpreadOrder, SpreadOrderBook, SpreadTicker, SpreadTrade, UpdateSpreadOrderResponse } from './types/rest/response/private-spread-trading.js';
+import { StableRewardsApyHistoryItem, StableRewardsBalance, StableRewardsProductInfo, StableRewardsQuote, StableRewardsSubscribeRedeemHistoryItem, StableRewardsTradeResult } from './types/rest/response/private-stable-rewards.js';
 import { ManagedSubAccountTransfer, SubAccount, SubAccountAPIReset, SubAccountBalances, SubAccountMaxWithdrawal, SubAccountTransferResult } from './types/rest/response/private-subaccount.js';
 import { AlgoOrderDetailsResult, AlgoOrderListItem, AlgoOrderResult, AmendAlgoOrderResult, AmendedOrder, CancelAllAfterResponse, CancelledOrderResult, ClosedPositions, HistoricAlgoOrder, HistoricOrder, OrderDetails, OrderFill, OrderListItem, OrderResult } from './types/rest/response/private-trade.js';
-import { Announcement, Candle, CandleNoVolume, EconomicCalendarData, IndexTicker, Instrument, InterestRateAndLoanQuota, OptionTrade, OptionTrades, OrderBook, PublicBorrowHistoryRecord, SystemTime, Ticker, Trade, UnitConvertData } from './types/rest/response/public-data.js';
+import { Announcement, Candle, CandleNoVolume, EconomicCalendarData, EstimatedDeliveryExercisePrice, EthStakingProductInfo, EventContractEvent, EventContractMarket, EventContractSeries, FundingRateHistory, IndexTicker, Instrument, InterestRateAndLoanQuota, MarketDataHistoryResult, OptionTrade, OptionTrades, OrderBook, PublicBorrowHistoryRecord, PublicFundingRate, SolStakingProductInfo, SystemTime, Ticker, Trade, UnitConvertData } from './types/rest/response/public-data.js';
 import { AccountLevel, APIResponse, ContractGridDirection, GridAlgoSubOrderType, InstrumentType, MarginMode, numberInString, Pagination, PositionSide, PosMode, TimestampObject } from './types/rest/shared.js';
 import BaseRestClient from './util/BaseRestClient.js';
 export declare class RestClient extends BaseRestClient {
@@ -64,26 +70,24 @@ export declare class RestClient extends BaseRestClient {
     getBills(params?: any): Promise<AccountBill[]>;
     /** Last 3 months */
     getBillsArchive(params?: any): Promise<AccountBill[]>;
+    /**
+     * Bill type ids and subTypes (unified account bill CSV columns reference `type` / `subType`).
+     * @see GET /api/v5/account/subtypes
+     */
+    getAccountBillSubtypes(params?: GetAccountBillSubtypesRequest): Promise<AccountBillTypeDefinition[]>;
     /**
      * Apply for bill data since 1 February, 2021 except for the current quarter.
-     * Check the file link from the "Get bills details (since 2021)" endpoint in 30 hours to allow for data generation.
-     * During peak demand, data generation may take longer. If the file link is still unavailable after 48 hours, reach out to customer support for assistance.
+     * Check the "Get bills details (since 2021)" endpoint in about 2 hours for the download link; in peak load it may take longer, and if still missing after 3 hours contact support.
      * It is only applicable to the data from the unified account.
      *
      * This endpoint submits a request for bill data. You can then use getRequestedBillsHistoryLink to get the link to the bill data.
      * It may take some time to generate the data.
      */
-    requestBillsHistoryDownloadLink(params: {
-        year: string;
-        quarter: 'Q1' | 'Q2' | 'Q3' | 'Q4';
-    }): Promise<AccountHistoryBill[]>;
+    requestBillsHistoryDownloadLink(params: BillsHistoryArchiveRequest): Promise<AccountHistoryBill[]>;
     /**
      * This endpoint returns the link to the bill data which you can request using requestBillsHistoryDownloadLink.
      */
-    getRequestedBillsHistoryLink(params: {
-        year: string;
-        quarter: 'Q1' | 'Q2' | 'Q3' | 'Q4';
-    }): Promise<AccountHistoryBill[]>;
+    getRequestedBillsHistoryLink(params: BillsHistoryArchiveRequest): Promise<AccountHistoryBill[]>;
     getAccountConfiguration(): Promise<AccountConfiguration[]>;
     setPositionMode(params: {
         posMode: PosMode;
@@ -99,6 +103,8 @@ export declare class RestClient extends BaseRestClient {
         px?: string;
         leverage?: string;
         unSpotOffset?: boolean;
+        /** EVENTS: `yes` / `no` (required for max size when applicable). */
+        outcome?: string;
     }): Promise<AccountMaxOrderAmount[]>;
     getMaxAvailableTradableAmount(params: {
         instId: string;
@@ -776,21 +782,38 @@ export declare class RestClient extends BaseRestClient {
      * Public data - rest endpoints
      *
      */
-    getInstruments(params: {
-        instType: InstrumentType;
-        uly?: string;
-        instFamily?: string;
-        instId?: string;
-    }): Promise<Instrument[]>;
+    getInstruments(params: GetInstrumentsRequest): Promise<Instrument[]>;
+    /**
+     * Prediction / event contract series. Auth required (read).
+     * @see GET /api/v5/public/event-contract/series
+     */
+    getEventContractSeries(params?: GetEventContractSeriesRequest): Promise<EventContractSeries[]>;
+    /**
+     * Events for a series. Auth required (read).
+     * @see GET /api/v5/public/event-contract/events
+     */
+    getEventContractEvents(params: GetEventContractEventsRequest): Promise<EventContractEvent[]>;
+    /**
+     * Markets for events. Auth required (read).
+     * @see GET /api/v5/public/event-contract/markets
+     */
+    getEventContractMarkets(params: GetEventContractMarketsRequest): Promise<EventContractMarket[]>;
     getDeliveryExerciseHistory(params: any): Promise<any[]>;
     getOpenInterest(params: any): Promise<any[]>;
-    getFundingRate(params: any): Promise<any[]>;
-    getFundingRateHistory(params: FundingRateRequest): Promise<any[]>;
+    getFundingRate(params: GetFundingRateRequest): Promise<PublicFundingRate[]>;
+    getFundingRateHistory(params: FundingRateRequest): Promise<FundingRateHistory[]>;
     getMinMaxLimitPrice(params: any): Promise<any[]>;
     getOptionMarketData(params: any): Promise<any[]>;
-    getEstimatedDeliveryExercisePrice(params: any): Promise<any[]>;
+    /**
+     * Estimated delivery or exercise price (FUTURES / OPTION / EVENTS; REST returns one row with `settlePx`).
+     * The value is only meaningful shortly before delivery/exercise. The window used for the index mean is 30 minutes (since 2026-03-18; 200ms sampling).
+     */
+    getEstimatedDeliveryExercisePrice(params: {
+        instId: string;
+    }): Promise<EstimatedDeliveryExercisePrice[]>;
     getDiscountRateAndInterestFreeQuota(params: any): Promise<any[]>;
     getSystemTime(params: any): Promise<SystemTime[]>;
+    getHistoricalMarketData(params: GetHistoricalMarketDataRequest): Promise<MarketDataHistoryResult[]>;
     getMarkPrice(params: any): Promise<any[]>;
     getPositionTiers(params: any): Promise<any[]>;
     getInterestRateAndLoanQuota(): Promise<InterestRateAndLoanQuota[]>;
@@ -908,6 +931,8 @@ export declare class RestClient extends BaseRestClient {
         ccy?: string;
         type?: `${ASSET_BILL_TYPE}`;
         clientId?: string;
+        /** Third-party custody type. Defaults to 1 (Copper) if not specified. */
+        thirdPartyType?: '1' | '2' | '5' | '6';
         after?: numberInString;
         before?: numberInString;
         limit?: numberInString;
@@ -1064,7 +1089,8 @@ export declare class RestClient extends BaseRestClient {
      * Financial product - ETH staking endpoints
      *
      */
-    getETHStakingProductInfo(): Promise<any[]>;
+    getETHStakingProductInfo(): Promise<EthStakingProductInfo[]>;
+    getSOLStakingProductInfo(): Promise<SolStakingProductInfo>;
     purchaseETHStaking(params: {
         amt: string;
     }): Promise<any[]>;
@@ -1139,22 +1165,50 @@ export declare class RestClient extends BaseRestClient {
     getBorrowableCurrencies(): Promise<{
         borrowCcy: string;
     }[]>;
-    getCollateralAssets(params?: {
-        ccy?: string;
-    }): Promise<CollateralAssetsResponse[]>;
+    getCollateralAssets(params?: GetFlexibleLoanCollateralAssetsRequest): Promise<CollateralAssetsResponse[]>;
     getMaxLoanAmount(params: MaxLoanRequest): Promise<MaxLoanResponse[]>;
     adjustCollateral(params: AdjustCollateralRequest): Promise<[]>;
-    getLoanInfo(): Promise<LoanInfo[]>;
+    getLoanInfo(params?: GetLoanInfoRequest): Promise<LoanInfo[]>;
     getLoanHistory(params?: LoanHistoryRequest): Promise<LoanHistoryItem[]>;
     getAccruedInterest(params?: AccruedInterestRequest): Promise<AccruedInterestItem[]>;
+    /**
+     *
+     * Financial product — dual investment (DCD) endpoints
+     * @see https://www.okx.com/docs-v5/en/ (2026-03-13 release)
+     *
+     */
+    getDcdCurrencyPairs(): Promise<DcdCurrencyPair[]>;
+    getDcdProducts(params: GetDcdProductsRequest): Promise<DcdProduct[]>;
+    requestDcdQuote(params: RequestDcdQuoteRequest): Promise<DcdQuote[]>;
+    submitDcdTrade(params: SubmitDcdTradeRequest): Promise<DcdTradeResult[]>;
+    requestDcdRedeemQuote(params: RequestDcdRedeemQuoteRequest): Promise<DcdRedeemQuote[]>;
+    submitDcdRedeem(params: SubmitDcdRedeemRequest): Promise<DcdRedeemResult[]>;
+    getDcdOrderStatus(params: GetDcdOrderStatusRequest): Promise<DcdOrderStatus[]>;
+    getDcdOrderHistory(params?: GetDcdOrderHistoryRequest): Promise<DcdOrderHistoryItem[]>;
+    /**
+     *
+     * Financial product — stable rewards endpoints
+     * @see https://www.okx.com/docs-v5/en/ (2026-04-24 release)
+     *
+     */
+    getStableRewardsProductInfo(params: GetStableRewardsProductInfoRequest): Promise<StableRewardsProductInfo[]>;
+    requestStableRewardsQuote(params: RequestStableRewardsQuoteRequest): Promise<StableRewardsQuote[]>;
+    submitStableRewardsTrade(params: SubmitStableRewardsTradeRequest): Promise<StableRewardsTradeResult[]>;
+    getStableRewardsBalance(params?: GetStableRewardsBalanceRequest): Promise<StableRewardsBalance[]>;
+    getStableRewardsApyHistory(params: GetStableRewardsApyHistoryRequest): Promise<StableRewardsApyHistoryItem[]>;
+    getStableRewardsSubscribeRedeemHistory(params: GetStableRewardsSubscribeRedeemHistoryRequest): Promise<StableRewardsSubscribeRedeemHistoryItem[]>;
     /**
      *
      * Affiliate endpoints
+     * @see https://www.okx.com/docs-v5/en/ (2026-05-08 release)
      *
      */
-    getInviteeDetail(params: {
-        uid: string;
-    }): Promise<any[]>;
+    getAffiliatePerformanceSummary(params?: GetAffiliatePerformanceSummaryRequest): Promise<AffiliatePerformanceSummary[]>;
+    getInviteeDetail(params: GetInviteeDetailRequest): Promise<InviteeDetail[]>;
+    getAffiliateInviteeList(params?: GetAffiliateInviteeListRequest): Promise<AffiliateInviteeListItem[]>;
+    getAffiliateLinkList(params?: GetAffiliateLinkListRequest): Promise<AffiliateLinkListItem[]>;
+    getAffiliateCoInviterLinkList(params?: GetAffiliateCoInviterLinkListRequest): Promise<AffiliateCoInviterLinkListItem[]>;
+    getAffiliateSubAffiliateList(params?: GetAffiliateSubAffiliateListRequest): Promise<AffiliateSubAffiliateListItem[]>;
     getAffiliateRebateInfo(params: {
         apiKey: string;
     }): Promise<any[]>;

package/dist/cjs/rest-client.js

@@ -97,10 +97,16 @@ class RestClient extends BaseRestClient_js_1.default {
     getBillsArchive(params) {
         return this.getPrivate('/api/v5/account/bills-archive', params);
     }
+    /**
+     * Bill type ids and subTypes (unified account bill CSV columns reference `type` / `subType`).
+     * @see GET /api/v5/account/subtypes
+     */
+    getAccountBillSubtypes(params) {
+        return this.getPrivate('/api/v5/account/subtypes', params);
+    }
     /**
      * Apply for bill data since 1 February, 2021 except for the current quarter.
-     * Check the file link from the "Get bills details (since 2021)" endpoint in 30 hours to allow for data generation.
-     * During peak demand, data generation may take longer. If the file link is still unavailable after 48 hours, reach out to customer support for assistance.
+     * Check the "Get bills details (since 2021)" endpoint in about 2 hours for the download link; in peak load it may take longer, and if still missing after 3 hours contact support.
      * It is only applicable to the data from the unified account.
      *
      * This endpoint submits a request for bill data. You can then use getRequestedBillsHistoryLink to get the link to the bill data.
@@ -864,6 +870,27 @@ class RestClient extends BaseRestClient_js_1.default {
     getInstruments(params) {
         return this.get('/api/v5/public/instruments', params);
     }
+    /**
+     * Prediction / event contract series. Auth required (read).
+     * @see GET /api/v5/public/event-contract/series
+     */
+    getEventContractSeries(params) {
+        return this.getPrivate('/api/v5/public/event-contract/series', params);
+    }
+    /**
+     * Events for a series. Auth required (read).
+     * @see GET /api/v5/public/event-contract/events
+     */
+    getEventContractEvents(params) {
+        return this.getPrivate('/api/v5/public/event-contract/events', params);
+    }
+    /**
+     * Markets for events. Auth required (read).
+     * @see GET /api/v5/public/event-contract/markets
+     */
+    getEventContractMarkets(params) {
+        return this.getPrivate('/api/v5/public/event-contract/markets', params);
+    }
     getDeliveryExerciseHistory(params) {
         return this.get('/api/v5/public/delivery-exercise-history', params);
     }
@@ -882,6 +909,10 @@ class RestClient extends BaseRestClient_js_1.default {
     getOptionMarketData(params) {
         return this.get('/api/v5/public/opt-summary', params);
     }
+    /**
+     * Estimated delivery or exercise price (FUTURES / OPTION / EVENTS; REST returns one row with `settlePx`).
+     * The value is only meaningful shortly before delivery/exercise. The window used for the index mean is 30 minutes (since 2026-03-18; 200ms sampling).
+     */
     getEstimatedDeliveryExercisePrice(params) {
         return this.get('/api/v5/public/estimated-price', params);
     }
@@ -891,6 +922,9 @@ class RestClient extends BaseRestClient_js_1.default {
     getSystemTime(params) {
         return this.get('/api/v5/public/time', params);
     }
+    getHistoricalMarketData(params) {
+        return this.get('/api/v5/public/market-data-history', params);
+    }
     getMarkPrice(params) {
         return this.get('/api/v5/public/mark-price', params);
     }
@@ -1166,6 +1200,9 @@ class RestClient extends BaseRestClient_js_1.default {
     getETHStakingProductInfo() {
         return this.get('/api/v5/finance/staking-defi/eth/product-info');
     }
+    getSOLStakingProductInfo() {
+        return this.get('/api/v5/finance/staking-defi/sol/product-info');
+    }
     purchaseETHStaking(params) {
         return this.postPrivate('/api/v5/finance/staking-defi/eth/purchase', params);
     }
@@ -1250,8 +1287,8 @@ class RestClient extends BaseRestClient_js_1.default {
     adjustCollateral(params) {
         return this.postPrivate('/api/v5/finance/flexible-loan/adjust-collateral', params);
     }
-    getLoanInfo() {
-        return this.getPrivate('/api/v5/finance/flexible-loan/loan-info');
+    getLoanInfo(params) {
+        return this.getPrivate('/api/v5/finance/flexible-loan/loan-info', params);
     }
     getLoanHistory(params) {
         return this.getPrivate('/api/v5/finance/flexible-loan/loan-history', params);
@@ -1259,14 +1296,84 @@ class RestClient extends BaseRestClient_js_1.default {
     getAccruedInterest(params) {
         return this.getPrivate('/api/v5/finance/flexible-loan/interest-accrued', params);
     }
+    /**
+     *
+     * Financial product — dual investment (DCD) endpoints
+     * @see https://www.okx.com/docs-v5/en/ (2026-03-13 release)
+     *
+     */
+    getDcdCurrencyPairs() {
+        return this.getPrivate('/api/v5/finance/sfp/dcd/currency-pair');
+    }
+    getDcdProducts(params) {
+        return this.getPrivate('/api/v5/finance/sfp/dcd/products', params);
+    }
+    requestDcdQuote(params) {
+        return this.postPrivate('/api/v5/finance/sfp/dcd/quote', params);
+    }
+    submitDcdTrade(params) {
+        return this.postPrivate('/api/v5/finance/sfp/dcd/trade', params);
+    }
+    requestDcdRedeemQuote(params) {
+        return this.postPrivate('/api/v5/finance/sfp/dcd/redeem-quote', params);
+    }
+    submitDcdRedeem(params) {
+        return this.postPrivate('/api/v5/finance/sfp/dcd/redeem', params);
+    }
+    getDcdOrderStatus(params) {
+        return this.getPrivate('/api/v5/finance/sfp/dcd/order-status', params);
+    }
+    getDcdOrderHistory(params) {
+        return this.getPrivate('/api/v5/finance/sfp/dcd/order-history', params);
+    }
+    /**
+     *
+     * Financial product — stable rewards endpoints
+     * @see https://www.okx.com/docs-v5/en/ (2026-04-24 release)
+     *
+     */
+    getStableRewardsProductInfo(params) {
+        return this.getPrivate('/api/v5/finance/stable-rewards/product-info', params);
+    }
+    requestStableRewardsQuote(params) {
+        return this.postPrivate('/api/v5/finance/stable-rewards/quote', params);
+    }
+    submitStableRewardsTrade(params) {
+        return this.postPrivate('/api/v5/finance/stable-rewards/trade', params);
+    }
+    getStableRewardsBalance(params) {
+        return this.getPrivate('/api/v5/finance/stable-rewards/balance', params);
+    }
+    getStableRewardsApyHistory(params) {
+        return this.get('/api/v5/finance/stable-rewards/apy-history', params);
+    }
+    getStableRewardsSubscribeRedeemHistory(params) {
+        return this.getPrivate('/api/v5/finance/stable-rewards/subscribe-redeem-history', params);
+    }
     /**
      *
      * Affiliate endpoints
+     * @see https://www.okx.com/docs-v5/en/ (2026-05-08 release)
      *
      */
+    getAffiliatePerformanceSummary(params) {
+        return this.getPrivate('/api/v5/affiliate/performance/summary', params);
+    }
     getInviteeDetail(params) {
         return this.getPrivate('/api/v5/affiliate/invitee/detail', params);
     }
+    getAffiliateInviteeList(params) {
+        return this.getPrivate('/api/v5/affiliate/invitee/list', params);
+    }
+    getAffiliateLinkList(params) {
+        return this.getPrivate('/api/v5/affiliate/link/list', params);
+    }
+    getAffiliateCoInviterLinkList(params) {
+        return this.getPrivate('/api/v5/affiliate/co-inviter/list', params);
+    }
+    getAffiliateSubAffiliateList(params) {
+        return this.getPrivate('/api/v5/affiliate/sub-affiliate/list', params);
+    }
     getAffiliateRebateInfo(params) {
         return this.getPrivate('/api/v5/users/partner/if-rebate', params);
     }