rhyperliquid 0.1.0

Rust SDK and client for the Hyperliquid exchange API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

# rhyperliquid

A Rust SDK for [Hyperliquid](https://hyperliquid.xyz), the high-performance perpetuals decentralized exchange. Built with type safety in mind and async-first architecture.

⚠️ **Please test all desired operations on Testnet before operating on Mainnet**

## Features

- Market data queries (spot & perpetuals)
- Account information retrieval
- Order book snapshots
- Historical candle data
- User fills and funding history
- Order placement and cancellation
- Position management
- Vault operations

## Project Status

- [x] Complete REST Info API (market data)
- [x] EIP-712 authentication & message signing
- [x] Exchange API (order placement, cancellation)
- [ ] WebSocket streaming (real-time data feeds)
- [ ] CLI

## Quick Start

```rust
use rhyperliquid::HyperliquidClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = HyperliquidClient::builder()
        .testnet()
        .build()?;

    // Get real-time mid prices for all assets
    let mids = client.info().get_all_mids().await?;
    println!("BTC: ${}", mids.get("BTC").unwrap());

    // Fetch L2 orderbook snapshot
    let book = client.info().get_l2_book("ETH").await?;
    println!("Best bid: ${}", book.levels[0].px);

    Ok(())
}
```

## Trading

For order placement and cancellation examples, see [`examples/basic_order.rs`](examples/basic_order.rs).

For account transfer examples, see [`examples/account_transfer.rs`](examples/account_transfer.rs).

For position leverage and managing an isolated position see [`examples/leverage_position.rs`](examples/leverage_position.rs).

For advanced order examples see [`examples/advanced_order.rs`](examples/advanced_order.rs).

For TWAP order placement see [`examples/twap_order.rs`](examples/twap_order.rs).

## Stability and API Guarantees
This crate is under active development.

**Breaking changes** may occur between minor versions (0.1 -> 0.2).

**Public API** is subject to refinement based on usage feedback.

**Testnet testing** is strongly recommended before mainnet use.

## Installation

### As a Library Dependency

Add to your `Cargo.toml`:

```toml
[dependencies]
rhyperliquid = "0.1"
tokio = { version = "1.41", features = ["full"] }
```

### From Source

Clone and build the repository:

```bash
# Clone the repository
git clone https://github.com/elijahhampton/rhyperliquid.git
cd rhyperliquid

# Build the library
cargo build --release

# Run tests
cargo test --all-features

# Build documentation
cargo doc --open

```

## Getting Help
If you have any questions, first see if the answer to your question can be found in the [Hyperliquid Docs](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api).

If the answer is not there:

Open a discussion with your question, or
Open an issue with the bug


### Minimum Supported Rust Version (MSRV)

Rust **1.75.0** or higher is required.

```bash
# Verify your Rust version
rustc --version

rustup update stable
```