mirror of
https://github.com/JKorf/CryptoExchange.Net.git
synced 2026-08-11 16:32:57 +00:00
Jkorf
63 lines
3.6 KiB
Markdown
63 lines
3.6 KiB
Markdown
# Copilot Instructions for CryptoExchange.Net
|
|
|
|
This repository is **CryptoExchange.Net** — the base library powering 28+ cryptocurrency exchange wrappers in C#/.NET (Binance.Net, Bybit.Net, OKX.Net, Kraken.Net, Coinbase.Net, etc.).
|
|
|
|
When generating code in this ecosystem, follow these conventions:
|
|
|
|
## You don't install CryptoExchange.Net directly
|
|
|
|
Install the exchange-specific library you need (`Binance.Net`, `JK.OKX.Net`, `Bybit.Net`, ...) or `CryptoClients.Net` for the bundle. CryptoExchange.Net is pulled in as a dependency.
|
|
|
|
## Multi-exchange code uses SharedApis
|
|
|
|
For code that must work against multiple exchanges, use `CryptoExchange.Net.SharedApis` interfaces accessed via `.SharedClient` properties on each exchange's API surface:
|
|
|
|
```csharp
|
|
using CryptoExchange.Net.SharedApis;
|
|
|
|
ISpotTickerRestClient binance = new BinanceRestClient().SpotApi.SharedClient;
|
|
ISpotTickerRestClient okx = new OKXRestClient().UnifiedApi.SharedClient;
|
|
|
|
var symbol = new SharedSymbol(TradingMode.Spot, "BTC", "USDT");
|
|
var ticker = await binance.GetSpotTickerAsync(new GetTickerRequest(symbol));
|
|
```
|
|
|
|
Same code works on every exchange that implements the interface. Use `Task.WhenAll` for concurrent multi-exchange calls.
|
|
|
|
## Shared symbol metadata
|
|
|
|
CryptoExchange.Net 12.2.0 classifies the base and quote sides of `SharedSpotSymbol` and `SharedFuturesSymbol` with `SharedAssetType` (`Crypto`, `Fiat`, `TradFi`) and optional `SharedAssetSubType` (`StableCoin`, `Equity`, `Commodity`). The models also expose `DisplayName`. Use the corresponding base/quote fields on `GetSymbolsRequest` to filter symbol discovery.
|
|
|
|
`ISpotSymbolRestClient.SpotSymbolCatalog` is populated by `GetSpotSymbolsAsync`; `IFuturesSymbolRestClient.FuturesSymbolCatalog` is populated by `GetFuturesSymbolsAsync`. Do not assume a catalog is available before that request. For exchange-library implementations, `LibraryHelpers.IsStableCoin`, `IsCommodity`, and `IsEquity` offer best-effort classification and can be extended with exchange-specific values.
|
|
|
|
## Shared market-data quantities
|
|
|
|
CryptoExchange.Net 12.4.0 uses `SharedOrderQuantity` for market-data quantities. Prefer `Volumes` on `SharedSpotTicker`, `SharedFuturesTicker`, and `SharedKline`, and `Quantities` on `SharedTrade`; the scalar `Volume`, `QuoteVolume`, and `Quantity` members are obsolete.
|
|
|
|
## Single-exchange code uses the exchange's own client
|
|
|
|
For Binance-only code, use `BinanceRestClient` directly (see Binance.Net repo `AGENTS.md`). SharedApis is for portability — use it when you need that.
|
|
|
|
## Result pattern
|
|
|
|
REST methods return `HttpResult<T>` and websocket subscription methods return `WebSocketResult<UpdateSubscription>`. Check `.Success` before `.Data`. `.Error` has structured info. `.Exchange` on shared clients identifies which exchange responded.
|
|
|
|
## Available shared interfaces
|
|
|
|
REST: tickers, symbols, orderbook, klines, trades, orders (spot/futures, trigger, TP-SL), balances, positions, fees, deposits/withdrawals, transfers.
|
|
WebSocket: tickers, book tickers, orderbook, trades, klines, user data.
|
|
|
|
Each exchange library implements a subset. Check exchange docs for support matrix.
|
|
|
|
## Avoid
|
|
|
|
- Installing `CryptoExchange.Net` alone and trying to call exchange APIs (need exchange-specific packages)
|
|
- Mixing exchange-native models in cross-exchange code (use Shared* types)
|
|
- Synchronous `.Result` / `.Wait()` (use `await`)
|
|
- Instantiating clients per-request (use DI, reuse instances)
|
|
- Sequential per-exchange calls when parallel is fine (`Task.WhenAll`)
|
|
|
|
## Reference
|
|
|
|
For detailed patterns see `AGENTS.md` and `llms.txt` in repo root, `examples/ai-friendly/` for compilable examples.
|