HyperLiquid.Net
5.2.1
dotnet add package HyperLiquid.Net --version 5.2.1
NuGet\Install-Package HyperLiquid.Net -Version 5.2.1
<PackageReference Include="HyperLiquid.Net" Version="5.2.1" />
<PackageVersion Include="HyperLiquid.Net" Version="5.2.1" />
<PackageReference Include="HyperLiquid.Net" />
paket add HyperLiquid.Net --version 5.2.1
#r "nuget: HyperLiquid.Net, 5.2.1"
#:package HyperLiquid.Net@5.2.1
#addin nuget:?package=HyperLiquid.Net&version=5.2.1
#tool nuget:?package=HyperLiquid.Net&version=5.2.1
HyperLiquid.Net
HyperLiquid.Net is a client library for accessing the HyperLiquid DEX REST and Websocket API.
Features
- Response data is mapped to descriptive models
- Input parameters and response values are mapped to discriptive enum values where possible
- High performance
- 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
Supported Frameworks
The library is targeting both .NET Standard 2.0 and .NET Standard 2.1 for optimal compatibility, as well as the latest dotnet versions 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 |
Install the library
NuGet
dotnet add package HyperLiquid.Net
GitHub packages
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.
Download release
The NuGet package files are added along side the source with the latest GitHub release which can found here.
How to use
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
Basic request:
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;
Place order:
var restClient = new HyperLiquidRestClient(opts => {
opts.ApiCredentials = new HyperLiquidCredentials("PUBLICKEY", "PRIVATEKEY");
});
// Place Limit order to go long for 0.1 ETH at 2000
var orderResult = await restClient.FuturesApi.Trading.PlaceOrderAsync(
"ETH",
OrderSide.Buy,
OrderType.Limit,
0.1m,
2000
);
WebSocket subscription:
// 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.
NOTE
HyperLiquid.Net uses the Builder Code mechanism for HyperLiquid, which means that an additional 1bps / 0.01% fee is charged on top of orders placed with the library to fund development. This is entirely optional and can be disabled in the client options by setting BuilderFeePercentage to 0 or null in the client options.
AI / LLM documentation
HyperLiquid.Net includes AI-oriented documentation and examples for code generation tools:
| File | Purpose |
|---|---|
AGENTS.md |
Assistant skill with core HyperLiquid.Net patterns, pitfalls, and examples |
llms.txt |
Short LLM index with links to docs, examples, and critical usage rules |
llms-full.txt |
Detailed LLM context with endpoint routing, code patterns, and anti-hallucination checks |
docs/ai-api-map.md |
Table-style intent-to-method map for Spot, Futures, WebSocket, and SharedApis |
Examples/ai-friendly |
Compilable single-file examples for common REST, WebSocket, shared API, and error handling workflows |
See cryptoexchange-skills-hub for installable skills.
CryptoExchange.Net
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 |
|---|---|---|
| Aster | JKorf/Aster.Net | |
| Binance | JKorf/Binance.Net | |
| BingX | JKorf/BingX.Net | |
| Bitfinex | JKorf/Bitfinex.Net | |
| Bitget | JKorf/Bitget.Net | |
| BitMart | JKorf/BitMart.Net | |
| BitMEX | JKorf/BitMEX.Net | |
| Bitstamp | JKorf/Bitstamp.Net | |
| BloFin | JKorf/BloFin.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 | |
| Lighter | JKorf/Lighter.Net | |
| Mexc | JKorf/Mexc.Net | |
| OKX | JKorf/OKX.Net | |
| Polymarket | JKorf/Polymarket.Net | |
| Toobit | JKorf/Toobit.Net | |
| Upbit | JKorf/Upbit.Net | |
| Weex | JKorf/Weex.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.
Discord
A Discord server is available here. For discussion and/or questions around the CryptoExchange.Net and implementation libraries, feel free to join.
OSX Support
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] }
};
}
Supported functionality
Rest & WebSocket
Requests are available on both the WebSocket and REST client
| 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 |
Websocket streams
| API | Supported | Location |
|---|---|---|
| * | ✓ | socketClient.SpotApi / socketClient.FuturesApi |
Support the project
Any support is greatly appreciated.
Referral
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.
Donate
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
Sponsor
Alternatively, sponsor me on Github using Github Sponsors.
Release notes
Version 5.2.1 - 13 Jul 2026
- Fixed deserialization for EditOrderAsync, ToggleHip3DexAbstractionAsync, SetLeverageAsync and UpdateIsolatedMarginAsync websocket requests when response is an error
Version 5.2.0 - 09 Jul 2026
- Updated CryptoExchange.Net to v12.1.0
Version 5.1.0 - 07 Jul 2026
- Added restClient.SpotApi.Account.GetSubAccounts2Async endpoint
- Added CollateralTokenIndex and CollateralToken to HyperLiquidFuturesDexInfo model
- Added ClientOrderId to HyperLiquidUserTrade model
- Added DeployerTradingFeeShare to HyperLiquidAsset model
- Added RequestSurplus to HyperLiquidRateLimit model
- Updated futures GetExchangeInfoAsync response type to HyperLiquidFuturesDexInfo
- Fixed EditOrdersAsync using ClientOrderId instead of NewClientOrderId for the replacement order
Version 5.0.0 - 29 Jun 2026
- Result types:
- (Web)CallResult types are replaced by HttpResult, WebSocketResult and QueryResult with the same logic
- WebSocketResult and QueryResult now return additional info for websocket operations
- Updated result types to record type
- Removed implicit result type conversion to bool,
if (result)no longer works, instead useif (result.Success) - Fixed result object nullability hinting, for example Data might be null if Success isn't checked for true
- Clients:
- Added ToString overrides on base API types
- Added Exchange property on BaseApiClient
- Added ApiCredentials property on Api clients
- Updated ILogger source from client name to topic specific client name
- Removed logging from client creation
- Fixed issue in SocketApiClient.GetSocketConnection causing requests to always wait the full max 10 seconds when there was a reconnecting socket
- Shared APIs:
- Added missing dedicated option types
- Added Discover method on ISharedClient interface, returning info on supported capabilities and operations
- Added ResetStaticExchangeParameters method on ExchangeParameters
- Added Status property to SharedWithdrawal model
- Added TradingModes property to SharedBalance model
- Updated Shared ExchangeParameters parameter names to be case insensitive
- Updated code comments
- Replaced ExchangeResult with ExchangeCallResult type
- Removed TradingMode from the response model, only maintained on models where it makes sense
- Added alwaysPlace parameter to EditOrderAsync endpoints
- Added async streaming on UserDataTracker items with StreamUpdatesAsync
- Added cancellation token support to UserDataTracker starting
- Added SupportedEnvironments property to PlatformInfo
- Added setter to HyperLiquidExchange.RateLimiter to allow custom rate limit settings
- Added Clear() method on UserClientProvider to clear all cached clients
- Updated HyperLiquidPositionUpdate internal Data type
- Various small performance improvements
- Marked SubscribToUserUpdatesAsync as obsolete
- Fixed websocket connection attempts counting towards rate limit even when server could not be reached
- Fixed websocket user data update filtering based on address
- Result types:
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 is compatible. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- CryptoExchange.Net (>= 12.1.0)
- Secp256k1.Net (>= 2.0.0)
-
.NETStandard 2.1
- CryptoExchange.Net (>= 12.1.0)
- Secp256k1.Net (>= 2.0.0)
-
net10.0
- CryptoExchange.Net (>= 12.1.0)
- Secp256k1.Net (>= 2.0.0)
-
net8.0
- CryptoExchange.Net (>= 12.1.0)
- Secp256k1.Net (>= 2.0.0)
-
net9.0
- CryptoExchange.Net (>= 12.1.0)
- Secp256k1.Net (>= 2.0.0)
NuGet packages (2)
Showing the top 2 NuGet packages that depend on HyperLiquid.Net:
| Package | Downloads |
|---|---|
|
CryptoClients.Net
CryptoClients.Net offers full easy access to 28 different cryptocurrency exchange API's, such as Binance, Bybit, HyperLiquid and many more. It offers a unified way to access the API's and tools to dynamically call endpoints on different exchanges. |
|
|
Le.CryptoClients.Net
CryptoClients.Net is a collection of multiple cryptocurrency exchange API clients for accessing both the REST API's and WebSocket API's. Supports order and account management and requesting and streaming both public and private data. |
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on HyperLiquid.Net:
| Repository | Stars |
|---|---|
|
JKorf/CryptoExchange.Net
A C# .netstandard base library used for implementing cryptocurrency exchange API's.
|
| Version | Downloads | Last Updated |
|---|---|---|
| 5.2.1 | 146 | 7/13/2026 |
| 5.2.0 | 257 | 7/9/2026 |
| 5.1.0 | 166 | 7/7/2026 |
| 5.0.0 | 662 | 6/29/2026 |
| 4.8.0 | 718 | 6/8/2026 |
| 4.7.1 | 943 | 6/2/2026 |
| 4.7.0 | 605 | 6/1/2026 |
| 4.6.1 | 1,098 | 5/29/2026 |
| 4.6.0 | 308 | 5/26/2026 |
| 4.5.1 | 598 | 5/12/2026 |
| 4.5.0 | 520 | 5/1/2026 |
| 4.4.1 | 1,136 | 4/28/2026 |
| 4.4.0 | 154 | 4/24/2026 |
| 4.3.0 | 992 | 4/9/2026 |
| 4.2.1 | 307 | 4/2/2026 |
| 4.2.0 | 162 | 3/31/2026 |
| 4.1.0 | 161 | 3/26/2026 |
| 4.0.1 | 1,075 | 3/24/2026 |
| 4.0.0 | 141 | 3/24/2026 |
| 3.10.0 | 1,272 | 3/6/2026 |