https://github.com/sonirico/go-hyperliquid
Unofficial golang client SDK for api.hyperliquid.xyz supporting both API and websocket channels
https://github.com/sonirico/go-hyperliquid
api blockchain dex exchange go golang hyperliquid sdk sdk-go
Last synced: 3 months ago
JSON representation
Unofficial golang client SDK for api.hyperliquid.xyz supporting both API and websocket channels
- Host: GitHub
- URL: https://github.com/sonirico/go-hyperliquid
- Owner: sonirico
- License: mit
- Created: 2025-03-04T19:48:35.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2026-02-23T10:28:50.000Z (3 months ago)
- Last Synced: 2026-02-23T19:06:46.033Z (3 months ago)
- Topics: api, blockchain, dex, exchange, go, golang, hyperliquid, sdk, sdk-go
- Language: Go
- Homepage:
- Size: 3.43 MB
- Stars: 93
- Watchers: 3
- Forks: 52
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# go-hyperliquid
[](https://pkg.go.dev/github.com/sonirico/go-hyperliquid)
[](https://goreportcard.com/report/github.com/sonirico/go-hyperliquid)
[](https://github.com/sonirico/go-hyperliquid/actions/workflows/ci.yml)
[](https://coveralls.io/github/sonirico/go-hyperliquid?branch=main)
[](https://opensource.org/licenses/MIT)
[](https://go.dev/)
Unofficial Go client for the Hyperliquid exchange API. This implementation follows the same philosophy and patterns as the official Python SDK.
## Installation
```bash
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
```go
package main
import (
"context"
"fmt"
"log"
"github.com/ethereum/go-ethereum/crypto"
hyperliquid "github.com/sonirico/go-hyperliquid"
)
func main() {
// For trading, create an Exchange with your private key
privateKey, _ := crypto.HexToECDSA("your-private-key")
exchange := hyperliquid.NewExchange(
context.Background(),
privateKey,
hyperliquid.MainnetAPIURL,
nil, // Meta will be fetched automatically
"vault-address",
"account-address",
nil, // SpotMeta will be fetched automatically
nil, // PerpDexs 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(context.Background(), 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](https://hyperliquid.xyz/docs)
- [Go package documentation](https://pkg.go.dev/github.com/sonirico/go-hyperliquid)
### 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](CONTRIBUTING.md) for guidelines.
### Contributors
Thanks to all the people who have contributed to this project! 🎉
Marquitos
Yorick Terweijden
Stan
Prasetyo Iman Nugroho
Ishan Singh
Vernon Stokes
Alex
Levan
Ivan
Vyom
tpkeeper
hail100
feeeei
corver
Alexander Altergot
Vaiz_07
Everett
Andrew Malikov
### Quick Start for Contributors
```bash
# 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
- [x] Complete WebSocket API implementation
- [x] REST API client
- [x] All trading operations (orders, positions, leverage)
- [x] Market data (L2 book, trades, candles, all mids)
- [x] User account management
- [x] Referral system implementation
- [x] Sub-account management
- [x] Vault operations
- [x] USD and spot transfers
- [x] Bridge operations
- [x] Agent approval system
- [x] Builder fee management
- [x] Multi-signature support
- [x] Token delegation/staking
- [x] Spot deployment features
- [x] Perp deployment features
- [x] Consensus layer (validator operations)
- [x] 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
- [x] Order management
- [x] 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.