Hyperliquid API reference
Classes
Interfaces
- AccountBalancesResponse
- AccountDexRequest
- AccountRequest
- ActiveAssetData
- ActivePerpAssetContextEvent
- ActiveSpotAssetContextEvent
- AlignedQuoteTokenStatus
- AllDexsAssetCtxsEvent
- AllDexsClearinghouseStateEvent
- AllMidsEvent
- ApproveApiWalletRequest
- AssetContextEvent
- AssetCtxsEvent
- BboEvent
- BorrowLendBalance
- BorrowLendReserveState
- BorrowLendTokenState
- BorrowLendUserState
- BuilderCode
- CancelByCloidWireInput
- CancelErrorStatus
- CancelOrdersByClientOrderIdRequest
- CancelOrdersRequest
- CancelResponseData
- CancelTwapOrderRequest
- CancelWireInput
- Candle
- ClearinghouseStateEvent
- ConvertToMultiSigUserRequest
- DelegateOrUndelegateStakeRequest
- DeployGasAuction
- EventEmitterConstructor
- EventEmitterLike
- ExchangeErrorResponse
- ExchangeRequestEnvelope
- ExchangeStatus
- ExtraAgent
- FastAssetCtxsEvent
- FrontendOpenOrder
- FundingHistory
- GetCandlesRequest
- GetFundingHistoryRequest
- GetMaxBuilderFeeRequest
- GetOrderBookRequest
- GetOrderStatusRequest
- GetPreTransferCheckRequest
- GetUserBorrowLendInterestRequest
- GetUserFillsByTimeRequest
- GetUserFillsRequest
- GetUserFundingHistoryRequest
- GetUserNonFundingLedgerUpdatesRequest
- GetUserTwapSliceFillsByTimeRequest
- GetVaultDetailsRequest
- HistoricalOrder
- HyperliquidSigner
- L1ActionOptions
- LeadingVault
- LegalStatus
- LimitOrderType
- LinkStakingAccountRequest
- LiquidatablePosition
- ModifyOrderRequest
- ModifyOrdersRequest
- ModifyWireInput
- MultiSigL1RequestOptions
- MultiSigSigners
- MultiSigUserSignedRequestOptions
- NonceProvider
- NotificationEvent
- OpenOrder
- OpenOrdersEvent
- OrderBookLevel
- OrderBookResponse
- OrderErrorStatus
- OrderFilledStatus
- OrderResponseData
- OrderRestingStatus
- OrderStatusDetails
- OrderUpdateEvent
- OrderWire
- OrderWireInput
- Outcome
- OutcomeDeployer
- OutcomeDeployerLimits
- OutcomeMetadata
- OutcomeMetaUpdatesEvent
- OutcomeQuestion
- OutcomeSideSpec
- PerpAccountSummaryResponse
- PerpAnnotation
- PerpAsset
- PerpAssetContext
- PerpAssetPosition
- PerpConciseAnnotationInfo
- PerpCrossLeverage
- PerpCumulativeFunding
- PerpDex
- PerpDexLimits
- PerpDexStatus
- PerpIsolatedLeverage
- PerpMarginSummary
- PerpMarginTable
- PerpMarginTier
- PerpMeta
- PerpPosition
- PortfolioSnapshot
- PredictedFundingQuote
- PreTransferCheck
- ReferralInfo
- ReferralReward
- ReferralTokenState
- ReferralUser
- RequestOptions
- ResolvedAsset
- RestClientOptions
- SendAssetRequest
- SendSpotAssetRequest
- SendToEvmWithDataRequest
- SendUsdRequest
- SetIsolatedMarginLeverageRequest
- SettledOutcome
- SettledOutcomeQuestion
- SetUserAbstractionRequest
- Signature
- SpotAssetContext
- SpotBalance
- SpotBalancesResponse
- SpotDeployStateResponse
- SpotDeployTokenSpec
- SpotDeployTokenState
- SpotEvmContract
- SpotMeta
- SpotPair
- SpotStateEvent
- SpotToken
- StakingDelegation
- StakingDiscountTier
- StakingHistoryEntry
- StakingReward
- StakingSummary
- SubAccount
- SubAccountWithAllDexStates
- SubmitLimitOrderRequest
- SubmitMarketCloseRequest
- SubmitMarketOrderRequest
- SubmitOrderRequest
- SubmitTwapOrderRequest
- TimeRangeRequest
- TokenDetails
- TokenGenesis
- Trade
- TransferSpotToOrFromSubAccountRequest
- TransferUsdBetweenSpotAndPerpRequest
- TransferUsdToOrFromSubAccountRequest
- TransferVaultFundsRequest
- TriggerOrderType
- TwapCancelResponseData
- TwapErrorStatus
- TwapHistoryEntry
- TwapOrderResponseData
- TwapRunningStatus
- TwapSliceFill
- TwapState
- TwapStatesEvent
- TypedDataDomain
- TypedDataField
- UpdateIsolatedMarginRequest
- UpdateLeverageRequest
- UserBorrowLendInterest
- UserDailyVolume
- UserFees
- UserFeeTier
- UserFill
- UserFillsEvent
- UserFunding
- UserFundingDelta
- UserFundingsEvent
- UserHistoricalOrdersEvent
- UserNonFundingLedgerUpdate
- UserNonFundingLedgerUpdatesEvent
- UserRateLimit
- UserRequest
- UserSignedActionDefinition
- UserSignedActionInput
- UserSignedActionOptions
- UserToggleRequest
- UserTwapHistoryEvent
- UserTwapSliceFillsEvent
- UserVaultDeposit
- ValidatorL1Vote
- ValidatorStats
- ValidatorSummary
- VaultDetails
- VaultFollower
- VaultSummary
- WebData2
- WebData3Event
- WebData3PerpDexState
- WebsocketClientEventMap
- WebsocketClientOptions
- WebSocketCloseEvent
- WebsocketConnectionContext
- WebSocketConstructor
- WebsocketExceptionEvent
- WebsocketLifecycleContext
- WebSocketLike
- WebSocketMessageEvent
- WebsocketPostResponseEvent
- WebsocketSubscriptionData
- WebsocketSubscriptionResponseEvent
Type Aliases
- ActiveAssetDataEvent
- AllMidsResponse
- AssetIdentifier
- BorrowLendReserveEntry
- CancelStatus
- CandleInterval
- DefaultLogger
- DeployPerpRequest
- DeploySpotRequest
- ExchangeResponse
- GenericWebsocketEvent
- GossipPriorityAuctionStatus
- Grouping
- HyperliquidChain
- HyperliquidNetwork
- InfoResponse
- JsonObject
- JsonPrimitive
- JsonValue
- L1RequestOptions
- LogParams
- MaxMarketOrderNotional
- OrderSide
- OrderState
- OrderStatus
- OrderStatusResponse
- OrderType
- OutcomeGovernanceAction
- PerpCategory
- PerpConciseAnnotation
- PerpDeployAuctionStatus
- PerpLeverage
- PerpMetaAndAssetContexts
- PortfolioEntry
- PortfolioPeriod
- PredictedFunding
- RawL1RequestOptions
- RawUserSignedRequestOptions
- ReferrerState
- RestClientNetworkOptions
- SendAssetFromApiWalletRequest
- SpotAssetCtxsEvent
- SpotMetaAndAssetContexts
- SpotPairDeployAuctionStatus
- StakingHistoryDelta
- SubmitUserOutcomeRequest
- TradeEvent
- TwapStatus
- TypedDataTypes
- UserAbstraction
- UserEvent
- UserNonFundingLedgerDelta
- UserRoleResponse
- UserSignedRequestOptions
- UserSubscriptionType
- ValidatorL1VoteAction
- VaultRelationship
- WebsocketAPIClientOptions
- WebsocketChannel
- WebsocketEventFor
- WebsocketLifecycleCallback
- WebsocketLifecycleEvent
- WebsocketMessageEvent
- WebsocketResponseEvent
- WebsocketSubscription
- WithdrawUsdRequest
- WsKey