Weex.Net 2.3.0

Weex.Net

Weex.Net is a client library for accessing the Weex 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 clients 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.

Install the library

NuGet

dotnet add package Weex.Net

GitHub packages

Weex.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 WeexRestClient();
var tickerResult = await restClient.SpotApi.ExchangeData.GetTickersAsync(["ETHUSDT"]);
var lastPrice = tickerResult.Data.Single().LastPrice;

Place order:

var restClient = new WeexRestClient(opts => {
    opts.ApiCredentials = new WeexCredentials("APIKEY", "APISECRET", "PASS");
});

// Place Limit order to go long 0.1 for ETH at 2000
var orderResult = await restClient.FuturesApi.Trading.PlaceOrderAsync(
    "ETH_USDT",
    OrderSide.Buy,
    PositionSide.Long,
    OrderType.Limit,
    0.1m,
    price: 2000,
    timeInForce: TimeInForce.GoodTillCanceled
    );

WebSocket subscription:

// Subscribe to ETH/USDT ticker updates via the websocket API
var socketClient = new WeexSocketClient();
var tickerSubscriptionResult = socketClient.SpotApi.SubscribeToTickerUpdatesAsync("ETHUSDT", (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

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

See cryptoexchange-skills-hub for installable skills.

CryptoExchange.Net

Weex.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
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
Lighter	JKorf/Lighter.Net
Mexc	JKorf/Mexc.Net
OKX	JKorf/OKX.Net
Pionex	JKorf/Pionex.Net
Toobit	JKorf/Toobit.Net
Upbit	JKorf/Upbit.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

Spot REST

Spot Websocket

Futures REST

Futures Websocket

Support the project

Any support is greatly appreciated.

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 2.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
  • Updated SharedFuturesTicker, SharedSpotTicker, SharedTrade and SharedKline to use SharedOrderQuantity for volumes/quantities

• Version 2.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

• Version 2.1.1 - 13 Jul 2026

  • Updated SocketUpdateType setting for SubscribeToTradeUpdatesAsync updates
  • Fixed WeexSubscription IndividualSubscriptionCount not being set correctly

• Version 2.1.0 - 09 Jul 2026

  • Updated CryptoExchange.Net to v12.1.0
  • Added RateLimits to WeexExchangeInfo and WeexFuturesExchangeInfo models
  • Added NextKey property to WeexFuturesBillPage model

• Version 2.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
  • 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 WeexExchange.RateLimiter to allow custom rate limit settings
  • Added SymbolStatus.Halt enum value
  • Various small performance improvements
  • Fixed websocket connection attempts counting towards rate limit even when server could not be reached