HyperLiquid.Net is a client library for accessing the HyperLiquid DEX REST and Websocket API.
- Response data is mapped to descriptive models
- Input parameters and response values are mapped to discriptive enum values where possible
- Automatic websocket (re)connection management
- Client side rate limiting
- Client side order book implementation
- Support for managing different accounts
- Extensive logging
- Support for different environments
- Easy integration with other exchange client based on the CryptoExchange.Net base library
- Native AOT support
The library is targeting both .NET Standard 2.0 and .NET Standard 2.1 for optimal compatibility, as well as dotnet 8.0 and 9.0 to use the latest framework features.
| .NET implementation | Version Support |
|---|---|
| .NET Core | 2.0 and higher |
| .NET Framework | 4.6.1 and higher |
| Mono | 5.4 and higher |
| Xamarin.iOS | 10.14 and higher |
| Xamarin.Android | 8.0 and higher |
| UWP | 10.0.16299 and higher |
| Unity | 2018.1 and higher |
dotnet add package HyperLiquid.Net
HyperLiquid.Net is available on GitHub packages. You'll need to add https://nuget.pkg.github.com/JKorf/index.json as a NuGet package source.
The NuGet package files are added along side the source with the latest GitHub release which can found here.
The library uses [BaseAsset]/[QuoteAsset] notation for Spot symbols and [BaseAsset] for futures symbols. Futures symbols inherently have USDC as quote symbol.
Spot symbol: HYPE/USDC
Futures symbol: HYPE
- REST Endpoints
var restClient = new HyperLiquidRestClient(); // Spot HYPE/USDC info var spotTickerResult = await restClient.SpotApi.ExchangeData.GetExchangeInfoAndTickersAsync(); var hypeInfo = spotTickerResult.Data.Tickers.Single(x => x.Symbol == "HYPE/USDC"); var currentHypePrice = hypeInfo.MidPrice; // Futures ETH perpetual contract info var futuresTickerResult = await restClient.FuturesApi.ExchangeData.GetExchangeInfoAndTickersAsync(); var ethInfo = futuresTickerResult.Data.Tickers.Single(x => x.Symbol == "ETH"); var currentEthPrice = ethInfo.MidPrice;
- Websocket streams
// Subscribe to HYPE/USDC Spot ticker updates via the websocket API var socketClient = new HyperLiquidSocketClient(); var tickerSubscriptionResult = await hyperLiquidSocketClient.SpotApi.SubscribeToSymbolUpdatesAsync("HYPE/USDC", (update) => { var lastPrice = update.Data.MidPrice; });
For information on the clients, dependency injection, response processing and more see the documentation, or have a look at the examples here or here.
HyperLiquid.Net is based on the CryptoExchange.Net base library. Other exchange API implementations based on the CryptoExchange.Net base library are available and follow the same logic.
CryptoExchange.Net also allows for easy access to different exchange API's.
| Exchange | Repository | Nuget |
|---|---|---|
| Binance | JKorf/Binance.Net |  |
| BingX | JKorf/BingX.Net |  |
| Bitfinex | JKorf/Bitfinex.Net |  |
| Bitget | JKorf/Bitget.Net |  |
| BitMart | JKorf/BitMart.Net |  |
| BitMEX | JKorf/BitMEX.Net |  |
| Bybit | JKorf/Bybit.Net |  |
| Coinbase | JKorf/Coinbase.Net |  |
| CoinEx | JKorf/CoinEx.Net |  |
| CoinGecko | JKorf/CoinGecko.Net |  |
| CoinW | JKorf/CoinW.Net |  |
| Crypto.com | JKorf/CryptoCom.Net |  |
| DeepCoin | JKorf/DeepCoin.Net |  |
| Gate.io | JKorf/GateIo.Net |  |
| HTX | JKorf/HTX.Net |  |
| Kraken | JKorf/Kraken.Net |  |
| Kucoin | JKorf/Kucoin.Net |  |
| Mexc | JKorf/Mexc.Net |  |
| OKX | JKorf/OKX.Net |  |
| Toobit | JKorf/Toobit.Net |  |
| WhiteBit | JKorf/WhiteBit.Net |  |
| XT | JKorf/XT.Net |  |
When using multiple of these API's the CryptoClients.Net package can be used which combines this and the other packages and allows easy access to all exchange API's.
A Discord server is available here. For discussion and/or questions around the CryptoExchange.Net and implementation libraries, feel free to join.
The signing method used in the library is not natively supported on OSX. Because of this a custom signing method has to be provided or a PlatformNotSupported exception will be thrown while trying to sign a request.
A custom signing method can be provided using HyperLiquidExchange.SignRequestDelegate = CustomSigningMethod;.
To run on OSX the Nethereum.Signer.EIP712 package can be installed with the following custom signing method:
Dictionary<string, object> Sign(string request, string secret)
{
var messageBytes = Convert.FromHexString(request);
var sign = new MessageSigner().SignAndCalculateV(messageBytes, new EthECKey(secret));
return new Dictionary<string, object>()
{
{ "r", "0x" + Convert.ToHexString(sign.R).ToLowerInvariant() },
{ "s", "0x" + Convert.ToHexString(sign.S).ToLowerInvariant() },
{ "v", (int)sign.V[0] }
};
}| API | Supported | Location |
|---|---|---|
| Info | ✓ | restClient.SpotApi.Account / restClient.SpotApi.ExchangeData / restClient.SpotApi.Trading restClient.FuturesApi.Account / restClient.FuturesApi.ExchangeData / restClient.FuturesApi.Trading |
| Info Perpetuals | ✓ | restClient.FuturesApi.Account / restClient.FuturesApi.ExchangeData |
| Info Spot | ✓ | restClient.SpotApi.Account / restClient.SpotApi.ExchangeData |
| Exchange | ✓ | restClient.SpotApi.Account / restClient.SpotApi.Trading restClient.FuturesApi.Account / restClient.FuturesApi.Trading |
| API | Supported | Location |
|---|---|---|
| * | ✓ | socketClient.SpotApi / socketClient.FuturesApi |
Any support is greatly appreciated.
If you do not yet have an account please consider using this referal link to sign up:
Link
Not only will you support development at no cost, you also get a 4% discount in fees.
Make a one time donation in a crypto currency of your choice. If you prefer to donate a currency not listed here please contact me.
Btc: bc1q277a5n54s2l2mzlu778ef7lpkwhjhyvghuv8qf
Eth: 0xcb1b63aCF9fef2755eBf4a0506250074496Ad5b7
USDT (TRX) TKigKeJPXZYyMVDgMyXxMf17MWYia92Rjd
Alternatively, sponsor me on Github using Github Sponsors.
-
Version 2.10.0 - 25 Aug 2025
- Updated CryptoExchange.Net version to 9.6.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
- Added ClearUserClients method to user client provider
-
Version 2.9.1 - 21 Aug 2025
- Added check for websocket unknown symbol error
-
Version 2.9.0 - 20 Aug 2025
- Updated CryptoExchange.Net to version 9.5.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
- Added improved error parsing
-
Version 2.8.1 - 11 Aug 2025
- Fixed deserialization error in SetLeverageAsync, UpdateIsolatedMarginAsync and EditOrderAsync endpoints
-
Version 2.8.0 - 08 Aug 2025
- Added restClient.SpotApi.Account.GetSubAccountsAsync endpoint
- Added restClient.SpotApi.Account.GetUserRoleAsync endpoint
- Added nSigFigs, mantissa parameters to SubscribeToOrderBookUpdatesAsync subscription
- Added nSigFix, mantissa parameters support to HyperLiquidSymbolOrderBook implementation
- Fixed some null response checking
-
Version 2.7.0 - 06 Aug 2025
- Added expiresAfter parameter to endpoints
- Added ExpiresAfter Rest client option to set expiresAfter parameter for all endpoints
- Fixed mapping of Funding on Position model, added RawUsd property to Leverage model
- Fixed Shared UserTrade pagination
- Fixed signing of requests containing bool parameters
-
Version 2.6.0 - 04 Aug 2025
- Updated CryptoExchange.Net to version 9.4.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
- Preserve user TimeInForce parameter is set for market orders, only default to ImmediateOrCancel if not passed
-
Version 2.5.0 - 30 Jul 2025
- Added MarginTableId and MarginTable properties to HyperLiquidFuturesSymbol model
- Fixed restClient.FuturesApi.Account.GetFundingHistoryAsync deserialization type
-
Version 2.4.0 - 23 Jul 2025
- Updated CryptoExchange.Net to version 9.3.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
- Updated websocket message matching
- Fixed proxy not getting carried over when making market data requests for caching
- Fixed deserialization issue in restClient.FuturesApi.ExchangeData.GetFundingRateHistoryAsync
- Fixed restClient.FuturesApi.Account.GetFundingHistoryAsync returning deserialization error when there is no data
- Fixed futures BTC and ETH symbols getting formatted to UBTC and UETH in shared implementation
-
Version 2.3.0 - 16 Jul 2025
- Added support for providing custom signing method
- Updated error response parsing for single failed orders
- Fixed incorrect signatureChainId for mainnet
-
Version 2.2.0 - 15 Jul 2025
- Updated CryptoExchange.Net to version 9.2.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
- Added OpenOrders to socketClient.FuturesApi.SubscribeToUserUpdatesAsync update model
- Fixed caching issue when using multiple environment in a single application
-
Version 2.1.1 - 10 Jun 2025
- Fixed HyperLiquidSymbolOrderBook Synced status being set before the book was actually synced
- Fixed signing issue placing orders with trailing zero's in the quantity
-
Version 2.1.0 - 02 Jun 2025
- Updated CryptoExchange.Net to version 9.1.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
- Added (I)HyperLiquidUserClientProvider allowing for easy client management when handling multiple users
-
Version 2.0.0 - 13 May 2025
- Updated CryptoExchange.Net to version 9.0.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
- Added support for Native AOT compilation
- Added RateLimitUpdated event
- Added SharedSymbol response property to all Shared interfaces response models returning a symbol name
- Added GenerateClientOrderId method to FuturesApi and Spot Shared clients
- Added IBookTickerRestClient implementation to SpotApi and FuturesApi Shared clients
- Added IFuturesOrderClientIdClient implementation to FuturesApi Shared client
- Added IFuturesTpSlRestClient implementation to FuturesApi Shared client
- Added ISpotOrderClientIdClient implementation to FuturesApi Shared client
- Added TriggerPrice, IsTriggerOrder properties to SharedSpotOrder model
- Added TriggerPrice, IsTriggerOrder properties to SharedFuturesOrder model
- Added MaxLongLeverage, MaxShortLeverage to SharedFuturesSymbol model
- Added QuoteVolume property mapping to SharedSpotTicker model
- Added OptionalExchangeParameters and Supported properties to EndpointOptions
- Added better error handling for unknown symbols
- Added vaultAddress parameter to various endpoints
- Added All property to retrieve all available environment on HyperLiquidEnvironment
- Added automatic mapping between UETH and ETH and UBTC and BTC spot asset and symbol names when using the Shared implementations
- Combined rest PlaceOrderAsync and PlaceTriggerOrderAsync methods for more flexibility
- Refactored Shared clients quantity parameters and responses to use SharedQuantity
- Updated all IEnumerable response and model types to array response types
- Removed Newtonsoft.Json dependency
- Removed Nethereum dependency
- Removed legacy AddHyperLiquid(restOptions, socketOptions) DI overload
- Fixed some typos
- Fixed missing Enum values for OrderType, Direction and TimeInForce enums
- Fixed market order price calculation
- Fixed incorrect DataTradeMode on certain Shared interface responses
- Fixed symbol name conversion not respecting environment setting
- Fixed DivideByZero exception in Shared ticker requests if PreviousDayPrice is 0
- Fixed various signing issues and response parsing issues
-
Version 2.0.0-beta3 - 01 May 2025
- Updated CryptoExchange.Net version to 9.0.0-beta5
- Added property to retrieve all available API environments
-
Version 2.0.0-beta2 - 23 Apr 2025
- Updated CryptoExchange.Net to version 9.0.0-beta2
- Added Shared spot ticker QuoteVolume mapping
- Fixed incorrect DataTradeMode on responses
-
Version 2.0.0-beta1 - 22 Apr 2025
- Updated CryptoExchange.Net to version 9.0.0-beta1, see https://github.com/JKorf/CryptoExchange.Net/releases/
- Added support for Native AOT compilation
- Added RateLimitUpdated event
- Added SharedSymbol response property to all Shared interfaces response models returning a symbol name
- Added GenerateClientOrderId method to FuturesApi and Spot Shared clients
- Added IBookTickerRestClient implementation to SpotApi and FuturesApi Shared clients
- Added IFuturesOrderClientIdClient implementation to FuturesApi Shared client
- Added IFuturesTpSlRestClient implementation to FuturesApi Shared client
- Added ISpotOrderClientIdClient implementation to FuturesApi Shared client
- Added TriggerPrice, IsTriggerOrder properties to SharedSpotOrder model
- Added TriggerPrice, IsTriggerOrder properties to SharedFuturesOrder model
- Added MaxLongLeverage, MaxShortLeverage to SharedFuturesSymbol model
- Added OptionalExchangeParameters and Supported properties to EndpointOptions
- Added better error handling for unknown symbols
- Added vaultAddress parameter to various endpoints
- Combined rest PlaceOrderAsync and PlaceTriggerOrderAsync methods for more flexibility
- Refactored Shared clients quantity parameters and responses to use SharedQuantity
- Updated all IEnumerable response and model types to array response types
- Removed Newtonsoft.Json dependency
- Removed Nethereum dependency
- Removed legacy AddHyperLiquid(restOptions, socketOptions) DI overload
- Fixed some typos
- Fixed symbol name conversion not respecting environment setting
- Fixed DivideByZero exception in Shared ticker requests if PreviousDayPrice is 0
- Fixed various signing issues and response parsing issues
-
Version 1.1.2 - 28 Mar 2025
- Fix testnet support
-
Version 1.1.1 - 22 Mar 2025
- Fixed deserialization of spot exchange info
-
Version 1.1.0 - 11 Feb 2025
- Updated CryptoExchange.Net to version 8.8.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
- Added support for more SharedKlineInterval values
- Added setting of DataTime value on websocket DataEvent updates
- Fix Mono runtime exception on rest client construction using DI
-
Version 1.0.1 - 22 Jan 2025
- Added DisplayName and ImageUrl to HyperLiquidExchange class
- Update HyperLiquidOptions object to make use of LibraryOptions base class
-
Version 1.0.0 - 21 Jan 2025
- Initial release