OKX API reference
Enumerations
Classes
Interfaces
- AccountAllocation
- AccountAllocationExecutionResult
- AccountAllocationLeg
- AccountAllocationLegExecutionResult
- AccountAllocationLegResult
- AccountAllocationResult
- AccountAllocationTradeLegResult
- AccountAllocationTradeResult
- AccountAssetValuation
- AccountBalance
- AccountBalanceDetail
- AccountBalanceRiskData
- AccountBill
- AccountBillTypeDefinition
- AccountChangeMarginResult
- AccountConfiguration
- AccountConfigurationDetails
- AccountFeeRate
- AccountHistoryBill
- AccountInstrument
- AccountIsolatedMode
- AccountLeverage
- AccountLeverageResult
- AccountMaxLoan
- AccountMaxOrderAmount
- AccountMaxTradableAmount
- AccountModeResult
- AccountPosition
- AccountPositionModeResult
- AccountPositionRisk
- AccountPositionRiskData
- AccountRiskState
- AccruedInterestItem
- AccruedInterestRequest
- ActivateFeatureRequest
- AdjustCollateralRequest
- AdjustLeverageInfo
- AdjustMarginBalanceRequest
- AdvChaseAmendParams
- AdvChaseParams
- AlgoLongHistoryRequest
- AlgoOrderDetailsResult
- AlgoOrderListItem
- AlgoOrderRequest
- AlgoOrderResult
- AlgoRecentHistoryRequest
- AmendAlgoOrderRequest
- AmendAlgoOrderResult
- AmendAttachedTrailingStop
- AmendedOrder
- AmendOrderRequest
- AmendRecurringBuyOrderRequest
- AmendTPSLRequest
- Announcement
- APICredentials
- APIResponse
- AssetBillDetails
- AttachAlgoOrderDetail
- AttachAlgoOrdRequest
- AutoLoanResult
- BasicInterestRate
- BillsHistoryArchiveRequest
- BillSubTypeDetail
- BlockCounterParty
- BlockMakerInstrumentData
- BlockMakerInstrumentSettings
- BlockMMPConfig
- BlockQuoteLeg
- BlockRFQResult
- BlockTradeLeg
- BlockTradeResult
- BorrowRepayHistoryItem
- CancelAlgoOrderRequest
- CancelAllAfterResponse
- CancelBlockQuoteRequest
- CancelBlockQuoteResult
- CancelBlockRFQRequest
- CancelBlockRFQResult
- CancelledOrderResult
- CancelMultipleBlockQuoteRequest
- CancelMultipleBlockRFQRequest
- CancelSignalBotsResult
- CancelSpreadOrderResponse
- CancelSubOrderRequest
- CandleRequest
- ChangePositionMarginRequest
- CloseContractGridPositionRequest
- ClosedPositions
- ClosePositionRequest
- CloseSubpositionRequest
- CollateralAsset
- CollateralAssetsResponse
- ConfigCcyItem
- ConvertQuoteEstimateRequest
- ConvertTradeRequest
- CopySettingsInstId
- CopySettingsRequest
- CopyTraderInfo
- CreateBlockQuoteLeg
- CreateBlockQuoteRequest
- CreateBlockQuoteResult
- CreateBlockRFQRequest
- CreatedBlockQuoteLeg
- CreateRFQResult
- CreateSignalBotRequest
- CreateSignalBotResult
- CreateSignalRequest
- CreateSignalResult
- CurrentSubposition
- DcdCurrencyPair
- DcdOrderHistoryItem
- DcdOrderStatus
- DcdProduct
- DcdQuote
- DcdRedeemQuote
- DcdRedeemResult
- DcdTradeResult
- DeltaHedgeCurrency
- DepositHistory
- EconomicCalendarData
- EconomicCalendarRequest
- EntrySettingParam
- EstimatedDeliveryExercisePrice
- EthStakingProductInfo
- EventContractEvent
- EventContractMarket
- EventContractSeries
- EventContractSettlement
- ExecuteBlockQuoteRequest
- ExecuteBlockQuoteResult
- ExitSettingParam
- FeeGroup
- FillsHistoryRequest
- FixedLoanBorrowingLimit
- FixedLoanBorrowingLimitDetail
- FixedLoanBorrowQuote
- FundingBalance
- FundingCurrency
- FundingRateHistory
- FundingRateRequest
- FundsTransferRequest
- FundTransferResult
- FundTransferState
- GetAccountBillSubtypesRequest
- GetAccountConfigurationResult
- GetActiveSpreadOrdersRequest
- GetBlockQuoteParams
- GetBlockQuoteResult
- GetBlockRFQSParams
- GetBorrowRepayHistoryRequest
- GetCollateralAssetsResult
- GetContractOpenInterestHistoryRequest
- GetContractTakerVolumeRequest
- GetCopySettingsResult
- GetCopyTradersRequest
- GetCopyTradersResult
- GetCopyTradingConfigResult
- GetCTBatchLeverageInfoRequest
- GetCTBatchLeverageInfoResult
- GetCTHistoryLeadTradersRequest
- GetCTHistoryLeadTradersResult
- GetCTMyLeadTradersResult
- GetCTProfitDetailsRequest
- GetCTProfitDetailsResult
- GetCTTotalProfitResult
- GetCTUnrealizedProfitResult
- GetCurrentSubpositionsRequest
- GetDcdOrderHistoryRequest
- GetDcdOrderStatusRequest
- GetDcdProductsRequest
- GetDepositHistoryRequest
- GetDepositWithdrawStatusRequest
- GetEventContractEventsRequest
- GetEventContractMarketsRequest
- GetEventContractSeriesRequest
- GetFixedLoanBorrowingOrdersListRequest
- GetFixedLoanBorrowQuoteRequest
- GetFlexibleLoanCollateralAssetsRequest
- GetFundingRateRequest
- GetGlpHistoricalPerformanceRequest
- GetGlpV2AssessmentDetailsRequest
- GetGlpV2PerformanceHistoryRequest
- GetGridAlgoOrdersRequest
- GetHistoricalMarketDataRequest
- GetHistoricPositionParams
- GetInstrumentsRequest
- GetInsuranceFundRequest
- GetLeadTraderPositionsRequest
- GetLeadTraderRanksRequest
- GetLeadTraderRanksResult
- GetLeadTraderStatsRequest
- GetLendingOrderListRequest
- GetLendingSubOrderListRequest
- GetLoanInfoRequest
- GetManagedSubAccountTransferHistoryRequest
- GetMovePositionsHistoryRequest
- GetOptionTradesRequest
- GetPositionsParams
- GetPremiumHistoryRequest
- GetPrivateLeadTraderRanksRequest
- GetPrivateLeadTraderRanksResult
- GetQuickMarginBorrowRepayHistoryRequest
- GetRecurringBuyOrderListRequest
- GetRSIBackTestingRequest
- GetSignalBotEventHistoryRequest
- GetSignalBotPositionHistoryRequest
- GetSignalBotRequest
- GetSignalBotSubOrdersRequest
- GetSignalsRequest
- GetSignalsResult
- GetSpreadCandlesRequest
- GetSpreadOrderHistoryArchiveRequest
- GetSpreadOrderHistoryRequest
- GetSpreadsRequest
- GetSpreadTradesRequest
- GetStableRewardsApyHistoryRequest
- GetStableRewardsBalanceRequest
- GetStableRewardsProductInfoRequest
- GetStableRewardsSubscribeRedeemHistoryRequest
- GetSubAccountMaxWithdrawalsRequest
- GetSubpositionsHistoryRequest
- GetTopTradersContractLongShortRatioRequest
- GetTransactionDetailsArchiveRequest
- GetVIPInterestRequest
- GetVIPLoanOrderDetailRequest
- GetVIPLoanOrderListRequest
- GlpDailyMetrics
- GlpHistoricalPerformanceItem
- GlpMakerTaker
- GlpMtdMetrics
- GlpProgramPerformance
- GlpShareBuckets
- GlpTodayPerformance
- GlpV2AssessmentDetails
- GlpV2AssessmentPerformance
- GlpV2Overview
- GlpV2OverviewPerformance
- GlpV2OverviewProgram
- GlpV2PerformanceHistory
- GlpV2PerformanceHistoryItem
- GlpV2TierRequirement
- GlpVolumeBuckets
- Greeks
- GridAlgoOrderRequest
- GridAlgoTrigger
- HistoricAccountPosition
- HistoricAlgoOrder
- HistoricOrder
- IndexTicker
- Instrument
- InstrumentUpcomingParamChange
- InsuranceFund
- InsuranceFundDetail
- InterestAccrued
- InterestRate
- InterestRateAndLoanQuota
- LeadTraderCurrentPosition
- LeadTraderPnl
- LeadTraderPositionHistory
- LeadTraderPreference
- LeadTraderRank
- LeadTraderStats
- LendingOrder
- LeverageInfo
- LoanAllocation
- LoanCurrencyData
- LoanHistoryItem
- LoanHistoryRequest
- LoanInfo
- LoanQuotaConfig
- MakerInstrumentData
- ManagedSubAccountTransfer
- MarketDataHistoryFileGroup
- MarketDataHistoryGroupDetail
- MarketDataHistoryResult
- MaxGridQuantityRequest
- MaxLoanRequest
- MaxLoanResponse
- MaxWithdrawal
- MessageEventLike
- MmInstrumentType
- MMPConfig
- MovePositionLeg
- MovePositionLegFrom
- MovePositionLegResult
- MovePositionLegResultFrom
- MovePositionLegResultTo
- MovePositionLegTo
- MovePositionsRequest
- MovePositionsResult
- NonTradableAsset
- OkusdLimitBucket
- OkusdLimits
- OkusdRedeemResult
- OkusdSubLimit
- OkusdSubscribeResult
- OptionsTradeInfo
- OptionTrade
- OptionTrades
- OrderBook
- OrderBookEntry
- OrderBookRpi
- OrderDetails
- OrderFill
- OrderHistoryRequest
- OrderIdRequest
- OrderListItem
- OrderPrecheckRequest
- OrderRequest
- OrderResult
- PaginatedSymbolRequest
- Pagination
- PlaceCTAlgoOrderRequest
- PlaceCTAlgoOrderResult
- PlaceRecurringBuyOrderRequest
- PlaceSpreadOrderRequest
- PlaceSpreadOrderResponse
- PlaceSubOrderRequest
- PnlRatio
- PositionBuilderRequest
- PrecheckSetDeltaNeutralRequest
- PrecheckSetDeltaNeutralResult
- PublicBlockTrade
- PublicBlockTradeLeg
- PublicBorrowHistoryRecord
- PublicFundingRate
- PublicSpreadTrade
- QuickMarginBorrowRepayRecord
- QuickMarginBorrowRepayRequest
- QuickMarginBorrowRepayResult
- RecurringBuyInfo
- RecurringBuyInfoOrder
- RecurringBuyInfoResult
- RecurringBuyOrder
- RecurringBuyOrderResult
- RecurringBuySubOrder
- RedeemOkusdRequest
- RegularUserInterestInfo
- RequestDcdQuoteRequest
- RequestDcdRedeemQuoteRequest
- RequestStableRewardsQuoteRequest
- RestClientOptions
- RFQLeg
- RFQQuoteLegExtended
- RiskWarningData
- SetCollateralAssetsResult
- SetCTBatchLeverageRequest
- SetCTBatchLeverageResult
- SetFeeTypeRequest
- SetFeeTypeResult
- SetLeverageRequest
- SetMmpConfigRequest
- SetMMPConfigRequest
- SetMmpConfigResult
- SetMMPConfigResult
- SetQuoteProductsRequest
- SetSettleCurrencyRequest
- SetSettleCurrencyResult
- SetSignalInstrumentsRequest
- SetSubAccountLoanAllocationRequest
- SetTradingConfigRequest
- SetTradingConfigResult
- SolStakingProductInfo
- SpreadCandle
- SpreadDetails
- SpreadLeg
- SpreadOrder
- SpreadOrderBook
- SpreadTicker
- SpreadTrade
- SpreadTradeLeg
- StableRewardsApyHistoryItem
- StableRewardsBalance
- StableRewardsBalanceDetail
- StableRewardsProductInfo
- StableRewardsProductInfoDetail
- StableRewardsQuote
- StableRewardsSubscribeRedeemHistoryItem
- StableRewardsTradeResult
- StopGridAlgoOrderRequest
- SubAccount
- SubAccountAPIReset
- SubAccountBalanceDetail
- SubAccountBalances
- SubAccountMaxWithdrawal
- SubAccountTransferRequest
- SubAccountTransferResult
- SubmitDcdRedeemRequest
- SubmitDcdTradeRequest
- SubmitFixedLoanBorrowingOrderRequest
- SubmitStableRewardsTradeRequest
- SubpositionsHistory
- SubscribeOkusdRequest
- SupplementaryCollateral
- SystemTime
- Ticker
- TimestampObject
- Trade
- UnitConvertData
- UnitConvertRequest
- UnmatchedInfo
- UpdateFixedLoanBorrowingOrderRequest
- UpdateSpreadOrderRequest
- UpdateSpreadOrderResponse
- VIPInterest
- VIPInterestInfo
- VIPLoanOrder
- VIPLoanOrderDetail
- WebsocketClientOptions
- WithdrawalHistory
- WithdrawalHistoryRequest
- WithdrawRequest
- WithdrawResponse
- WSAPIAmendOrderRequestV5
- WSAPIAmendSpreadOrderRequestV5
- WSAPICancelOrderResultV5
- WSAPICancelSpreadOrderRequestV5
- WSAPIClientConfigurableOptions
- WSAPIMassCancelOrdersRequestV5
- WsAPIOperationResponseMap
- WSAPIPlaceOrderRequestV5
- WSAPIPlaceSpreadOrderRequestV5
- WSAPIRequestFlags
- WSAPIRequestOKX
- WSAPIResponse
- WSAPISpreadAmendOrderResultV5
- WSAPISpreadCancelOrderResultV5
- WSAPISpreadMassCancelOrdersRequestV5
- WSAPISpreadPlaceOrderResultV5
- WsAPITopicRequestParamMap
- WsAPIWsKeyTopicMap
- WsAuthRequest
- WsAuthRequestArg
- WsBaseRequestArg
- WsChannelConnInfoEvent
- WSClientConfigurableOptions
- WsDataEvent
- WsEstimatedPriceData
- WsEvent
- WsLoginEvent
- WSOperationLoginParams
- WsPrivateChannelArgAlgo
- WsPrivateChannelArgBalanceAndPosition
- WsPrivateChannelArgGridOrders
- WsPrivateChannelArgGridOther
- WsPrivateChannelArgTickers
- WsPrivateChannelArgWithCcy
- WsPrivateChannelArgWithInstFamily
- WsPublicChannelArgEventContractMarkets
- WsPublicChannelArgInstId
- WsPublicChannelArgInstType
- WsPublicChannelArgLiquidationOrders
- WsPublicChannelArgOptionSummary
- WsPublicChannelArgStatus
- WsRequestOperationOKX
- WsSubRequest
- WsTopicRequest
- WsTradeBaseRequest
- WsUnsubRequest
Type Aliases
- AccountLevel
- AlgoOrderDetailsRequest
- AlgoOrderState
- AlgoOrderType
- AlgoPositionSide
- APIMarket
- AssetBillType
- Candle
- CandleNoVolume
- ContractGridDirection
- DcdOrderState
- DcdOrderStatusState
- DcdRedeemConfirmState
- DcdTradeOrderState
- DefaultLogger
- Exact
- GlpProgram
- GlpV2AssessPeriod
- GlpV2BizId
- GlpV2Instrument
- GlpV2Program
- GlpV2Side
- GlpV2TierOutcome
- GridAlgoOrderType
- GridAlgoSubOrderType
- InstrumentType
- LogParams
- MarginMode
- numberInString
- OrderSide
- OrderState
- OrderType
- PositionSide
- PosMode
- PriceTriggerType
- StableRewardsBalanceState
- StableRewardsSubscribeRedeemStatus
- StableRewardsSubscribeRedeemType
- TradeMode
- WithdrawState
- WSAPIBusinessOperations
- WSAPIOperation
- WSAPIPrivateOperations
- WsBusinessChannel
- WsBusinessPrivateChannel
- WsBusinessPublicChannel
- WsChannel
- WsChannelArgInstType
- WsChannelSubUnSubRequestArg
- WsEstimatedPriceSettleType
- WsEventInternalSrc
- WsKey
- WSOperation
- WsPrivateChannel
- WsPublicChannel
- WsPublicChannelArgInstIdOrFamily
- WsPublicIndexKlineChannel
- WsPublicKlineChannel
- WsPublicMarkPriceKlineChannel
- WsPublicOrderBooksChannel
- WsResponse
- WsTopicRequestOrStringTopic
- WsTradeOp
Variables
- DefaultLogger
- DEFERRED_PROMISE_REF
- MIXED_WS_KEYS
- PRIVATE_CHANNELS
- PRIVATE_WS_KEYS
- PUBLIC_CHANNELS_WITH_AUTH
- PUBLIC_WS_KEYS
- WS_API_BUSINESS_OPERATIONS
- WS_API_Operations
- WS_API_PRIVATE_OPERATIONS
- WS_API_TAG_OPERATIONS
- WS_BASE_URL_MAP
- WS_EVENT_CODE_ENUM
- WS_KEY_MAP
- WS_LOGGER_CATEGORY
Functions
- getDemoWsKey
- getMaxTopicsPerSubscribeEventForMarket
- getNormalisedTopicRequests
- getPromiseRefForWSAPIRequest
- getWsKeyForMarket
- getWsKeyForTopicChannel
- getWsUrlForWsKey
- isConnCountEvent
- isDeepObjectMatch
- isMessageEvent
- isRawAPIResponse
- isWSAPIResponse
- isWsDataEvent
- isWsErrorEvent
- isWsEvent
- isWsLoginEvent
- isWSPingFrameAvailable
- isWsPong
- isWSPongFrameAvailable
- isWsSubscribeEvent
- isWsUnsubscribeEvent
- neverGuard
- requiresWSAPITag
- safeTerminateWs
- validateWSAPITag