Skip to content

Latest commit

 

History

History
174 lines (139 loc) · 10.4 KB

README.md

File metadata and controls

174 lines (139 loc) · 10.4 KB
Raw

WhiteBit.Net WhiteBit.Net

.NET License

WhiteBit.Net is a client library for accessing the WhiteBit 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
  • Cient 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 WhiteBit.Net

GitHub packages

WhiteBit.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 WhiteBitRestClient();
 var tickerResult = await restClient.V4Api.ExchangeData.GetTickersAsync();
 var symbol = tickerResult.Data.Single(x => x.Symbol == "ETH_USDT");
 var lastPrice = symbol.LastPrice;
  • Websocket streams 
     // Subscribe to ETH/USDT ticker updates via the websocket API
 var socketClient = new WhiteBitSocketClient();
 var tickerSubscriptionResult = socketClient.V4Api.SubscribeToTickerUpdatesAsync("ETH_USDT", (update) =>
 {
     var lastPrice = update.Data.Ticker.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.

CryptoExchange.Net

WhiteBit.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
BingX JKorf/BingX.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
Gate.io JKorf/GateIo.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
XT JKorf/XT.Net Nuget version

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

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

V4 API Public

API Supported Location
Rest API ✓ restClient.V4Api.ExchangeData
Websocket API ✓ socketClient.V4Api

V4 API Private Rest Main

API Supported Location
Codes API ✓ restClient.V4Api.Codes
Crypto Lending API X
Fees API ✓ restClient.V4Api.Account
SubAccount API ✓ restClient.V4Api.SubAccount
Mining Pool API ✓ restClient.V4Api.Account

V4 API Private Rest Trade

API Supported Location
Spot API ✓ restClient.V4Api.Account / restClient.V4Api.Trading
Collateral API ✓ restClient.V4Api.Account / restClient.V4Api.CollateralTrading
Convert API ✓ restClient.V4Api.Convert

V4 API Private WebSocket

API Supported Location
* ✓ socketClient.V4Api

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 1.3.0 - 23 Dec 2024

    • Updated CryptoExchange.Net to version 8.5.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
    • Added SetOptions methods on Rest and Socket clients
    • Added setting of DefaultProxyCredentials to CredentialCache.DefaultCredentials on the DI http client
    • Improved websocket disconnect detection

  • Version 1.2.2 - 20 Dec 2024

    • Fixed deserialization of restClient.V4Api.Trading.GetClosedOrdersAsync without results

  • Version 1.2.1 - 03 Dec 2024

  • Version 1.2.0 - 28 Nov 2024

  • Version 1.1.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 WhiteBitExchange class
    • Updated client constructors to accept IOptions from DI
    • Removed redundant WhiteBitSocketClient constructor

  • Version 1.0.0 - 06 Nov 2024

    • Initial Release