Skip to content

Latest commit

 

History

History
297 lines (237 loc) · 16.7 KB

README.md

File metadata and controls

297 lines (237 loc) · 16.7 KB
Raw

.BingX.Net BingX.Net

.NET License

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
  • Automatic websocket (re)connection management
  • Client side rate limiting
  • Client side order book implementation
  • Extensive logging
  • Support for different environments
  • Easy integration with other exchange client based on the CryptoExchange.Net base library

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

Install the library

NuGet

NuGet version Nuget downloads

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

GitHub Release

The NuGet package files are added along side the source with the latest GitHub release which can found here.

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
BitMart JKorf/BitMart.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
Crypto.com JKorf/CryptoCom.Net Nuget version
Gate.io JKorf/GateIo.Net Nuget version
HTX JKorf/HTX.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
WhiteBit JKorf/WhiteBit.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

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.16.0 - 19 Nov 2024

    • Updated CryptoExchange.Net to version 8.3.0, see https://github.com/JKorf/CryptoExchange.Net/releases/tag/8.3.0
    • Added support for loading client settings from IConfiguration
    • Added DI registration method for configuring Rest and Socket options at the same time
    • Added DisplayName and ImageUrl properties to BingXExchange class
    • Updated client constructors to accept IOptions from DI
    • Removed redundant BingXSocketClient constructor

  • Version 1.15.1 - 15 Nov 2024

    • Fixed available balance response on shared futures implementation
    • Removed symbol parameters from GetPositionModeAsync and SetPositionModeAsync endpoints

  • Version 1.15.0 - 13 Nov 2024

    • Added initial SubAccount API implementation

  • Version 1.14.0 - 06 Nov 2024

  • Version 1.13.0 - 04 Nov 2024

    • Added restClient.PerpetualFuturesApi.Account.GetIsolatedMarginChangeHistoryAsync endpoint
    • Added settleAsset parameter to FuturesApi.Trading endpoints

  • Version 1.12.0 - 28 Oct 2024

    • Updated CryptoExchange.Net to version 8.1.0, see https://github.com/JKorf/CryptoExchange.Net/releases/tag/8.1.0
    • Moved FormatSymbol to BingXExchange class
    • Added support Side setting on SharedTrade model
    • Added BingXTrackerFactory for creating trackers
    • Added overload to Create method on BingXOrderBookFactory support SharedSymbol parameter
    • Added Shared websocket kline subscription implementation for futures and spot APIs

  • Version 1.11.2 - 21 Oct 2024

    • Added Tier property to restClient.PerpetualFuturesApi.Trading.GetPositionAndMarginInfoAsync response model
    • Added ReduceOnly property to socketClient.PerpetualFuturesApi.SubscribeToUserDataUpdatesAsync order update model

  • Version 1.11.1 - 14 Oct 2024

  • Version 1.11.0 - 27 Sep 2024

    • Updated CryptoExchange.Net to version 8.0.0, see https://github.com/JKorf/CryptoExchange.Net/releases/tag/8.0.0
    • Added Shared client interfaces implementation for Spot and Perpetual Futures Rest and Socket clients
    • Added check for api credentials in rest user stream operations
    • Added PerpetualFuturesApi.Trading.GetUserTradesAsync endpoint
    • Added timeInForce parameter to SpotApi.Trading.PlaceOrderAsync endpoint
    • Updated fromId parameter on SpotApi.Trading.GetuserTradesAsync from int? to long?
    • Updated KlineInterval Enum values to match number of seconds
    • Updated Sourcelink package version
    • Marked ISpotClient references as deprecated

  • Version 1.10.0 - 11 Sep 2024

    • Fixed request signing for requests with special characters
    • Added SpotApi Oco endpoints

  • Version 1.9.2 - 28 Aug 2024

    • Updated CryptoExchange.Net to version 7.11.2, see https://github.com/JKorf/CryptoExchange.Net/releases/tag/7.11.2
    • Fixed Boolean parameter serialization on PerpetualFuturesApi.Trading order endpoints
    • Added RealizedPnl property to PerpetualFuturesApi websocket position update
    • Added TimeOffline, TimeMaintenance properties to SpotApi symbol model
    • Added BrokerProhibited property to PerpetualFuturesApi contract response model

  • Version 1.9.1 - 23 Aug 2024

    • Fixed enum type on OrderType property on socket perpetual futures order update

  • Version 1.9.0 - 19 Aug 2024

    • Added PerpetualFuturesApi.Trading.GetPositionHistoryAsync endpoint
    • Updated PerpetualFuturesApi.Account.GetBalancesAsync to V3, returning both USDT and USDC balances
    • Added sync parameter to SpotApi.Trading.PlaceMultipleOrderAsync endpoint

  • Version 1.8.0 - 07 Aug 2024

  • Version 1.7.0 - 27 Jul 2024

  • Version 1.6.0 - 16 Jul 2024

    • Updated CryptoExchange.Net to version 7.9.0, see https://github.com/JKorf/CryptoExchange.Net/releases/tag/7.9.0
    • Updated internal classes to internal access modifier
    • Added PerpetualFuturesApi.ExchangeData.GetTickersAsync endpoint
    • Added PerpetualFuturesApi.ExchangeData.GetLastTradePricesAsync endpoint
    • Added PerpetualFuturesApi.ExchangeData.GetFundingRatesAsync endpoint
    • Added SpotApi.ExchangeData.GetLastTradesAsync endpoint
    • Added SpotApi.Account.GetUserIdAsync endpoint
    • Added SpotApi.Account.GetApiKeyPermissionsAsync endpoint
    • Added sync parameter to SpotApi.Trading.PlaceMultipleOrdersAsync
    • Updated API endpoint docs references
    • Fixed Spot and Futures KeepAliveUserStreamAsync endpoint
    • Fixed clientOrderId deserialization in websocket order updates

  • Version 1.5.0 - 02 Jul 2024

  • Version 1.4.0 - 26 Jun 2024

  • Version 1.3.2 - 23 Jun 2024

  • Version 1.3.1 - 13 Jun 2024

    • Fixed bingXClient.PerpetualFuturesApi.ExchangeData.GetContractsAsync response parsing by updating Status mapping

  • Version 1.3.0 - 11 Jun 2024

  • 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