Jkorf
23 KiB
CryptoExchange.Net
CryptoExchange.Net is a base library which is used to implement different cryptocurrency (exchange) API's. It provides a standardized way of implementing different API's, which results in a very similar experience for users of the API implementations. Note that the CryptoExchange.Net package itself can not be used directly for accessing API's. Either install a client library from the list below or use CryptoClients.Net which includes access to all exchange API's.
For more information on what CryptoExchange.Net and it's client libraries offers see the Documentation.
For AI Coding Assistants
This library and the entire CryptoExchange.Net ecosystem provide 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/cryptoexchange-net.mdc - GitHub Copilot:
.github/copilot-instructions.md - Other tools (Windsurf, Codex, Continue, Aider, etc.):
llms.txtat repo root - Compilable examples:
Examples/ai-friendly/
For single-exchange code, see also the AI files in each exchange's repository (Binance.Net, Bybit.Net, OKX.Net, ...) — they cover exchange-specific patterns.
See cryptoexchange-skills-hub for installable skills.
Quick prompt to verify your assistant is using these:
"Show me how to fetch BTC/USDT spot tickers from Binance and OKX concurrently in C# using the SharedApis pattern."
The expected output should use .SharedClient properties, SharedSymbol, ISpotTickerRestClient, and Task.WhenAll.
CryptoExchange.Net Ecosystem
Full list of all libraries part of the CryptoExchange.Net ecosystem. Consider using a referral link to support development, as well as potentially get some trading fee discount!
Any of these can be installed independently or install CryptoClients.Net which includes all exchange API's.
Full demo application
A full demo application is available using the CryptoClients.Net library:
https://github.com/JKorf/CryptoManager.Net
Discord
A Discord server is available here. Feel free to join for discussion and/or questions around the CryptoExchange.Net and implementation libraries.
Support the project
Any support is greatly appreciated.
Referral
When creating an account on new exchanges please consider using a referral link from above.
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.
Update notes from version 11.x to 12.x for client implementations
-
Result types:
- (Web)CallResult types are replaced by HttpResult, WebSocketResult and QueryResult
- Use (Http/WebSocket/Query)Result.Ok(..) and .Fail(..) for creation
- Result objects no longer override implicit conversion to bool, use Success property instead
- CallResult.SuccessResult has been replaced with CallResult.Ok()
-
Parameters & serialization:
- ParameterCollection type is replaced by Parameters, most AddXX() methods can be replaced by Add()
- Parameter serialization behavior can be controlled in the Add method as third parameter, or in the ParameterSerializationSettings
- ArraySerialization has been move into the new Parameters object
- RestRequestConfiguration in AuthenticationProvider.ProcessRequest now contains the full RequestDefinition instead of copied fields. This changes for example
request.Authenticatedtorequest.RequestDefinition.Authenticated
WebSocket routing:
- MessageRouting has been split into event and query routing; use CreateForEvent for subscriptions and CreateForQuery for queries.
- Queries returning a mapped type can specify a second type parameter in CreateForQuery for the result type
- MessageRouter.CreateWithoutHandler has been replaced with CreateVoid
Shared APIs:
- Option defintions now always require the exchange name as first parameter
- Every request/subscription now has a dedicated options type
- ExchangeSymbolCache now requires EnvironmentName as parameter for operations
- Validation has been unified via
SharedClient.[Request]Options.ValidateRequest(request, this); - Validation now includes auth check and klines support internally, no need for explicit checks
- AsExchangeResult/ExchangeWebResult has been removed, use normal HttpResults instead
- ExchangeResult has been replaced by ExchangeCallResult
- TradingMode has been removed from the response model, only maintained on models where it makes sense
- IListenKey support has been removed, listen keys should be managed internally with TokenManager
Various:
- ApiClients now require an exchange name in the constructor
- ApiClients now required ILoggerFactory parameter instead of ILogger instance
- RestApiClient SendAsync without type parameter removed, use SendAsync instead
- Address parameter removed from SendAsync RestApiClient, should be specified on the request definition instead
- SymbolOrderBook DoResyncAsync now returns CallResult instead of CallResult which was redundant
- PlatformInfo now required support environment names in the constructor
Release notes
-
Version 12.4.0 - 28 Jul 2026
- Added AveragePrice property to SharedQuantity model
- Added DebuggerDisplay attributes to Result objects
- Updated SharedFuturesTicker, SharedSpotTicker, SharedTrade and SharedKline to use SharedOrderQuantity for volumes/quantities
- Updated REST json deserialization error for empty response
-
Version 12.3.0 - 23 Jul 2026
- Added calculation of AveragePrice on Shared order models if data is available and AveragePrice is not set
- Extracted ConnectionCanBeUsedFor method in SocketApiClient for easier custom logic implementation
- Updated some Shared APIs error messages
- Remove duplicate warnings from testing output
-
Version 12.2.0 - 20 Jul 2026
- 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 IsStableCoin, IsCommodity and IsEquity helper methods to LibraryHelpers
- Added DebuggerDisplay attributes to Shared models
- Fixed socket connection combine calculations
-
Version 12.1.1 - 11 Jul 2026
- Added timestamp deserialization support for yyyy-MM-dd HH:mm:ss.ffffff+00:00:00
-
Version 12.1.0 - 09 Jul 2026
- Added ExchangeParameters parameter to KlineTracker, TradeTracker and ITrackerFactory methods
- Updated some testing logic
- Fixed nullability operator on Parameters.AddCommaSeperated
-
Version 12.0.2 - 01 Jul 2026
- Updated test validation to output a list of issues instead of throwing on the first
-
Version 12.0.1 - 29 Jun 2026
- Fixed bug in bool converter
-
Version 12.0.0 - 29 Jun 2026
-
Result types:
- (Web)CallResult types are replaced by HttpResult, WebSocketResult and QueryResult with the same logic
- Updated result types to record type
- Result creation can be done with (Http/WebSocket/Query)Result.Ok(..) and .Fail(..)
- Removed implicit result type conversion to bool,
if (result)no longer works, instead useif (result.Success) - Replaced CallResult.SuccessResult with CallResult.Ok()
- Fixed result object nullability hinting, for example Data might be null if Success isn't checked for true
-
Parameters & serialization:
- Added support for
enabledanddisabledstrings to bool converter - Removed ParameterCollection type, has been replaced by Parameters type
- Removed ArraySerialization, OrderParameters and ParameterOrderComparer properties from RestApiClient, moved to ParameterSerializationsSettings
- Updated RestRequestConfiguration in AuthenticationProvider.ProcessRequest to contain the full RequestDefinition instead of copied fields
- Added support for
-
Clients:
- Updated Api client constructor logging parameter from ILogger to ILoggerFactory?
- Added Api client constructor exchange name parameter
- Added ToString overrides on base API types
- Added Exchange property on BaseApiClient
- Added ApiCredentials property on IRestApiClient and ISocketApiClient interfaces
- Updated ILogger source from client name to topic specific client name
- Removed logging from client creation
- Fixed BaseRestClient SetApiCredentials not marked as virtual
-
Rest:
- Added BaseAddress to RequestDefinition object
- Updated RestApiClient AuthenticationProvider logic from private to protected and virtual
- Removed RestApiClient.SendAsync baseAddress parameter removed
- Removed RestApiClient.SendAsync without type parameter
-
WebSocket:
- Updated MessageRouting definition into CreateForEvent for subscriptions and CreateForQuery for queries
- Improved Query type safety with CeateForQuery which allows second parameter for specifying the result type
- Renamed MessageRouter.CreateWithoutHandler to CreateVoid
- Updated SocketApiClient.GetSocketConnection to check connection uri instead of Tag for finding compatible connections
- Removed unused UnhandledMessageExpected property SocketApiClient
- Fixed issue in SocketApiClient.GetSocketConnection causing requests to always wait the full max 10 seconds when there was a reconnecting socket
-
Shared APIs:
- Updated Option definitions to always require the exchange name as first parameter
- Added missing dedicated option types
- Added Discover method on ISharedClient interface, returning info on supported capabilities and operations
- Added SharedRequest GetParamValue helper method accepting multiple parameter names
- Added ResetStaticExchangeParameters method on ExchangeParameters
- Added Status property to SharedWithdrawal model
- Added TradingModes property to SharedBalance model
- Updated ExchangeSymbolCache to support multiple environments and additional key separation
- Updated Shared ExchangeParameters parameter names to be case insensitive
- Updated code comments
- Replaced ExchangeResult with ExchangeCallResult type
- Removed AsExchangeResult/ExchangeWebResult
- Removed TradingMode from the response model, only maintained on models where it makes sense
- Removed IListenKey support, listen keys now rely on internal management with TokenManager
-
Rate limiting:
- Fixed websocket connection attempts counting towards rate limit even when server could not be reached
- Removed host from rate limit methods, now part of the already provided RequestDefinition
- Added amount parameter to RateLimit Reset method to allow partially resetting the limit
-
Added TokenManager implementation for automatic listenkey/token management
-
Added UserClientProvider base class
-
Added async streaming on UserDataTracker items with StreamUpdatesAsync
-
Added cancellation token support to UserDataTracker starting
-
Added Unit type for non-result types
-
Added ServerError constructor taking ErrorType and message to make it easier to create
-
Added SupportedEnvironments property to PlatformInfo
-
Updated SymbolOrderBook DoResyncAsync to return CallResult instead of CallResult which was redundant
-
Various small performance improvements
-