Skip to content

Repository files navigation

.Binance.Net Binance.Net

.NET License Since

Docs

Binance.Net is a strongly typed client library for accessing the Binance 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 (binance.com, binance.us, testnet)
  • Easy integration with other exchange client based on the CryptoExchange.Net base library
  • Native AOT support

Documentation

The Binance.Net documentation is the main resource for installing, configuring, and using the library.

Resource Description
Client guide Installation, REST and WebSocket clients, authentication, dependency injection, error handling, and advanced features
Examples Common REST and WebSocket operations
API reference Client interfaces, methods, and properties
Shared API guide Common interfaces and models for working with multiple exchanges

For AI Coding Assistants

This library provides first-class support for AI coding assistants. The relevant skill files are in this repository:

  • Agents: AGENTS.md (auto-detected at repo root)
  • Cursor: .cursor/rules/binance-net.mdc
  • GitHub Copilot: .github/copilot-instructions.md
  • Other tools (Windsurf, Codex, Continue, Aider, etc.): llms.txt at repo root
  • API quick map: docs/ai-api-map.md
  • Compilable examples: Examples/ai-friendly/

See cryptoexchange-skills-hub for installable skills.

Quick prompt to verify your assistant is using these:

"Show me a minimal example of placing a limit buy order on Binance Spot using Binance.Net, including authentication setup."

The expected output should use BinanceRestClient, BinanceCredentials, and the HttpResult pattern.

Benchmark

Performance is a core focus. For a benchmark comparing Binance.Net performance to CCXT and Binance.Api, see docs/binance-net-benchmark.md.

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

NuGet version Nuget downloads

dotnet add package Binance.Net

GitHub packages

Binance.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

Basic request:

// Get the ETH/USDT ticker via rest request
var restClient = new BinanceRestClient();
var tickerResult = await restClient.SpotApi.ExchangeData.GetTickerAsync("ETHUSDT");
var lastPrice = tickerResult.Data.LastPrice;

Place order:

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

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

WebSocket subscription:

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

Get started and request the last price of a symbol in 40 seconds

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

Shared / unified API

The CryptoExchange.Net Shared API V2 provides exchange-agnostic interfaces and models for common operations such as retrieving tickers, order books and balances, placing orders, and subscribing to market updates.

V2 uses a strict interface per capability. The SharedApi property on each API surface therefore exposes only the operations or subscriptions that surface actually supports. IBinanceSharedApiClient groups the exchange's Shared API surfaces for dependency injection and runtime capability lookup.

Access a strict capability

using Binance.Net.Clients;
using CryptoExchange.Net.SharedApis;

using var restClient = new BinanceRestClient();
IGetTickerRest tickerClient = restClient.SpotApi.SharedApi;

var symbol = new SharedSymbol(TradingMode.Spot, "ETH", "USDT");
var result = await tickerClient.GetTickerAsync(
    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 operation can accept another exchange's IGetTickerRest implementation. When using dependency injection, inject IBinanceSharedApiClient to access all of the exchange's Shared API surfaces or inject a capability such as IGetTickerRest directly. Use GetCapability on the aggregate when the operation, transport, or trading mode is selected at runtime.

CryptoExchange.Net

Binance.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 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
BitMEX JKorf/BitMEX.Net Nuget version
Bitstamp JKorf/Bitstamp.Net Nuget version
BloFin JKorf/BloFin.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
CoinW JKorf/CoinW.Net Nuget version
Crypto.com JKorf/CryptoCom.Net Nuget version
DeepCoin JKorf/DeepCoin.Net Nuget version
Gate.io JKorf/GateIo.Net Nuget version
HyperLiquid JKorf/HyperLiquid.Net Nuget version
HTX JKorf/HTX.Net Nuget version
Kraken JKorf/Kraken.Net Nuget version
Kucoin JKorf/Kucoin.Net Nuget version
LBank JKorf/LBank.Net Nuget version
Lighter JKorf/Lighter.Net Nuget version
Mexc JKorf/Mexc.Net Nuget version
OKX JKorf/OKX.Net Nuget version
Pionex JKorf/Pionex.Net Nuget version
Polymarket JKorf/Polymarket.Net Nuget version
Tapbit JKorf/Tapbit.Net Nuget version
Toobit JKorf/Toobit.Net Nuget version
Upbit JKorf/Upbit.Net Nuget version
Weex JKorf/Weex.Net Nuget version
WhiteBit JKorf/WhiteBit.Net Nuget version
XT JKorf/XT.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/Margin/Savings/Mining REST

API Supported Location
Wallet endpoints ✓ restClient.SpotApi.Account
SubAccount endpoints ✓ restClient.GeneralApi.SubAccount
Market data endpoints ✓ restClient.SpotApi.ExchangeData
Websocket Market Streams ✓ socketClient.SpotApi.ExchangeData
Spot Trading Endpoints ✓ restClient.SpotApi.Trading
Spot Account Endpoints ✓ restClient.SpotApi.Account
Margin Account/Trade Partial restClient.SpotApi.Account / restClient.SpotApi.Trading
User Data Streams ✓ socketClient.SpotApi.Account
Margin User Data Streams X
Simple Earn Endpoints ✓ restClient.GeneralApi.SimpleEarn
Auto-Invest Endpoints ✓ restClient.GeneralApi.AutoInvest
Staking Endpoints ✓ restClient.GeneralApi.Staking
Mining Endpoints ✓ restClient.GeneralApi.Mining
Futures ✓ restClient.GeneralApi.Futures
Futures Algo Endpoints ✓ restClient.UsdFuturesApi.Trading
Spot Algo Endpoints ✓ restClient.SpotApi.Trading
Classic Portfolio Margin Endpoints Partial restClient.SpotApi.Account
BLVT Endpoints Partial restClient.SpotApi.Account / restClient.SpotApi.ExchangeData / restClient.SpotApi.Trading
Fiat Endpoints ✓ restClient.SpotApi.Account
C2C Endpoints ✓ restClient.SpotApi.Trading
VIP Loans Endpoints X
Crypto Loans Endpoints Partial restClient.GeneralApi.CryptoLoans
Pay Endpoints ✓ restClient.SpotApi.Trading
Convert Endpoints ✓ restClient.SpotApi.ExchangeData / restClient.SpotApi.Trading
Rebate Endpoints ✓ restClient.SpotApi.Account
NFT Endpoints X
Binance Gift Card Endpoints X

USD-M Futures REST

API Supported Location
Market Data ✓ restClient.UsdFuturesApi.ExchangeData
Trade ✓ restClient.UsdFuturesApi.Account / restClient.UsdFuturesApi.Trading
Websocket Market Streams ✓ socketClient.UsdFuturesApi
User Data Streams ✓ socketClient.UsdFuturesApi
Account ✓ restClient.UsdFuturesApi.Account / restClient.UsdFuturesApi.Trading
Convert ✓ restClient.UsdFuturesApi.ExchangeData / restClient.UsdFuturesApi.Trading
Classic Portfolio Margin Endpoints X

COIN-M Futures REST

API Supported Location
Market Data ✓ restClient.CoinFuturesApi.ExchangeData
Websocket Market Streams ✓ socketClient.CoinFuturesApi
Trade ✓ restClient.CoinFuturesApi.Account / restClient.CoinFuturesApi.Trading
User Data Streams ✓ socketClient.CoinFuturesApi
Account ✓ restClient.CoinFuturesApi.Account / restClient.CoinFuturesApi.Trading
Classic Portfolio Margin Endpoints X

Spot Websocket API

API Supported Location
Market data requests ✓ socketClient.SpotApi.ExchangeData
Trading requests ✓ socketClient.SpotApi.Trading
Account requests ✓ socketClient.SpotApi.Account

USD-M Futures Websocket API

API Supported Location
* ✓ socketClient.UsdFuturesApi.Account / socketClient.UsdFuturesApi.ExchangeData / socketClient.UsdFuturesApi.Trading

European Options

API Supported Location
* X

Portfolio Margin

API Supported Location
* 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 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 13.6.0 - 24 Sep 2026

    • Updated CryptoExchange.Net to v13.0.0
    • Shared APIs
    • Rate limiting
      • Added rate limit admission callback to client options to allow rate limit admission ruling on request definition
      • Added WithRateLimitAdmissionAsync to client to allow rate limit admission ruling on a specific request
      • Update rate limit safety margin logic
      • Fixed some rate limit calculation issues
    • Request coalescing
      • Sending identical public GET requests on the same client at the same time will only send a single request to the server and use the same response
      • Coalescing is enabled by default and can be disabled with the RequestCoalescingEnabled client option
  • Version 13.5.1 - 01 Sep 2026

    • Updated CryptoExchange.Net to v12.5.1
    • Fixed restClient.SpotApi.Trading.ReplaceOrderAsync reporting successful cancel-replace as an unknown error
  • Version 13.5.0 - 21 Aug 2026

    • Updated to CryptoExchange.Net v12.5.0
    • Added CnEquity value to UnderlyingType Enum
    • Added Shared ISpotOrderManagementSocketClient, IFuturesOrderManagementSocketClient implementations
    • Added LowerPriceLimitPercentage, UpperPriceLimitPercentage to SharedFuturesSymbol
    • Fixed incorrect CoinFutures SharedOrderQuantity quantity/volume mappingsand quantity restrictions
  • Version 13.4.0 - 14 Aug 2026

    • Added restClient.SpotApi.ExchangeData.GetAssetTagsAsync endpoint
    • Added Symbol to BinanceFuturesStreamAccountUpdateData model
    • Added Activated to BinanceAlgoOrderUpdateOrder model
    • Added Affiliate endpoints under GeneralApi.Affiliate
    • Updated futures historical trade endpoints weights from 20 to 200
    • Updated restClient.SpotApi.Account.TransferAsync weight from 900 to 300
    • Fixed Shared GetOpenInterestAsync marked as Authenticated
  • Version 13.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
    • Added restClient.SpotApi.ExchangeData.GetMarginRestrictedAssetsAsync endpoint
    • Added TRY as fiat currency for Shared asset type mapping
    • Added RateType to BinanceFuturesFundingRateHistory model
    • Updated SharedFuturesTicker, SharedSpotTicker, SharedTrade and SharedKline to use SharedOrderQuantity for volumes/quantities
    • Updated documentation links
  • Version 13.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
    • Added HkEquity value to UnderlyingType Enum
    • Removed Fee, FeeAsset from Shared websocket order updates
    • Added Fee, FeeAsset to Shared websocket order LastTrade model
  • Version 13.1.1 - 13 Jul 2026

    • Combined request rate limit for coin and usdt futures
    • Updated Usdt futures GetFundingInfoAsync and GetBasisAsync endpoint weight from 0 to 1
    • Fixed exception during authentication when retrying requests
  • Version 13.1.0 - 09 Jul 2026

    • Updated CryptoExchange.Net to v12.1.0
    • Added CancelOnly to SymbolStatus enum
    • Added CoinM conditional order endpoints
    • Fixed typo in Accepeted deserialization in BinanceTravelWithdrawalResponse model
  • Version 13.0.1 - 01 Jul 2026

    • Updated CryptoExchange.Net to V12.0.2
    • Added lower case value mapping for AccountType and FuturesMarginType enums
    • Added WithdrawCollaterals, BorrowCollaterals to BinanceCrossMarginCollateralRatio model
    • Added TieredLiquidationRatio to BinancePortfolioMarginCollateralRate model
    • Added IsPublic to BinanceIsolatedMarginTierData
    • Updated GetFiatPaymentHistoryAsync to return empty array if no results
    • Fixed websocket request signing issue
  • Version 13.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 BinanceExchange.RateLimiter to allow custom rate limit settings
    • Added UnderlyingType.KrEquity Enum value
    • Updated symbol parameter to optional for GetFundingRatesAsync endpoint
    • Updated some endpoint ratelimit weights
    • Renamed DepositStatus.Completed to DepositStatus.Credited
    • Various small performance improvements
    • Fixed websocket connection attempts counting towards rate limit even when server could not be reached
    • Fixed duplicate subscriptions not correctly handled user subscriptions
    • Fixed deserialization error in BinanceFuturesFundingInfo when UpdateTime was null

About

C#/.NET client library for the Binance.com cryptocurrency exchange REST and WebSocket APIs, supporting Spot and Futures trading and market data with strongly typed models.

Topics

Resources

Stars

1.2k stars

Watchers

57 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages