XT.Net
4.6.0
dotnet add package XT.Net --version 4.6.0
NuGet\Install-Package XT.Net -Version 4.6.0
<PackageReference Include="XT.Net" Version="4.6.0" />
<PackageVersion Include="XT.Net" Version="4.6.0" />
<PackageReference Include="XT.Net" />
paket add XT.Net --version 4.6.0
#r "nuget: XT.Net, 4.6.0"
#:package XT.Net@4.6.0
#addin nuget:?package=XT.Net&version=4.6.0
#tool nuget:?package=XT.Net&version=4.6.0
XT.Net
XT.Net is a client library for accessing the XT 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
Documentation
The XT.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 |
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 XT.Net
GitHub packages
XT.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
Basic request:
// Get the ETH/USDT ticker via rest request
var restClient = new XTRestClient();
var tickerResult = await restClient.SpotApi.ExchangeData.GetTickersAsync("eth_usdt");
var lastPrice = tickerResult.Data.Single().LastPrice;
Place order:
var restClient = new XTRestClient(opts => {
opts.ApiCredentials = new XTCredentials("APIKEY", "APISECRET");
});
// Place Limit order to go long 0.1 for ETH at 2000
var orderResult = await restClient.UsdtFuturesApi.Trading.PlaceOrderAsync(
"ETH_USDT",
OrderSide.Buy,
OrderType.Limit,
0.1m,
PositionSide.Long,
2000
);
WebSocket subscription:
// Subscribe to ETH/USDT ticker updates via the websocket API
var socketClient = new XTSocketClient();
var tickerSubscriptionResult = socketClient.SpotApi.SubscribeToTickerUpdatesAsync("eth_usdt", (update) =>
{
var lastPrice = update.Data.LastPrice;
});
For more examples and explanations, continue with the XT.Net documentation or browse the compilable repository examples.
AI / LLM documentation
XT.Net includes AI-oriented documentation and examples for code generation tools:
| File | Purpose |
|---|---|
AGENTS.md |
Assistant skill with core XT.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, USDT-M Futures, Coin-M 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.
Shared / unified API
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. IXTSharedApiClient groups the exchange's Shared API surfaces for dependency injection and runtime capability lookup.
Access a strict capability
using XT.Net.Clients;
using CryptoExchange.Net.SharedApis;
using var restClient = new XTRestClient();
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 IXTSharedApiClient 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.
CryptoExchange.Net
XT.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 | |
| Upbit | JKorf/Upbit.Net | |
| WhiteBit | JKorf/WhiteBit.Net |
When using multiple of these API's the CryptoClients.Net package can be used instead 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
Spot REST
| API | Supported | Location |
|---|---|---|
| Market | ✓ | restClient.SpotApi.ExchangeData |
| Order | ✓ | restClient.SpotApi.Trading |
| Trade | ✓ | restClient.SpotApi.Trading |
| Balance | ✓ | restClient.SpotApi.Account |
| Deposit/Withdrawal | ✓ | restClient.SpotApi.Account |
| Transfer | ✓ | restClient.SpotApi.Account |
Spot Websocket
| API | Supported | Location |
|---|---|---|
| Public | ✓ | socketClient.SpotApi |
| Private | ✓ | socketClient.SpotApi |
USDT-M Futures REST
| API | Supported | Location |
|---|---|---|
| Market data | ✓ | restClient.UsdtFuturesApi.ExchangeData |
| Quote collection | ✓ | restClient.UsdtFuturesApi.ExchangeData |
| Order | ✓ | restClient.UsdtFuturesApi.Trading |
| Entrust | ✓ | restClient.UsdtFuturesApi.Trading |
| User | ✓ | restClient.UsdtFuturesApi.Account / restClient.UsdtFuturesApi.Trading |
COIN-M Futures REST
| API | Supported | Location |
|---|---|---|
| Market data | ✓ | restClient.CoinFuturesApi.ExchangeData |
| Quote collection | ✓ | restClient.CoinFuturesApi.ExchangeData |
| Order | ✓ | restClient.CoinFuturesApi.Trading |
| Entrust | ✓ | restClient.CoinFuturesApi.Trading |
| User | ✓ | restClient.CoinFuturesApi.Account / restClient.CoinFuturesApi.Trading |
Futures Websocket
| API | Supported | Location |
|---|---|---|
| Public | ✓ | socketClient.FuturesApi |
| Private | ✓ | socketClient.FuturesApi |
Margin
| API | Supported | Location |
|---|---|---|
| * | X |
Copy Trading
| API | Supported | Location |
|---|---|---|
| * | X |
Support the project
Any support is greatly appreciated.
Referal
If you do not yet have an account please consider using this referal link to sign up:
Link
Donate
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
Sponsor
Alternatively, sponsor me on Github using Github Sponsors.
Release notes
Version 4.6.0 - 24 Sep 2026
- Updated CryptoExchange.Net to v13.0.0
- Shared APIs
- Added SharedApi V2 support
- Added
.SharedApiproperty to clients - Added
(I)XTSharedApiClientcontaining all V2 SharedApi references - Added
SharedApitoXTOptionsto provide SharedApi related options - Added GetUserFundingHistoryAsync implementation to Shared Futures REST API
- Added GetFundingInfoAsync implementation to Shared Futures REST API
- Added EditFuturesOrderAsync implementation to Shared Futures REST API
- Added CancelAllFuturesOrdersAsync implementation to Shared Futures REST API
- Added CancelAllFuturesSymbolOrdersAsync implementation to Shared Futures REST API
- Added PlaceMultipleFuturesOrdersAsync implementation to Shared Futures REST API
- Added GetAllIndexPricesAsync and GetIndexPriceAsync implementation to Shared Futures REST API
- Added GetAllMarkPricesAsync and GetMarkPriceAsync implementation to Shared Futures REST API
- Added GetLedgerAsync implementation to Shared Futures REST API
- Added GetLeverageTiersAsync implementation to Shared Futures REST API
- Added SubscribeToIndexPriceUpdatesAsync implementation to Shared Futures Socket API
- Added SubscribeToMarkPriceUpdatesAsync implementation to Shared Futures Socket API
- Added EditSpotOrderAsync implementation to Shared Spot REST API
- Added CancelAllSpotOrdersAsync implementation to Shared Spot REST API
- Added CancelAllSpotSymbolOrdersAsync implementation to Shared Spot REST API
- 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 PartiallyCanceled to OrderStatus Enum
- Added OpenOrderFeeFrozen to XTFutuersBalanceUpdate model
- Updated AveragePrice to nullable in XTFuturesOrder model
- Updated UnrealizedPnl to nullable in XTPosition model
- Fixed REST Futures API CancelAllOrdersAsync request when not providing a symbol
- Fixed
idparameter not getting send with Futures GetAccountBillsAsync - Fixed Futures SubscribeToFundingRateUpdatesAsync subscribing to incorrect topic
Version 4.5.0 - 21 Aug 2026
- Updated to CryptoExchange.Net v12.5.0
- Added MaxTradeQuantity, MakerFeePercentage, TakerFeePercentage, MaxLongLeverage, MaxShortLeverage, UpperPriceLimitPercentage, LowerPriceLimitPercentage to SharedFuturesSymbol mapping
Version 4.4.0 - 14 Aug 2026
- Added restClient.UsdtFuturesApi.Account.GetLeverageInfoAsync and Trading.GetUserTradeDetailsAsync endpoints
- Updated network parameter to optional for GetDepositHistoryAsync and GetWithdrawalHistoryAsync endpoints
- Updated error mapping to output message code for unmapped errors
- Fixed restClient.UsdtFuturesApi.Trading.GetOpenOrdersAsync endpoint
Version 4.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 BusinessNameDefault property to XTFuturesSymbol model
- Updated SharedFuturesTicker, SharedSpotTicker, SharedTrade and SharedKline to use SharedOrderQuantity for volumes/quantities
Version 4.2.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
- Updated NeedsMemo on XTAsset to nullable
Version 4.1.0 - 09 Jul 2026
- Updated CryptoExchange.Net to v12.1.0
- Updated response models based on observed returned values
- Fixed documentation links
Version 4.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
- Removed IListenKey support, listen keys now rely on internal management
- Fixed Shared Futures GetOpenFuturesOrdersAsync not returning partially filled orders
- Added futures GetOpenOrdersAsync endpoint
- Added async streaming on UserDataTracker items with StreamUpdatesAsync
- Added cancellation token support to UserDataTracker starting
- Added SupportedEnvironments property to PlatformInfo
- Added Clear() method on UserClientProvider to clear all cached clients
- Added setter to XTExchange.RateLimiter to allow custom rate limit settings
- Updated user subscription overloads without listenkey, now uses internal token manager
- Various small performance improvements
- Fixed websocket connection attempts counting towards rate limit even when server could not be reached
- 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 (>= 13.0.0)
-
.NETStandard 2.1
- CryptoExchange.Net (>= 13.0.0)
-
net10.0
- CryptoExchange.Net (>= 13.0.0)
-
net8.0
- CryptoExchange.Net (>= 13.0.0)
-
net9.0
- CryptoExchange.Net (>= 13.0.0)
NuGet packages (2)
Showing the top 2 NuGet packages that depend on XT.Net:
| Package | Downloads |
|---|---|
|
CryptoClients.Net
Access 30 cryptocurrency exchanges through one Shared API and reusable, exchange-agnostic code, while retaining full access to each exchange's complete API. Supports Binance, Bybit, Hyperliquid, and many more. |
|
|
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 XT.Net:
| Repository | Stars |
|---|---|
|
JKorf/CryptoExchange.Net
A C# .netstandard base library used for implementing cryptocurrency exchange API's.
|
| Version | Downloads | Last Updated |
|---|---|---|
| 4.6.0 | 27 | 9/24/2026 |
| 4.5.0 | 1,530 | 8/21/2026 |
| 4.4.0 | 179 | 8/14/2026 |
| 4.3.0 | 1,542 | 7/29/2026 |
| 4.2.0 | 320 | 7/21/2026 |
| 4.1.0 | 762 | 7/9/2026 |
| 4.0.0 | 861 | 6/29/2026 |
| 3.11.0 | 188 | 6/8/2026 |
| 3.10.0 | 958 | 5/26/2026 |
| 3.9.2 | 2,015 | 4/9/2026 |
| 3.9.1 | 760 | 3/24/2026 |
| 3.9.0 | 128 | 3/24/2026 |
| 3.8.0 | 525 | 3/6/2026 |
| 3.7.0 | 2,388 | 2/24/2026 |
| 3.6.0 | 809 | 2/16/2026 |
| 3.5.0 | 357 | 2/10/2026 |
| 3.4.0 | 144 | 2/6/2026 |
| 3.3.0 | 1,357 | 1/22/2026 |
| 3.2.2 | 235 | 1/19/2026 |
| 3.2.1 | 261 | 1/14/2026 |