cryptoexchange-net

CryptoExchange.Net conventions

CryptoExchange.Net is the base dependency for exchange-specific libraries. Install Binance.Net, Bybit.Net, JK.OKX.Net, or another exchange library; use CryptoClients.Net when the application needs the bundle.

Use Shared API V2

For new cross-exchange code, use the fine-grained interfaces in CryptoExchange.Net.SharedApis and each API surface's .SharedApi property:

using CryptoExchange.Net.SharedApis;

IGetTickerRest binance = new BinanceRestClient().SpotApi.SharedApi;
IGetTickerRest okx = new OKXRestClient().UnifiedApi.SharedApi;

var symbol = new SharedSymbol(TradingMode.Spot, "BTC", "USDT");
var result = await binance.GetTickerAsync(new GetTickerRequest(symbol));

Use one capability per operation, such as IGetTickerRest, IGetOrderBookRest, IPlaceSpotOrderRest, or ISubscribeTradesSocket. Do not use a broad V1 interface for new code. .SharedClient remains only for incremental V1 migration.

Capability discovery

When the exchange and API surface are known, assign the typed .SharedApi to the required capability. When selection is dynamic, use an exchange-wide I[Exchange]SharedApiClient and a strongly typed reference:

var match = sharedClient.GetCapability(
    SharedCapabilities.Orders.Futures.PlaceOrder.Rest,
    TradingMode.PerpetualLinear);

if (match is not null)
    await match.Capability.PlaceFuturesOrderAsync(request);

GetCapability returns one preferred match or null; GetCapabilities returns all matches. Specify TradingMode when multiple API surfaces may implement the same capability. A SharedCapabilities reference is a lookup key, not proof of exchange support.

Symbols and parameters

Use SharedSymbol instead of native strings such as BTCUSDT. The exchange library performs formatting.

Capability presence does not imply support for every request property. For dynamic code, inspect match.Options.RequestParameterRules, ExchangeParameterRules, and SupportedTradingModes. Supply exchange-specific values through the request's ExchangeParameters.