Struct HyperliquidClient 

pub struct HyperliquidClient { /* private fields */ }

Implementations

impl HyperliquidClient

pub fn new() -> Self

pub fn with_auth(user_address: Address, private_key: String) -> Self

pub fn with_budgets(self, rest_weight: u32, addr_budget: u64) -> Self

Configure rate limit budgets (rest_weight/min, address_requests). Defaults: 1200 rest weight/min, 10000 address requests.

Trait Implementations

impl Default for HyperliquidClient

fn default() -> Self

Returns the “default value” for a type.

impl GetAccountSnapshot for HyperliquidClient

async fn get_positions(&self) -> Result<Vec<Position>, String>

Returns open positions from clearinghouseState. Requires with_auth. Zero-size positions are filtered out. Positive szi = long, negative = short.

async fn get_open_orders(&self) -> Result<Vec<OpenOrder>, String>

Returns resting orders from Hyperliquid’s openOrders endpoint. Requires with_auth. filled_quantity is derived as origSz - sz (original size minus remaining size).

async fn get_collateral(&self) -> Result<Decimal, String>

Returns total account value (collateral) from clearinghouseState. Requires with_auth.

async fn get_spot_balance(&self) -> Result<Vec<Balance>, String>

Returns all spot wallet balances from spotState. Requires with_auth.

async fn get_collateral_balance(&self, asset: String) -> Result<Balance, String>

Returns clearing house collateral balance for an asset. Currently returns the total collateral. Requires with_auth.

impl GetMarketData for HyperliquidClient

async fn get_symbol(&self) -> Result<Vec<String>, String>

Returns all perpetual asset names from Hyperliquid’s meta endpoint.

async fn get_open_interest(&self, symbol: String) -> Result<Decimal, String>

Returns the current open interest for symbol from metaAndAssetCtxs.

async fn get_asset_context( &self, symbol: String, ) -> Result<AssetContext, String>

Returns a full AssetContext snapshot for symbol from metaAndAssetCtxs.

async fn get_all_asset_contexts(&self) -> Result<Vec<AssetContext>, String>

Fetches metaAndAssetCtxs once and returns all asset contexts in universe order. Prefer this over repeated get_asset_context calls to avoid rate-limiting.

async fn get_l2_orderbook( &self, symbol: String, ) -> Result<Vec<L2Update>, String>

Returns a full L2 orderbook snapshot for symbol from the l2Book REST endpoint. Levels are returned as individual L2Update items; all share the same sequence (timestamp).

async fn get_price(&self, symbol: String) -> Result<Decimal, String>

Returns the mid-price of symbol (e.g. “BTC”) from allMids.

async fn get_predicted_fundings(&self) -> Result<Vec<PredictedFunding>, String>

Returns predicted funding rates for all symbols across all venues. Null venue entries (unsupported coins) are silently skipped.

impl ManageOrder for HyperliquidClient

async fn place_order( &self, symbol: String, side: OrderSide, price: Decimal, volume: Decimal, order_type: OrderType, time_in_force: TimeInForce, cloid: Option<String>, ) -> Result<OrderPlacement, String>

Places an order on Hyperliquid. Requires with_auth. Returns an OrderPlacement with the exchange-assigned order ID. Market orders are submitted as aggressive limit orders (IOC).

If cloid is provided, Hyperliquid attaches it to the order lifecycle — fills and order updates will carry the same cloid back, enabling end-to-end intent tracing without a separate order_id mapping.

async fn change_order_by_cloid( &self, cloid: i64, price: Decimal, volume: Decimal, ) -> Result<i64, String>

Modifies price and size of an existing order by its order ID. Requires with_auth. Fetches the order’s current coin and side before submitting the modify action.

async fn cancel_order(&self, cloid: i64) -> Result<i64, String>

Cancels a single order by its order ID. Requires with_auth. Fetches open orders to resolve the coin/asset before cancelling.

async fn cancel_all_order(&self) -> Result<bool, String>

Cancels all open orders. Requires with_auth. Fetches all open orders and submits a batch cancel in a single signed request.

impl SubscribeMarketData for HyperliquidClient

fn subscribe_l2_update( &self, symbol: String, ) -> BoxStream<Result<L2Update, String>>

subscribe to L2 orderbook updates for a symbol

fn subscribe_asset_context( &self, symbol: String, ) -> BoxStream<Result<AssetContext, String>>

subscribe to asset context updates (OI, funding rate, mark price, 24h volume)

fn subscribe_liquidation( &self, user: String, ) -> BoxStream<Result<Liquidation, String>>

subscribe to liquidation events for a user address

fn subscribe_fill(&self, symbol: String) -> BoxStream<Result<Fill, String>>

subscribe to market fill events for a symbol

impl SubscribeUserEvents for HyperliquidClient

fn subscribe_spot_balance(&self) -> BoxStream<Result<Vec<Balance>, String>>

Subscribe to spot wallet balance updates for the registered user address. Requires authentication (address must be set). Returns error if address not registered.

fn subscribe_spot_balance_with_address( &self, address: String, ) -> BoxStream<Result<Vec<Balance>, String>>

Subscribe to spot wallet balance updates for a specific address.

fn subscribe_user_fills(&self) -> BoxStream<Result<UserFill, String>>

stream executions of the user’s own orders

fn subscribe_order_updates(&self) -> BoxStream<Result<OrderUpdate, String>>

stream order lifecycle updates

fn subscribe_funding_payments( &self, ) -> BoxStream<Result<FundingPayment, String>>

stream funding payments applied to positions

fn subscribe_deposits(&self) -> BoxStream<Result<Deposit, String>>

stream account deposit events

fn subscribe_withdrawals(&self) -> BoxStream<Result<Withdrawal, String>>

stream account withdrawal events

impl TestServer for HyperliquidClient

async fn ping(&self) -> Result<bool, String>

Sends a lightweight allMids request; returns true if the server responds 200 OK.

async fn get_server_time(&self) -> Result<i64, String>

Hyperliquid has no dedicated server-time endpoint; returns local UTC ms.