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
- 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
The HyperLiquid.Net documentation is the main resource for installing, configuring, and using the library.
| Resource | Description |
|---|---|
| Client guide | Installation, REST and WebSocket clients, authentication, dependency injection, error handling, and advanced features |
| Examples | Common REST and WebSocket operations |
| API reference | Client interfaces, methods, and properties |
| Shared API guide | Common interfaces and models for working with multiple exchanges |
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 |
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
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 more examples and explanations, continue with the HyperLiquid.Net documentation or browse the compilable repository examples.
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.
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.
The CryptoExchange.Net Shared API V2 provides exchange-agnostic interfaces and models for common operations such as retrieving tickers, order books and balances, placing orders, and subscribing to market updates.
V2 uses a strict interface per capability. The SharedApi property on each API surface therefore exposes only the operations or subscriptions that surface actually supports. IHyperLiquidSharedApiClient groups the exchange's Shared API surfaces for dependency injection and runtime capability lookup.
using HyperLiquid.Net.Clients;
using CryptoExchange.Net.SharedApis;
using var restClient = new HyperLiquidRestClient();
IGetTickerRest tickerClient = restClient.SpotApi.SharedApi;
var symbol = new SharedSymbol(TradingMode.Spot, "HYPE", "USDC");
var result = await tickerClient.GetTickerAsync(
new GetTickerRequest(symbol));
if (!result.Success)
{
Console.WriteLine(result.Error);
return;
}
Console.WriteLine(result.Data.LastPrice);The request and response models belong to CryptoExchange.Net.SharedApis, so the same operation can accept another exchange's IGetTickerRest implementation. When using dependency injection, inject IHyperLiquidSharedApiClient to access all of the exchange's Shared API surfaces or inject a capability such as IGetTickerRest directly. Use GetCapability on the aggregate when the operation, transport, or trading mode is selected at runtime.
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 provides shared access to different exchange APIs.
| Exchange | Repository | Nuget |
|---|---|---|
| Aster | JKorf/Aster.Net | |
| Binance | JKorf/Binance.Net | |
| BingX | JKorf/BingX.Net | |
| Bitfinex | JKorf/Bitfinex.Net | |
| Bitget | JKorf/Bitget.Net | |
| Bitstamp | JKorf/Bitstamp.Net | |
| Bitunix | JKorf/Bitunix.Net | |
| BloFin | JKorf/BloFin.Net | |
| Bybit | JKorf/Bybit.Net | |
| Coinbase | JKorf/Coinbase.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 | |
| LBank | JKorf/LBank.Net | |
| Lighter | JKorf/Lighter.Net | |
| Mexc | JKorf/Mexc.Net | |
| OKX | JKorf/OKX.Net | |
| Pionex | JKorf/Pionex.Net | |
| Polymarket | JKorf/Polymarket.Net | |
| Tapbit | JKorf/Tapbit.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.
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] }
};
}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 |
| 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 in a different currency or network send me a message.
USDT (TRX) TKigKeJPXZYyMVDgMyXxMf17MWYia92Rjd
Alternatively, sponsor me on Github using Github Sponsors.
-
Version 5.10.0 - 06 Nov 2026
- Updated CryptoExchange.Net to v13.2.3
- Added CryptoExchange.Net.Web3 dependency
- Updated HyperLiquidCredentials to use EthKey credentials instead of ECDsaCredential
- EthKey passing: new HyperLiquidCredential(new HyperLiquidCredential(EthKey.FromPrivateKey(""))
- Added SubscribeToAllDexTickerUpdatesAsync ExchangeData subscription
- Fixed fast order book subscription acknowledgement matching
-
Version 5.9.1 - 14 Oct 2026
- Updated websocket error message handling, fixing not recognized error message on invalid credentials
-
Version 5.9.0 - 30 Sep 2026
- Updated CryptoExchange.Net to V13.1.0
- Added ClientOrderId mapping to Shared API SubscribeToUserTradeUpdatesAsync updates
-
Version 5.8.0 - 24 Sep 2026
- Updated CryptoExchange.Net to v13.0.0
- Shared APIs
- Added SharedApi V2 support
- Added
.SharedApiproperty to clients - Added
(I)HyperLiquidSharedApiClientcontaining all V2 SharedApi references - Added
SharedApitoHyperLiquidOptionsto provide SharedApi related options - See https://cryptoexchange.jkorf.dev/docs/shared-api?sharedApiVersion=v2 for more info about the V2 update and https://github.com/JKorf/CryptoExchange.Net/blob/master/docs/SHARED_API_V2_MIGRATION.md for migrating from V1
- SharedApi V1 will still be supported
- Rate limiting
- Added rate limit admission callback to client options to allow rate limit admission ruling on request definition
- Added
WithRateLimitAdmissionAsyncto client to allow rate limit admission ruling on a specific request - Update rate limit safety margin logic
- Fixed some rate limit calculation issues
- Request coalescing
- Sending identical public GET requests on the same client at the same time will only send a single request to the server and use the same response
- Coalescing is enabled by default and can be disabled with the
RequestCoalescingEnabledclient option
- Added Settlement value to Direction enum
- Added ApproveAgentAsync and RemoveAgentAsync endpoints
-
Version 5.7.0 - 21 Aug 2026
- Updated to CryptoExchange.Net v12.5.0
- Added the MarginRestrictionMode to HyperLiquidFuturesSymbol model
- Added SpotHold to HyperLiquidBalance model
- Added Shared ISpotOrderManagementSocketClient, IFuturesOrderManagementSocketClient implementations
- Updated some socket connection logic to make it easier to combine socket connections
-
Version 5.6.0 - 14 Aug 2026
- Updated restClient.SpotApi.Account.GetBalancesAsync to return full balance response instead of only the nested Balances. Update
DatatoData.Balancesto maintain the exact same behavior as previous version. - Fixed rate limit weights on various endpoints
- Updated restClient.SpotApi.Account.GetBalancesAsync to return full balance response instead of only the nested Balances. Update
-
Version 5.5.0 - 12 Aug 2026
- Added fast parameter to SubscribeToOrderBookUpdatesAsync subscription
- Fixed builder code logic for multi-user
-
Version 5.4.0 - 29 Jul 2026
- Updated CryptoExchange.Net to version 12.4.0
- Added calculation of AveragePrice on Shared order models if data is available and AveragePrice is not set
- Added DebuggerDisplay attributes to Result models
- Added AveragePrice property to SharedQuantity model
- Updated SharedFuturesTicker, SharedSpotTicker, SharedTrade and SharedKline to use SharedOrderQuantity for volumes/quantities
-
Version 5.3.0 - 21 Jul 2026
- Updated CryptoExchange.Net to v12.2.0
- Added SpotSymbolCatalog to Shared ISpotSymbolRestClient interface
- Added FuturesSymbolCatalog to Shared IFuturesSymbolRestClient interface
- Added BaseAssetType, BaseAssetSubType, QuoteAssetType and QuoteAssetSubType to GetSymbolsRequest model
- Added DisplayName to SharedSpotSymbol and SharedFuturesSymbol models
- Added BaseAssetType, BaseAssetSubType, QuoteAssetType and QuoteAssetSubType to SharedSpotSymbol and SharedFuturesSymbol models
- Added DebuggerDisplay attributes to Shared models
- Added Account.GetUserPortfolioAsync endpoint
- Added restClient.FuturesApi.ExchangeData.GetPerpAnnotationAsync endpoint
- Added restClient.FuturesApi.ExchangeData.GetPerpCategoriesAsync endpoint
- Added restClient.FuturesApi.ExchangeData.GetPerpConciseAnnotationsAsync endpoint
- Updated client.SpotApi.Account.GetSubAccounts2Async response model
- Fixed deserialization issue websocket responses using HyperLiquidDefault type
-
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: