Struct HyperliquidSDK 

pub struct HyperliquidSDK { /* private fields */ }

Main Hyperliquid SDK client

Implementations

impl HyperliquidSDK

pub fn new() -> HyperliquidSDKBuilder

Create a new SDK builder

pub fn address(&self) -> Option<Address>

Get the user’s address

pub fn chain(&self) -> Chain

Get the chain

pub fn info(&self) -> Info

Access the Info API

pub fn core(&self) -> HyperCore

Access the HyperCore API

pub fn evm(&self) -> EVM

Access the EVM API

pub fn stream(&self) -> Stream

Create a WebSocket stream

pub fn grpc(&self) -> GRPCStream

Create a gRPC stream

pub fn evm_stream(&self) -> EVMStream

Access the EVM WebSocket stream

pub async fn markets(&self) -> Result<Value>

Get all available markets

pub async fn dexes(&self) -> Result<Value>

Get all DEXes (HIP-3)

pub async fn open_orders(&self) -> Result<Value>

Get open orders for the current user

pub async fn order_status(&self, oid: u64, dex: Option<&str>) -> Result<Value>

Get status of a specific order

pub async fn market_buy(&self, asset: &str) -> MarketOrderBuilder

Place a market buy order

pub async fn market_sell(&self, asset: &str) -> MarketOrderBuilder

Place a market sell order

pub async fn buy( &self, asset: &str, size: f64, price: f64, tif: TIF, ) -> Result<PlacedOrder>

Place a limit buy order

pub async fn sell( &self, asset: &str, size: f64, price: f64, tif: TIF, ) -> Result<PlacedOrder>

Place a limit sell order

pub async fn order(&self, order: Order) -> Result<PlacedOrder>

Place an order using the fluent builder

pub async fn trigger_order(&self, order: TriggerOrder) -> Result<PlacedOrder>

Place a trigger order (stop-loss / take-profit)

pub async fn stop_loss( &self, asset: &str, size: f64, trigger_price: f64, ) -> Result<PlacedOrder>

Stop-loss helper

pub async fn take_profit( &self, asset: &str, size: f64, trigger_price: f64, ) -> Result<PlacedOrder>

Take-profit helper

pub async fn modify( &self, oid: u64, asset: &str, is_buy: bool, size: f64, price: f64, tif: TIF, reduce_only: bool, cloid: Option<&str>, ) -> Result<PlacedOrder>

Modify an existing order

The order is identified by OID, which is included in the returned order.

pub async fn cancel(&self, oid: u64, asset: &str) -> Result<Value>

Cancel an order by OID

pub async fn cancel_all(&self, asset: Option<&str>) -> Result<Value>

Cancel all orders (optionally for a specific asset)

pub async fn close_position( &self, asset: &str, slippage: Option<f64>, ) -> Result<PlacedOrder>

Close position for an asset

Delegates position lookup and counter-order building to the worker using the closePosition action type. Optionally accepts a per-call slippage override.

pub async fn update_leverage( &self, asset: &str, leverage: i32, is_cross: bool, ) -> Result<Value>

Update leverage for an asset

pub async fn update_isolated_margin( &self, asset: &str, is_buy: bool, amount_usd: f64, ) -> Result<Value>

Update isolated margin

pub async fn twap_order( &self, asset: &str, size: f64, is_buy: bool, duration_minutes: i64, reduce_only: bool, randomize: bool, ) -> Result<Value>

Place a TWAP order

pub async fn twap_cancel(&self, asset: &str, twap_id: i64) -> Result<Value>

Cancel a TWAP order

pub async fn transfer_usd( &self, destination: &str, amount: f64, ) -> Result<Value>

Transfer USD to another address

pub async fn transfer_spot( &self, token: &str, destination: &str, amount: f64, ) -> Result<Value>

Transfer spot token to another address

pub async fn withdraw( &self, amount: f64, destination: Option<&str>, ) -> Result<Value>

Withdraw to Arbitrum

pub async fn transfer_spot_to_perp(&self, amount: f64) -> Result<Value>

Transfer spot balance to perp balance

pub async fn transfer_perp_to_spot(&self, amount: f64) -> Result<Value>

Transfer perp balance to spot balance

pub async fn vault_deposit( &self, vault_address: &str, amount: f64, ) -> Result<Value>

Deposit to a vault

pub async fn vault_withdraw( &self, vault_address: &str, amount: f64, ) -> Result<Value>

Withdraw from a vault

pub async fn stake(&self, amount_tokens: f64) -> Result<Value>

Stake tokens

pub async fn unstake(&self, amount_tokens: f64) -> Result<Value>

Unstake tokens

pub async fn delegate( &self, validator: &str, amount_tokens: f64, ) -> Result<Value>

Delegate tokens to a validator

pub async fn undelegate( &self, validator: &str, amount_tokens: f64, ) -> Result<Value>

Undelegate tokens from a validator

pub async fn approve_builder_fee(&self, max_fee: Option<&str>) -> Result<Value>

Approve builder fee

pub async fn revoke_builder_fee(&self) -> Result<Value>

Revoke builder fee approval

pub async fn approval_status(&self) -> Result<Value>

Check approval status

pub async fn reserve_request_weight(&self, weight: i32) -> Result<Value>

Reserve request weight (purchase rate limit capacity)

pub async fn noop(&self) -> Result<Value>

No-op (consume nonce)

pub async fn preflight( &self, asset: &str, side: Side, price: f64, size: f64, ) -> Result<Value>

Preflight validation

pub async fn approve_agent( &self, agent_address: &str, name: Option<&str>, ) -> Result<Value>

Approve an agent (API wallet) to trade on your behalf

pub async fn set_abstraction( &self, mode: &str, user: Option<&str>, ) -> Result<Value>

Set account abstraction mode

Mode can be: “disabled”, “unifiedAccount”, or “portfolioMargin”

pub async fn agent_set_abstraction(&self, mode: &str) -> Result<Value>

Set account abstraction mode as an agent

pub async fn send_asset( &self, token: &str, amount: f64, destination: &str, source_dex: Option<&str>, destination_dex: Option<&str>, from_sub_account: Option<&str>, ) -> Result<Value>

Generalized asset transfer between DEXs and accounts

pub async fn send_to_evm_with_data( &self, token: &str, amount: f64, destination: &str, data: &str, source_dex: &str, destination_chain_id: u32, gas_limit: u64, ) -> Result<Value>

Transfer tokens to HyperEVM with custom data payload

pub async fn top_up_isolated_only_margin( &self, asset: &str, leverage: f64, ) -> Result<Value>

Top up isolated-only margin to target a specific leverage

pub async fn validator_l1_stream(&self, risk_free_rate: &str) -> Result<Value>

Submit a validator vote for the risk-free rate (validator only)

pub async fn cancel_by_cloid(&self, cloid: &str, asset: &str) -> Result<Value>

Cancel an order by client order ID (cloid)

pub async fn schedule_cancel(&self, time_ms: Option<u64>) -> Result<Value>

Schedule cancellation of all orders after a delay (dead-man’s switch)

pub async fn get_mid(&self, asset: &str) -> Result<f64>

Get mid price for an asset

pub async fn refresh_markets(&self) -> Result<()>

Force refresh of market metadata cache