XT.Net

May 9, 2026 · View on GitHub

.NET License

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

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 implementationVersion Support
.NET Core2.0 and higher
.NET Framework4.6.1 and higher
Mono5.4 and higher
Xamarin.iOS10.14 and higher
Xamarin.Android8.0 and higher
UWP10.0.16299 and higher
Unity2018.1 and higher

Install the library

NuGet

NuGet version Nuget downloads

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

GitHub 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 information on the clients, dependency injection, response processing and more see the documentation, or have a look at the examples here or here.

AI / LLM documentation

XT.Net includes AI-oriented documentation and examples for code generation tools:

FilePurpose
AGENTS.mdAssistant skill with core XT.Net patterns, pitfalls, and examples
llms.txtShort LLM index with links to docs, examples, and critical usage rules
llms-full.txtDetailed LLM context with endpoint routing, code patterns, and anti-hallucination checks
docs/ai-api-map.mdTable-style intent-to-method map for Spot, USDT-M Futures, Coin-M Futures, WebSocket, and SharedApis
Examples/ai-friendlyCompilable single-file examples for common REST, WebSocket, shared API, and error handling workflows

GitHub Copilot and Cursor instructions are also provided in .github/copilot-instructions.md and .cursor/rules/xt-net.mdc; both point back to the root AI context files.

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 allows for easy access to different exchange API's.

ExchangeRepositoryNuget
AsterJKorf/Aster.NetNuget version
BinanceJKorf/Binance.NetNuget version
BingXJKorf/BingX.NetNuget version
BitfinexJKorf/Bitfinex.NetNuget version
BitgetJKorf/Bitget.NetNuget version
BitMartJKorf/BitMart.NetNuget version
BitMEXJKorf/BitMEX.NetNuget version
BitstampJKorf/Bitstamp.NetNuget version
BloFinJKorf/BloFin.NetNuget version
BybitJKorf/Bybit.NetNuget version
CoinbaseJKorf/Coinbase.NetNuget version
CoinExJKorf/CoinEx.NetNuget version
CoinGeckoJKorf/CoinGecko.NetNuget version
CoinWJKorf/CoinW.NetNuget version
Crypto.comJKorf/CryptoCom.NetNuget version
DeepCoinJKorf/DeepCoin.NetNuget version
Gate.ioJKorf/GateIo.NetNuget version
HTXJKorf/HTX.NetNuget version
HyperLiquidJKorf/HyperLiquid.NetNuget version
KrakenJKorf/Kraken.NetNuget version
KucoinJKorf/Kucoin.NetNuget version
MexcJKorf/Mexc.NetNuget version
OKXJKorf/OKX.NetNuget version
PolymarketJKorf/Polymarket.NetNuget version
ToobitJKorf/Toobit.NetNuget version
WeexJKorf/Weex.NetNuget version
UpbitJKorf/Upbit.NetNuget version
WhiteBitJKorf/WhiteBit.NetNuget version

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

Nuget version
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

APISupportedLocation
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

APISupportedLocation
Public✓socketClient.SpotApi
Private✓socketClient.SpotApi

USDT-M Futures REST

APISupportedLocation
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

APISupportedLocation
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

APISupportedLocation
Public✓socketClient.FuturesApi
Private✓socketClient.FuturesApi

Margin

APISupportedLocation
*X

Copy Trading

APISupportedLocation
*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

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

Alternatively, sponsor me on Github using Github Sponsors.

Release notes

  • Version 3.9.2 - 09 Apr 2026

  • Version 3.9.1 - 24 Mar 2026

    • Fix issue in credentials copying

  • Version 3.9.0 - 24 Mar 2026

    • Updated CryptoExchange.Net to version 11.0.1, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes

    • Updated class for supplying API credentials from ApiCredentials to XTCredentials

    • Updated Shared order status parsing to default to Unknown value if not parsable

    • Notes for updating:

      • Update ApiCredentials to XTCredentials for authentication, i.e. ApiCredentials = new ApiCredentials(..) => ApiCredentials = new XTCredentials(..)

  • Version 3.8.0 - 06 Mar 2026

  • Version 3.7.0 - 24 Feb 2026

    • Updated CryptoExchange.Net to version 10.7.0
    • Added additional Http settings to client options
    • Updated Shared REST interfaces pagination logic
    • Updated HttpClient registration, fixing issue of DNS changes not getting processed
    • Fixed UserClientProvider using unconfigured HttpClient

  • Version 3.6.0 - 16 Feb 2026

  • Version 3.5.0 - 10 Feb 2026

  • Version 3.4.0 - 06 Feb 2026

    • Updated CryptoExchange.Net to version 10.4.0, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
    • Added XTUserSpotDataTracker and XTUserUsdtFuturesDataTracker
    • Added additional methods for requesting supported symbols to Shared ISpotSymbolRestClient/IFuturesSymbolRestClient interfaces
    • Added PositionMode mapping on SharedPosition models
    • Added Status mapping for SharedDeposit models
    • Fixed disposed clients getting returned from UserClientProvider

  • Version 3.3.0 - 22 Jan 2026

  • Version 3.2.2 - 19 Jan 2026

  • Version 3.2.1 - 14 Jan 2026

  • Version 3.2.0 - 13 Jan 2026

  • Version 3.1.0 - 07 Jan 2026

    • Updated CryptoExchange.Net version to 10.1.0, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
    • Added DataTimeLocal and DataAge properties to DataEvent object
    • Added UpdateServerTime, UpdateLocalTime and DataAge properties to (I)SymbolOrderBook

  • Version 3.0.1 - 18 Dec 2025

    • Fixed message routing for UsdtFuturesApi order book subscription
    • Fixed deserialization error on some endpoints when error is returned

  • Version 3.0.0 - 16 Dec 2025

    • Added Net10.0 target framework
    • Updated CryptoExchange.Net version to 10.0.0, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
    • Improved performance across the board, biggest gains in websocket message processing
    • Updated REST message response handling
    • Updated WebSocket message handling
    • Added UseUpdatedDeserialization socket client options to toggle by new and old message handling
    • Added SocketIndividualSubscriptionCombineTarget socket client option
    • Updated Shared API's subscription update types from ExchangeEvent to DataEvent

  • Version 2.11.0 - 11 Nov 2025

  • Version 2.10.0 - 03 Nov 2025

    • Updated CryptoExchange.Net to version 9.12.0
    • Added support for using SharedSymbol.UsdOrStable in Shared APIs
    • Fixed exception when initial trade snapshot has no items in TradeTracker
    • Removed some unhelpful verbose logs

  • Version 2.9.0 - 16 Oct 2025

  • Version 2.8.0 - 30 Sep 2025

  • Version 2.7.0 - 01 Sep 2025

  • Version 2.6.0 - 25 Aug 2025

  • Version 2.5.1 - 21 Aug 2025

    • Added websocket error check for invalid listen key

  • Version 2.5.0 - 20 Aug 2025

    • Updated CryptoExchange.Net to version 9.5.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
    • Added improved error parsing
    • Updated rest request sending too prevent duplicate parameter serialization
    • Fixed error responses not correctly getting logged as error

  • Version 2.4.0 - 04 Aug 2025

  • Version 2.3.1 - 25 Jul 2025

    • Fixed serialization issue in restClient.SpotApi.Trading.CancelOrdersAsync

  • Version 2.3.0 - 23 Jul 2025

  • Version 2.2.1 - 16 Jul 2025

  • Version 2.2.0 - 15 Jul 2025

  • Version 2.1.0 - 02 Jun 2025

  • Version 2.0.0 - 13 May 2025

    • Updated CryptoExchange.Net to version 9.0.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
    • Added support for Native AOT compilation
    • Added RateLimitUpdated event
    • Added SharedSymbol response property to all Shared interfaces response models returning a symbol name
    • Added GenerateClientOrderId method to FuturesApi and Spot Shared clients
    • Added IBookTickerRestClient implementation to FuturesApi and SpotApi Shared clients
    • Added IFuturesTriggerOrderRestClient implementation to FuturesApi Shared clients
    • Added IFuturesTpSlRestClient implementation to FuturesApi Shared clients
    • Added takeProfitPrice, stopLossPrice parameter support to V4Api PlaceFuturesOrderAsync
    • Added TakeProfitPrice, StopLossPrice to SharedFuturesOrder model
    • Added TakeProfitPrice, StopLossPrice to SharedPosition model
    • Added QuoteVolume property mapping to SharedSpotTicker model
    • Added OptionalExchangeParameters and Supported properties to EndpointOptions
    • Added conversion of symbol to lowercase in various places
    • Added All property to retrieve all available environment on XTEnvironment
    • Refactored Shared clients quantity parameters and responses to use SharedQuantity
    • Updated all IEnumerable response and model types to array response types
    • Removed Newtonsoft.Json dependency
    • Fixed some typos
    • Fixed incorrect DataTradeMode on certain Shared interface responses
    • Fixed Futures CancelAllTrackOrdersAsync endpoint
    • Fixed deserialization error in XTOrder model

  • Version 2.0.0-beta4 - 01 May 2025

    • Updated CryptoExchange.Net version to 9.0.0-beta5
    • Added property to retrieve all available API environments

  • Version 2.0.0-beta3 - 25 Apr 2025

    • Fixed deserialization issue in XTOrder response model

  • Version 2.0.0-beta2 - 23 Apr 2025

    • Updated CryptoExchange.Net to version 9.0.0-beta2
    • Added Shared spot ticker QuoteVolume mapping
    • Fixed incorrect DataTradeMode on responses
    • Fixed Shared GetSpotSymbolsAsync not updating ExchangeSymbolCache

  • Version 2.0.0-beta1 - 22 Apr 2025

    • Updated CryptoExchange.Net to version 9.0.0-beta1, see https://github.com/JKorf/CryptoExchange.Net/releases/
    • Added support for Native AOT compilation
    • Added RateLimitUpdated event
    • Added SharedSymbol response property to all Shared interfaces response models returning a symbol name
    • Added GenerateClientOrderId method to FuturesApi and Spot Shared clients
    • Added IBookTickerRestClient implementation to FuturesApi and SpotApi Shared clients
    • Added IFuturesTriggerOrderRestClient implementation to FuturesApi Shared clients
    • Added IFuturesTpSlRestClient implementation to FuturesApi Shared clients
    • Added takeProfitPrice, stopLossPrice parameter support to V4Api PlaceFuturesOrderAsync
    • Added TakeProfitPrice, StopLossPrice to SharedFuturesOrder model
    • Added TakeProfitPrice, StopLossPrice to SharedPosition model
    • Added OptionalExchangeParameters and Supported properties to EndpointOptions
    • Added conversion of symbol to lowercase in various places
    • Refactored Shared clients quantity parameters and responses to use SharedQuantity
    • Updated all IEnumerable response and model types to array response types
    • Removed Newtonsoft.Json dependency
    • Fixed some typos
    • Fixed Futures CancelAllTrackOrdersAsync endpoint

  • Version 1.2.1 - 03 Mar 2025

    • Fix for balance update deserialization error

  • Version 1.2.0 - 11 Feb 2025

    • Updated CryptoExchange.Net to version 8.8.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
    • Added support for more SharedKlineInterval values
    • Added setting of DataTime value on websocket DataEvent updates
    • Added MinDepositQuantity, DepositConfirmations and WithdrawPrecision properties to restClient.SpotApi.ExchangeData.GetAssetNetworksAsync response model
    • Fix Mono runtime exception on rest client construction using DI

  • Version 1.1.3 - 13 Jan 2025

    • Various fixes in UsdtFutures trigger/track/stop limit order endpoints

  • Version 1.1.2 - 08 Jan 2025

    • Fix for restClient.UsdtFuturesApi.ExchangeData.GetSymbolInfoAsync deserialization

  • Version 1.1.1 - 07 Jan 2025

    • Updated CryptoExchange.Net version
    • Added Type property to XTExchange class

  • Version 1.1.0 - 23 Dec 2024

    • Updated CryptoExchange.Net to version 8.5.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
    • Added SetOptions methods on Rest and Socket clients
    • Added setting of DefaultProxyCredentials to CredentialCache.DefaultCredentials on the DI http client
    • Improved websocket disconnect detection

  • Version 1.0.2 - 20 Dec 2024

    • Added client reference

  • Version 1.0.1 - 05 Dec 2024

    • Fixed change percentage response in Shared spot symbol response not being actual percentage

  • Version 1.0.0 - 04 Dec 2024

    • Initial version