JK.BingX.Net 4.4.0

BingX.Net

BingX.Net is a client library for accessing the BingX 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 BingX.Net documentation is the main resource for installing, configuring, and using the library.

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 JK.BingX.Net

GitHub packages

BingX.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 BingXRestClient();
var tickerResult = await restClient.SpotApi.ExchangeData.GetTickersAsync("ETH-USDT");
var lastPrice = tickerResult.Data.Single().LastPrice;

Place order:

var restClient = new BingXRestClient(opts => {
	opts.ApiCredentials = new BingXCredentials("APIKEY", "APISECRET");
});

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

WebSocket subscription:

// Subscribe to ETH/USDT ticker updates via the websocket API
var socketClient = new BingXSocketClient();
var tickerSubscriptionResult = socketClient.SpotApi.SubscribeToTickerUpdatesAsync("ETH-USDT", (update) =>
{
    var lastPrice = update.Data.LastPrice;
});

For more examples and explanations, continue with the BingX.Net documentation or browse the compilable repository examples.

Shared / unified API

The CryptoExchange.Net Shared APIs provide exchange-agnostic, unified interfaces for common operations such as retrieving tickers, order books and balances, placing orders, and subscribing to market updates.

This allows the same application code to work with different exchange libraries. Each BingX API surface exposes its supported shared functionality through a SharedClient property. Because support differs between exchanges and API surfaces, call Discover() to inspect the available trading modes, environments, endpoints, and subscriptions at runtime.

Supported shared interfaces

Discover supported functionality

var sharedClient = new BingXRestClient().SpotApi.SharedClient;
var clientInfo = sharedClient.Discover();

Console.WriteLine(clientInfo);

Example

using BingX.Net.Clients;
using CryptoExchange.Net.SharedApis;

var sharedClient = new BingXRestClient().SpotApi.SharedClient;
ISpotTickerRestClient tickerClient = sharedClient;

var symbol = new SharedSymbol(TradingMode.Spot, "ETH", "USDT");
var result = await tickerClient.GetSpotTickerAsync(
    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 pattern can be used with another exchange's SharedClient.

AI documentation

For AI coding assistants and quick onboarding:

• AGENTS.md skill-style instructions for BingX.Net usage
• llms.txt provides concise AI context
• llms-full.txt provides detailed patterns, pitfalls and endpoint routing
• docs/ai-api-map.md maps common intents to client members
• Examples/ai-friendly contains compact examples that are compiled by the test suite

See cryptoexchange-skills-hub for installable skills.

CryptoExchange.Net

BingX.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
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
Toobit	JKorf/Toobit.Net
Upbit	JKorf/Upbit.Net
Weex	JKorf/Weex.Net
WhiteBit	JKorf/WhiteBit.Net
XT	JKorf/XT.Net

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

Perpetual Futures

Standard Contract

Account & Wallet

Copy Trading

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 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.4.0 - 14 Aug 2026

  • Added settleAsset parameter to GetIncomesAsync and GetPositionsAsync endpoints
  • Updated spot market data endpoints to V2
  • Updated GetPositionHistoryAsync to V2 endpoint
  • Renamed RealisedPnl to RealizedPnl in BingXPositionHistory model
  • Fixed Shared GetOpenInterestAsync being marked as Authenticated

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

• Version 4.1.1 - 13 Jul 2026

  • Fixed exception during authentication when retrying requests

• Version 4.1.0 - 09 Jul 2026

  • Updated CryptoExchange.Net to v12.1.0
  • Updated RealizedProfit and FrozenMargin mapping on BingXFuturesBalance model
  • Updated documentation links
  • Renamed orderListId to orderId for SpotApi.Trading.GetOcoOrderAsync endpoint

• 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
  • Added user subscription overloads without listenkey which manages the listen key internally
  • 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 BingXExchange.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
  • Fixed Futures order update ClientOrderId deserialization