Skip to content

JKorf/XT.Net

Repository files navigation

XT.Net XT.Net

.NET License Since

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

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:

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.

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.

Exchange Repository Nuget
Aster JKorf/Aster.Net Nuget version
Binance JKorf/Binance.Net Nuget version
BingX JKorf/BingX.Net Nuget version
Bitfinex JKorf/Bitfinex.Net Nuget version
Bitget JKorf/Bitget.Net Nuget version
BitMart JKorf/BitMart.Net Nuget version
BitMEX JKorf/BitMEX.Net Nuget version
Bitstamp JKorf/Bitstamp.Net Nuget version
BloFin JKorf/BloFin.Net Nuget version
Bybit JKorf/Bybit.Net Nuget version
Coinbase JKorf/Coinbase.Net Nuget version
CoinEx JKorf/CoinEx.Net Nuget version
CoinGecko JKorf/CoinGecko.Net Nuget version
CoinW JKorf/CoinW.Net Nuget version
Crypto.com JKorf/CryptoCom.Net Nuget version
DeepCoin JKorf/DeepCoin.Net Nuget version
Gate.io JKorf/GateIo.Net Nuget version
HTX JKorf/HTX.Net Nuget version
HyperLiquid JKorf/HyperLiquid.Net Nuget version
Kraken JKorf/Kraken.Net Nuget version
Kucoin JKorf/Kucoin.Net Nuget version
Lighter JKorf/Lighter.Net Nuget version
Mexc JKorf/Mexc.Net Nuget version
OKX JKorf/OKX.Net Nuget version
Polymarket JKorf/Polymarket.Net Nuget version
Toobit JKorf/Toobit.Net Nuget version
Weex JKorf/Weex.Net Nuget version
Upbit JKorf/Upbit.Net Nuget version
WhiteBit JKorf/WhiteBit.Net Nuget 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

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 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 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 use if (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

About

A C# .netstandard client library for the XT.com REST and Websocket Spot and Futures API focusing on clear usage and models

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

 
 
 

Contributors

Languages