Upbit.Net is a client library for accessing the Upbit 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 clients based on the CryptoExchange.Net base library
- Native AOT support
The Upbit.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 JKorf.Upbit.Net
Upbit.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.
Basic request:
// Get the ETH/USDT ticker via rest request
var restClient = new UpbitRestClient();
var tickerResult = await restClient.SpotApi.ExchangeData.GetTickerAsync("USDT-ETH");
var lastPrice = tickerResult.Data.LastPrice;WebSocket subscription:
// Subscribe to ETH/USDT ticker updates via the websocket API
var socketClient = new UpbitSocketClient();
var tickerSubscriptionResult = socketClient.SpotApi.SubscribeToTickerUpdatesAsync("USDT-ETH", (update) =>
{
var lastPrice = update.Data.LastPrice;
});For more examples and explanations, continue with the Upbit.Net documentation or browse the compilable repository examples.
Upbit.Net includes AI-oriented documentation and examples for code generation tools:
| File | Purpose |
|---|---|
AGENTS.md |
Assistant skill with core Upbit.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 REST, WebSocket, regional environments, 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. IUpbitSharedApiClient groups the exchange's Shared API surfaces for dependency injection and runtime capability lookup.
using Upbit.Net.Clients;
using CryptoExchange.Net.SharedApis;
using var restClient = new UpbitRestClient();
IGetTickerRest tickerClient = restClient.SpotApi.SharedApi;
var symbol = new SharedSymbol(TradingMode.Spot, "ETH", "USDT");
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 IUpbitSharedApiClient 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.
Upbit.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 | |
| 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 | |
| HyperLiquid | JKorf/HyperLiquid.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 | |
| 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.
| API | Supported | Location |
|---|---|---|
| Quotation API | ✓ | restClient.SpotApi.ExchangeData |
| Exchange API | X |
| API | Supported | Location |
|---|---|---|
| Public API | ✓ | socketClient.SpotApi |
| Private API | X |
Any support is greatly appreciated.
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 3.5.0 - 24 Sep 2026
- Updated CryptoExchange.Net to v13.0.0
- Shared APIs
- Added SharedApi V2 support
- Added
.SharedApiproperty to clients - Added
(I)UpbitSharedApiClientcontaining all V2 SharedApi references - Added
SharedApitoUpbitOptionsto 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
-
Version 3.4.0 - 21 Aug 2026
- Updated to CryptoExchange.Net v12.5.0
-
Version 3.3.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
- Added BaseAssetType Shared asset type mapping logic
- Updated SharedFuturesTicker, SharedSpotTicker, SharedTrade and SharedKline to use SharedOrderQuantity for volumes/quantities
-
Version 3.2.0 - 21 Jul 2026
- Updated CryptoExchange.Net to v12.2.0
- Added SpotSymbolCatalog to Shared ISpotSymbolRestClient interface
- Added BaseAssetType, BaseAssetSubType, QuoteAssetType and QuoteAssetSubType to GetSymbolsRequest model
- Added DisplayName to SharedSpotSymbol models
- Added BaseAssetType, BaseAssetSubType, QuoteAssetType and QuoteAssetSubType to SharedSpotSymbol models
- Added DebuggerDisplay attributes to Shared models
-
Version 3.1.0 - 09 Jul 2026
- Updated CryptoExchange.Net to v12.1.0
- Added PrevClosingPrice, ChangePrice and ChangePercentage to UpbitKline model
-
Version 3.0.0 - 29 Jun 2026
- Result types:
- (Web)CallResult types are replaced by HttpResult and WebSocketResult with the same logic
- WebSocketResult 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 SupportedEnvironments property to PlatformInfo
- Added setter to UpbitExchange.RateLimiter to allow custom rate limit settings
- Various small performance improvements
- Fixed websocket connection attempts counting towards rate limit even when server could not be reached
- Result types: