Skip to main content Module models Copy item path Source AssetPosition A single asset position in the clearinghouse state. ClearinghouseState Complete clearinghouse state response from POST /info with { "type": "clearinghouseState", "user": "address" }.
This provides account positions, margin information, and balances. Cloid A 128-bit client order ID represented as a hex string with 0x prefix. CrossMarginSummary Cross margin summary information. CumFundingInfo Cumulative funding breakdown for a position. EvmContract EVM contract information for a spot token. HyperliquidAssetInfo Represents asset information from the meta endpoint. HyperliquidCandle Represents a single candle (OHLCV bar) from Hyperliquid. HyperliquidExchangeRequest Represents an exchange action request wrapper for POST /exchange. HyperliquidExecBuilderFee Builder code for order attribution in the exchange endpoint. HyperliquidExecCancelByCloidRequest Cancel specification for canceling orders by client order ID via exchange endpoint. HyperliquidExecCancelOrderRequest Cancel specification for canceling orders by order ID via exchange endpoint. HyperliquidExecCancelResponseData Cancel response data containing status for each cancellation from exchange endpoint. HyperliquidExecFilledInfo Information about a filled order via exchange endpoint. HyperliquidExecLimitParams Parameters for limit orders in exchange endpoint. HyperliquidExecModifyOrderRequest Modify specification for modifying existing orders via exchange endpoint. HyperliquidExecModifyResponseData Modify response data containing status for each modification from exchange endpoint. HyperliquidExecOrderResponseData Order response data containing status for each order from exchange endpoint. HyperliquidExecPlaceOrderRequest Order specification for placing orders via exchange endpoint. HyperliquidExecRequest Exchange request envelope for the /exchange endpoint. HyperliquidExecResponse Exchange response envelope from the /exchange endpoint. HyperliquidExecRestingInfo Information about a resting order via exchange endpoint. HyperliquidExecTriggerParams Parameters for trigger orders (stop/take profit) in exchange endpoint. HyperliquidExecTwapRequest TWAP (Time-Weighted Average Price) order specification for exchange endpoint. HyperliquidFill Represents an individual fill from user fills. HyperliquidFundingHistoryEntry Represents a single funding history entry from the fundingHistory info endpoint. HyperliquidL2Book Represents an L2 order book snapshot from POST /info. HyperliquidLevel Represents an order book level with price and size. HyperliquidMeta Represents metadata about available markets from POST /info. HyperliquidOrderInfo Represents order information within an order status entry. HyperliquidOrderStatusEntry Represents an individual order status entry. HyperliquidSignature ECC signature components for Hyperliquid exchange requests. LeverageInfo Leverage information for a position. MarginTable Margin table with leverage tiers. MarginTier Individual margin tier. PerpAsset A single perpetual asset from the universe. PerpAssetCtx Runtime context for a perpetual asset (mark prices, funding, etc). PerpMeta Complete perpetuals metadata response from POST /info with { "type": "meta" }. PositionData Detailed position data for an asset. SpotAssetCtx Runtime context for a spot pair (prices, volumes, etc). SpotBalance A single token balance entry from spotClearinghouseState.balances. SpotClearinghouseState Complete spot clearinghouse state response from POST /info
with { "type": "spotClearinghouseState", "user": "address" }. SpotMeta Complete spot metadata response from POST /info with { "type": "spotMeta" }. SpotPair A single spot pair from the universe. SpotToken A single spot token from the tokens list. HyperliquidExchangeResponse Represents an exchange response wrapper from POST /exchange. HyperliquidExecAction All possible exchange actions for the Hyperliquid /exchange endpoint. HyperliquidExecCancelStatus Status of an individual order cancellation via exchange endpoint. HyperliquidExecGrouping Order grouping strategy for linked TP/SL orders in exchange endpoint. HyperliquidExecModifyStatus Status of an individual order modification via exchange endpoint. HyperliquidExecOrderKind Order kind specification for the t field in exchange endpoint order requests. HyperliquidExecOrderStatus Status of an individual order submission via exchange endpoint. HyperliquidExecResponseData Response data containing the actual response payload from exchange endpoint. HyperliquidExecTif Time-in-force for limit orders in exchange endpoint. HyperliquidExecTpSl Take profit or stop loss side for trigger orders in exchange endpoint. HyperliquidOrderStatus Represents order status response from POST /info with type: "orderStatus". PerpMetaAndCtxs Optional perpetuals metadata with asset contexts from { "type": "metaAndAssetCtxs" }.
Returns a tuple: [PerpMeta, Vec<PerpAssetCtx>] SpotMetaAndCtxs Optional spot metadata with asset contexts from { "type": "spotMetaAndAssetCtxs" }.
Returns a tuple: [SpotMeta, Vec<SpotAssetCtx>] RESPONSE_STATUS_OK The success status string returned by the Hyperliquid exchange API. AssetId Asset ID type for Hyperliquid. HyperliquidCandleSnapshot Response from candleSnapshot endpoint (returns array directly). HyperliquidFills Represents user fills response from POST /info. OrderId Order ID assigned by Hyperliquid.