HyperLiquid.Net
1.0.1
dotnet add package HyperLiquid.Net --version 1.0.1
NuGet\Install-Package HyperLiquid.Net -Version 1.0.1
<PackageReference Include="HyperLiquid.Net" Version="1.0.1" />
paket add HyperLiquid.Net --version 1.0.1
#r "nuget: HyperLiquid.Net, 1.0.1"
// Install HyperLiquid.Net as a Cake Addin #addin nuget:?package=HyperLiquid.Net&version=1.0.1 // Install HyperLiquid.Net as a Cake Tool #tool nuget:?package=HyperLiquid.Net&version=1.0.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
- Automatic websocket (re)connection management
- Client side rate limiting
- Cient side order book implementation
- Extensive logging
- Support for different environments
- Easy integration with other exchange client based on the CryptoExchange.Net base library
Supported Frameworks
The library is targeting both .NET Standard 2.0
and .NET Standard 2.1
for optimal compatibility
.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
- 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.
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 |
---|---|---|
Binance | JKorf/Binance.Net | |
BingX | JKorf/BingX.Net | |
Bitfinex | JKorf/Bitfinex.Net | |
Bitget | JKorf/Bitget.Net | |
BitMart | JKorf/BitMart.Net | |
Bybit | JKorf/Bybit.Net | |
Coinbase | JKorf/Coinbase.Net | |
CoinEx | JKorf/CoinEx.Net | |
CoinGecko | JKorf/CoinGecko.Net | |
Crypto.com | JKorf/CryptoCom.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 | |
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.
Supported functionality
Rest
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
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 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
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 was computed. 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 was computed. 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. |
.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 (>= 8.7.0)
- Nethereum.Signer.EIP712 (>= 4.28.0)
-
.NETStandard 2.1
- CryptoExchange.Net (>= 8.7.0)
- Nethereum.Signer.EIP712 (>= 4.28.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on HyperLiquid.Net:
Package | Downloads |
---|---|
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
This package is not used by any popular GitHub repositories.