Skip to content

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

License

Notifications You must be signed in to change notification settings

JKorf/BingX.Net

Repository files navigation

.BingX.Net BingX.Net

.NET License

BingX.Net is a client library for accessing the BingX REST and Websocket API. All data is mapped to readable models and enum values. Additional features include an implementation for maintaining a client side order book, easy integration with other exchange client libraries and more.

Supported Frameworks

The library is targeting both .NET Standard 2.0 and .NET Standard 2.1 for optimal compatibility

.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

Get the library

Nuget version Nuget downloads

dotnet add package JK.BingX.Net

How to use

REST Endpoints

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

Websocket streams

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

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

Exchange Repository Nuget
Binance JKorf/Binance.Net Nuget version
Bitfinex JKorf/Bitfinex.Net Nuget version
Bitget JKorf/Bitget.Net Nuget version
Bybit JKorf/Bybit.Net Nuget version
CoinEx JKorf/CoinEx.Net Nuget version
CoinGecko JKorf/CoinGecko.Net Nuget version
Huobi/HTX JKorf/Huobi.Net Nuget version
Kraken JKorf/Kraken.Net Nuget version
Kucoin JKorf/Kucoin.Net Nuget version
Mexc JKorf/Mexc.Net Nuget version
OKX JKorf/OKX.Net Nuget version

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

API Supported Location
Market Interface restClient.SpotApi.ExchangeData
Wallet deposits and withdrawals restClient.SpotApi.Account
Spot account restClient.SpotApi.Account
Trade interface restClient.SpotApi.Trading
Websocket Market Data socketClient.SpotApi
Websocket Account Data socketClient.SpotApi

Perpetual Futures

API Supported Location
Market Interface restClient.PerpetualFuturesApi.ExchangeData
Account Interface restClient.PerpetualFuturesApi.Account
Trade Interface restClient.PerpetualFuturesApi.Account/restClient.PerpetualFuturesApi.Trading
Websocket Market Data socketClient.PerpetualFuturesApi
Websocket Account Data socketClient.PerpetualFuturesApi

Standard Contract

API Supported Location
Standard Contract Interface X

Account & Wallet

API Supported Location
Spot account restClient.SpotApi.Account
Wallet deposits and withdrawals restClient.SpotApi.Account
Sub-account X

Copy Trading

API Supported Location
Standard Contract Interface X

Support the project

I develop and maintain this package on my own for free in my spare time, 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 1.2.0 - 02 Jun 2024

    • Added PerpetualFuturesApi.SubscribeToPartialOrderBookUpdatesAsync, PerpetualFuturesApi.SubscribeToKlineUpdatesAsync and PerpetualFuturesApi.SubscribeToTickerUpdatesAsync subscriptions for all symbols
    • Added PerpetualFuturesApi.Trading.GetPositionAndMarginInfoAsync endpoint
    • Added optional symbol parameter PerpetualFuturesApi.ExchangeData.GetContractsAsync
    • Updated BingXWithdrawal response model
    • Updated BingXPosition response model
  • Version 1.1.1 - 07 May 2024

  • Version 1.1.0 - 02 May 2024

    • Removed need for API credentials in certain ExchangeData calls
    • Renamed PerpetualFutures.Trading.GetClosedOrderAsync to GetClosedOrdersAsync
    • Changed PerpetualFutures.SubscribeToUserDataUpdatesAsync handlers to be nullable
    • Fixed SpotApi.SubscribeToBalanceUpdatesAsync update handling
    • Various small fixes
  • Version 1.0.5 - 01 May 2024

  • Version 1.0.4 - 28 Apr 2024

  • Version 1.0.3 - 23 Apr 2024

  • Version 1.0.2 - 18 Apr 2024

  • Version 1.0.1 - 10 Apr 2024

    • Added PostOnly TimeInForce enum value
    • Updated PerpetualFuturesApi.ExchangeData.GetContractsAsync response model
    • Updated PerpetualFuturesApi.Trading.GetUserTradesAsync response model
    • Some other minor model updates
    • Updated string comparison for improved performance
    • Fixed property types on Position model
  • Version 1.0.0 - 25 Mar 2024

    • Initial release