go-hyperliquid

Unofficial Go client for the Hyperliquid exchange API. This implementation follows the same philosophy and patterns as the official Python SDK.

Installation

go get github.com/sonirico/go-hyperliquid

Features

This Go SDK provides full feature parity with the official Python SDK, including:

Trading Features

• Order Management: Limit orders, market orders, trigger orders, order modifications
• Position Management: Leverage updates, isolated margin, position closing
• Bulk Operations: Bulk orders, bulk cancellations, bulk modifications
• Advanced Trading: Market open/close with slippage protection, scheduled cancellations
• Builder Support: Order routing through builders with fee structures

Account Management

• Referral System: Set referral codes, track referral state
• Sub-Accounts: Create and manage sub-accounts, transfer funds
• Multi-Signature: Convert to multi-sig, execute multi-sig actions
• Vault Operations: Vault deposits, withdrawals, and transfers

Asset Management

• USD Transfers: Cross-chain USD transfers, spot transfers
• Class Transfers: USD class transfers (perp ↔ spot), perp dex transfers
• Bridge Operations: Withdraw from bridge with fee management
• Token Delegation: Stake tokens with validators
• Spot Trading: Full spot market support

Advanced Features

• Agent Approval: Approve trading agents with permissions
• Builder Fee Management: Approve and manage builder fees
• Big Blocks: Enable/disable big block usage

Deployment Features (Advanced)

• Spot Deployment: Token registration, genesis, freeze privileges
• Perp Deployment: Asset registration, oracle management
• Hyperliquidity: Register hyperliquidity assets

Consensus Layer (Validators)

• Validator Operations: Register, unregister, profile management
• Signer Operations: Jail/unjail self, inner actions
• Consensus Actions: Full consensus layer interaction

WebSocket Features

• Market Data: Real-time L2 book, trades, candles, mid prices
• User Events: Order updates, fills, funding, ledger updates
• Advanced Streams: BBO, active asset context, web data v2

Usage

package main

import (
    "context"
    "fmt"
    "log"
    
    "github.com/ethereum/go-ethereum/crypto"
    hyperliquid "github.com/sonirico/go-hyperliquid"
)

func main() {
    // Initialize client
    client := hyperliquid.NewClient(hyperliquid.MainnetAPIURL)
    
    // For trading, create an Exchange with your private key
    privateKey, _ := crypto.HexToECDSA("your-private-key")
    exchange := hyperliquid.NewExchange(
        privateKey,
        hyperliquid.MainnetAPIURL,
        nil,    // Meta will be fetched automatically
        "vault-address",
        "account-address",
        nil,    // SpotMeta will be fetched automatically
    )
    
    // Place a limit order
    order := hyperliquid.OrderRequest{
        Coin:    "BTC",
        IsBuy:   true,
        Size:    0.1,
        LimitPx: 40000.0,
        OrderType: hyperliquid.OrderType{
            Limit: &hyperliquid.LimitOrderType{
                Tif: "Gtc",
            },
        },
    }
    
    resp, err := exchange.Order(order, nil)
    if err != nil {
        log.Fatal(err)
    }
    
    // Subscribe to WebSocket updates
    ws := hyperliquid.NewWebsocketClient(hyperliquid.MainnetAPIURL)
    if err := ws.Connect(context.Background()); err != nil {
        log.Fatal(err)
    }
    defer ws.Close()
    
    // Subscribe to BTC trades
    _, err = ws.Subscribe(hyperliquid.Subscription{
        Type: "trades",
        Coin: "BTC",
    }, func(msg hyperliquid.WSMessage) {
        fmt.Printf("Trade: %+v\n", msg)
    })
}

Documentation

For detailed API documentation, please refer to:

• Official Hyperliquid API docs
• Go package documentation

Examples

Check the examples/ directory for more usage examples:

• WebSocket subscriptions
• Order management
• Position handling
• Market data retrieval

Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

Quick Start for Contributors

# Clone the repository
git clone https://github.com/sonirico/go-hyperliquid.git
cd go-hyperliquid

# Install dependencies and tools
make deps install-tools

# Run all checks
make ci-full

# Run tests (excluding examples)
make ci-test

Roadmap

✅ Completed Features

• Complete WebSocket API implementation
• REST API client
• All trading operations (orders, positions, leverage)
• Market data (L2 book, trades, candles, all mids)
• User account management
• Referral system implementation
• Sub-account management
• Vault operations
• USD and spot transfers
• Bridge operations
• Agent approval system
• Builder fee management
• Multi-signature support
• Token delegation/staking
• Spot deployment features
• Perp deployment features
• Consensus layer (validator operations)
• Full feature parity with Python SDK

🚀 Future Enhancements

• Enhanced documentation with more examples
• Performance optimizations
• Additional testing and edge case coverage
• Rate limiting and retry mechanisms
• Monitoring and observability features
• Order management
• User account operations
• Advanced order types
• Historical data API
• Rate limiting improvements
• Connection pooling

License

MIT License

Copyright (c) 2025

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.