WhiteBit.Net
4.1.1
See the version list below for details.
dotnet add package WhiteBit.Net --version 4.1.1
NuGet\Install-Package WhiteBit.Net -Version 4.1.1
<PackageReference Include="WhiteBit.Net" Version="4.1.1" />
<PackageVersion Include="WhiteBit.Net" Version="4.1.1" />
<PackageReference Include="WhiteBit.Net" />
paket add WhiteBit.Net --version 4.1.1
#r "nuget: WhiteBit.Net, 4.1.1"
#:package WhiteBit.Net@4.1.1
#addin nuget:?package=WhiteBit.Net&version=4.1.1
#tool nuget:?package=WhiteBit.Net&version=4.1.1
WhiteBit.Net
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
- 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
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.
| .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
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
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 WhiteBitRestClient();
var tickerResult = await restClient.V4Api.ExchangeData.GetTickersAsync();
var symbol = tickerResult.Data.Single(x => x.Symbol == "ETH_USDT");
var lastPrice = symbol.LastPrice;
Place order:
var restClient = new WhiteBitRestClient(opts => {
opts.ApiCredentials = new WhiteBitCredentials("APIKEY", "APISECRET");
});
// Place Limit order to go long 0.1 for ETH at 2000
var orderResult = await restClient.V4Api.CollateralTrading.PlaceOrderAsync(
"ETH_PERP",
OrderSide.Buy,
NewOrderType.Limit,
0.1m,
2000
);
WebSocket subscription:
// 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.
AI / LLM documentation
WhiteBit.Net includes AI-oriented documentation and examples for code generation tools:
| File | Purpose |
|---|---|
AGENTS.md |
Assistant skill with core WhiteBit.Net patterns, pitfalls, and examples |
llms.txt |
Short LLM index with links to docs, examples, and critical usage rules |
llms-full.txt |
Detailed LLM context with endpoint routing, code patterns, and anti-hallucination checks |
docs/ai-api-map.md |
Table-style intent-to-method map for V4 REST, WebSocket, and SharedApis |
Examples/ai-friendly |
Compilable single-file examples for common REST, WebSocket, shared API, and error handling workflows |
See cryptoexchange-skills-hub for installable skills.
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 |
|---|---|---|
| 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 | |
| Polymarket | JKorf/Polymarket.Net | |
| Toobit | JKorf/Toobit.Net | |
| Upbit | JKorf/Upbit.Net | |
| Weex | JKorf/Weex.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
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 4.1.1 - 13 Jul 2026
- Fixed WhiteBitClosedOrderSubscription message router event
- Fixed DateTime parameter serialization
- Fixed Shared APIs open orders request not returning all open orders
- Fixed exception during authentication when retrying requests
Version 4.1.0 - 09 Jul 2026
- Updated CryptoExchange.Net to v12.1.0
- Added Rpi to WhiteBitTrade model
- Added FundingInterval to WhiteBitFuturesSymbol model
- Added Centralized to WhiteBitDepositWithdrawal model
- Added FuturesEquity and FuturesFreeMargin to WhiteBitCollateralAccountSummary model
- Added IsTradeFiFutures and DelistTime to WhiteBitSymbol model
- Added rpi and retail parameters to PlaceSpotOrderAsync endpoint
- Updated SelfTradePreventionMode enum mapping
- Updated restClient.V4Api.Account.GetAccountFundingHistoryAsync symbol parameter to optional
- Renamed BasePrice to Price, fixed deserialization on WhiteBitPositionHistoryOrder model
- Fixed GetConvertHistory startTime, endTime parameter conversion
- Fixed documentation links
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 useif (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 Europe environment
- 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 WhiteBitExchange.RateLimiter to allow custom rate limit settings
- Added SymbolType.TradFiFutures enum value
- Various small performance improvements
- Fixed websocket connection attempts counting towards rate limit even when server could not be reached
- Result types:
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 is compatible. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- CryptoExchange.Net (>= 12.1.0)
-
.NETStandard 2.1
- CryptoExchange.Net (>= 12.1.0)
-
net10.0
- CryptoExchange.Net (>= 12.1.0)
-
net8.0
- CryptoExchange.Net (>= 12.1.0)
-
net9.0
- CryptoExchange.Net (>= 12.1.0)
NuGet packages (2)
Showing the top 2 NuGet packages that depend on WhiteBit.Net:
| Package | Downloads |
|---|---|
|
CryptoClients.Net
CryptoClients.Net offers full easy access to 28 different cryptocurrency exchange API's, such as Binance, Bybit, HyperLiquid and many more. It offers a unified way to access the API's and tools to dynamically call endpoints on different exchanges. |
|
|
Le.CryptoClients.Net
CryptoClients.Net is a collection of multiple cryptocurrency exchange API clients for accessing both the REST API's and WebSocket API's. Supports order and account management and requesting and streaming both public and private data. |
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on WhiteBit.Net:
| Repository | Stars |
|---|---|
|
JKorf/CryptoExchange.Net
A C# .netstandard base library used for implementing cryptocurrency exchange API's.
|
| Version | Downloads | Last Updated |
|---|---|---|
| 4.2.0 | 190 | 7/21/2026 |
| 4.1.1 | 101 | 7/13/2026 |
| 4.1.0 | 318 | 7/9/2026 |
| 4.0.0 | 940 | 6/29/2026 |
| 3.12.0 | 329 | 6/8/2026 |
| 3.11.1 | 862 | 6/2/2026 |
| 3.11.0 | 303 | 5/26/2026 |
| 3.10.0 | 1,112 | 5/1/2026 |
| 3.9.2 | 595 | 4/9/2026 |
| 3.9.1 | 721 | 3/24/2026 |
| 3.9.0 | 128 | 3/24/2026 |
| 3.8.0 | 445 | 3/6/2026 |
| 3.7.0 | 1,745 | 2/24/2026 |
| 3.6.0 | 687 | 2/16/2026 |
| 3.5.0 | 329 | 2/10/2026 |
| 3.4.0 | 129 | 2/6/2026 |
| 3.3.0 | 1,309 | 1/22/2026 |
| 3.2.1 | 880 | 1/14/2026 |
| 3.2.0 | 243 | 1/13/2026 |
| 3.1.0 | 250 | 1/7/2026 |