CCXT cryptocurrency exchange library for C# and .NET developers. Covers both REST API (standard) and WebSocket API (real-time)...
A comprehensive guide to using CCXT in C# and .NET projects for cryptocurrency exchange integration.
dotnet add package CCXT.NET
Or via Visual Studio:
using ccxt;
var exchange = new Binance();
await exchange.LoadMarkets();
var ticker = await exchange.FetchTicker("BTC/USDT");
Console.WriteLine(ticker);
using ccxt.pro;
var exchange = new Binance();
while (true)
{
var ticker = await exchange.WatchTicker("BTC/USDT");
Console.WriteLine(ticker.Last); // Live updates!
}
await exchange.Close();
| Feature | REST API | WebSocket API |
|---|---|---|
| Use for | One-time queries, placing orders | Real-time monitoring, live price feeds |
| Import | using ccxt; |
using ccxt.pro; |
| Methods | Fetch* (FetchTicker, FetchOrderBook) |
Watch* (WatchTicker, WatchOrderBook) |
| Speed | Slower (HTTP request/response) | Faster (persistent connection) |
| Rate limits | Strict (1-2 req/sec) | More lenient (continuous stream) |
| Best for | Trading, account management | Price monitoring, arbitrage detection |
Method naming: C# uses PascalCase - FetchTicker not fetchTicker, WatchTicker not watchTicker
using ccxt;
// Public API (no authentication)
var exchange = new Binance
{
EnableRateLimit = true // Recommended!
};
// Private API (with authentication)
var exchange = new Binance
{
ApiKey = "YOUR_API_KEY",
Secret = "YOUR_SECRET",
EnableRateLimit = true
};
using ccxt.pro;
// Public WebSocket
var exchange = new Binance();
// Private WebSocket (with authentication)
var exchange = new Binance
{
ApiKey = "YOUR_API_KEY",
Secret = "YOUR_SECRET"
};
// Always close when done
await exchange.Close();
// Load all available trading pairs
await exchange.LoadMarkets();
// Access market information
var btcMarket = exchange.Market("BTC/USDT");
Console.WriteLine(btcMarket.Limits.Amount.Min); // Minimum order amount
// Single ticker
var ticker = await exchange.FetchTicker("BTC/USDT");
Console.WriteLine(ticker.Last); // Last price
Console.WriteLine(ticker.Bid); // Best bid
Console.WriteLine(ticker.Ask); // Best ask
Console.WriteLine(ticker.Volume); // 24h volume
// Multiple tickers (if supported)
var tickers = await exchange.FetchTickers(new[] { "BTC/USDT", "ETH/USDT" });
// Full orderbook
var orderbook = await exchange.FetchOrderBook("BTC/USDT");
Console.WriteLine(orderbook.Bids[0]); // [price, amount]
Console.WriteLine(orderbook.Asks[0]); // [price, amount]
// Limited depth
var orderbook = await exchange.FetchOrderBook("BTC/USDT", 5); // Top 5 levels
// Buy limit order
var order = await exchange.CreateLimitBuyOrder("BTC/USDT", 0.01, 50000);
Console.WriteLine(order.Id);
// Sell limit order
var order = await exchange.CreateLimitSellOrder("BTC/USDT", 0.01, 60000);
// Generic limit order
var order = await exchange.CreateOrder("BTC/USDT", "limit", "buy", 0.01, 50000);
// Buy market order
var order = await exchange.CreateMarketBuyOrder("BTC/USDT", 0.01);
// Sell market order
var order = await exchange.CreateMarketSellOrder("BTC/USDT", 0.01);
// Generic market order
var order = await exchange.CreateOrder("BTC/USDT", "market", "sell", 0.01);
var balance = await exchange.FetchBalance();
Console.WriteLine(balance["BTC"].Free); // Available balance
Console.WriteLine(balance["BTC"].Used); // Balance in orders
Console.WriteLine(balance["BTC"].Total); // Total balance
// Open orders
var openOrders = await exchange.FetchOpenOrders("BTC/USDT");
// Closed orders
var closedOrders = await exchange.FetchClosedOrders("BTC/USDT");
// All orders (open + closed)
var allOrders = await exchange.FetchOrders("BTC/USDT");
// Single order by ID
var order = await exchange.FetchOrder(orderId, "BTC/USDT");
// Recent public trades
var trades = await exchange.FetchTrades("BTC/USDT", limit: 10);
// Your trades (requires authentication)
var myTrades = await exchange.FetchMyTrades("BTC/USDT");
// Cancel single order
await exchange.CancelOrder(orderId, "BTC/USDT");
// Cancel all orders for a symbol
await exchange.CancelAllOrders("BTC/USDT");
using ccxt.pro;
var exchange = new Binance();
while (true)
{
var ticker = await exchange.WatchTicker("BTC/USDT");
Console.WriteLine($"Last: {ticker.Last}");
}
await exchange.Close();
var exchange = new Binance();
while (true)
{
var orderbook = await exchange.WatchOrderBook("BTC/USDT");
Console.WriteLine($"Best bid: {orderbook.Bids[0][0]}");
Console.WriteLine($"Best ask: {orderbook.Asks[0][0]}");
}
await exchange.Close();
var exchange = new Binance();
while (true)
{
var trades = await exchange.WatchTrades("BTC/USDT");
foreach (var trade in trades)
{
Console.WriteLine($"{trade.Price} {trade.Amount} {trade.Side}");
}
}
await exchange.Close();
var exchange = new Binance
{
ApiKey = "YOUR_API_KEY",
Secret = "YOUR_SECRET"
};
while (true)
{
var orders = await exchange.WatchOrders("BTC/USDT");
foreach (var order in orders)
{
Console.WriteLine($"{order.Id} {order.Status} {order.Filled}");
}
}
await exchange.Close();
var exchange = new Binance
{
ApiKey = "YOUR_API_KEY",
Secret = "YOUR_SECRET"
};
while (true)
{
var balance = await exchange.WatchBalance();
Console.WriteLine($"BTC: {balance["BTC"].Total}");
}
await exchange.Close();
var exchange = new Binance();
var symbols = new[] { "BTC/USDT", "ETH/USDT", "SOL/USDT" };
while (true)
{
var tickers = await exchange.WatchTickers(symbols);
foreach (var kvp in tickers)
{
Console.WriteLine($"{kvp.Key}: {kvp.Value.Last}");
}
}
await exchange.Close();
fetchTicker(symbol) - Fetch ticker for one symbolfetchTickers([symbols]) - Fetch multiple tickers at oncefetchBidsAsks([symbols]) - Fetch best bid/ask for multiple symbolsfetchLastPrices([symbols]) - Fetch last pricesfetchMarkPrices([symbols]) - Fetch mark prices (derivatives)fetchOrderBook(symbol, limit) - Fetch order bookfetchOrderBooks([symbols]) - Fetch multiple order booksfetchL2OrderBook(symbol) - Fetch level 2 order bookfetchL3OrderBook(symbol) - Fetch level 3 order book (if supported)fetchTrades(symbol, since, limit) - Fetch public tradesfetchMyTrades(symbol, since, limit) - Fetch your trades (auth required)fetchOrderTrades(orderId, symbol) - Fetch trades for specific orderfetchOHLCV(symbol, timeframe, since, limit) - Fetch candlestick datafetchIndexOHLCV(symbol, timeframe) - Fetch index price OHLCVfetchMarkOHLCV(symbol, timeframe) - Fetch mark price OHLCVfetchPremiumIndexOHLCV(symbol, timeframe) - Fetch premium index OHLCVfetchBalance() - Fetch account balance (auth required)fetchAccounts() - Fetch sub-accountsfetchLedger(code, since, limit) - Fetch ledger historyfetchLedgerEntry(id, code) - Fetch specific ledger entryfetchTransactions(code, since, limit) - Fetch transactionsfetchDeposits(code, since, limit) - Fetch deposit historyfetchWithdrawals(code, since, limit) - Fetch withdrawal historyfetchDepositsWithdrawals(code, since, limit) - Fetch both deposits and withdrawalscreateOrder(symbol, type, side, amount, price, params) - Create order (generic)createLimitOrder(symbol, side, amount, price) - Create limit ordercreateMarketOrder(symbol, side, amount) - Create market ordercreateLimitBuyOrder(symbol, amount, price) - Buy limit ordercreateLimitSellOrder(symbol, amount, price) - Sell limit ordercreateMarketBuyOrder(symbol, amount) - Buy market ordercreateMarketSellOrder(symbol, amount) - Sell market ordercreateMarketBuyOrderWithCost(symbol, cost) - Buy with specific costcreateStopLimitOrder(symbol, side, amount, price, stopPrice) - Stop-limit ordercreateStopMarketOrder(symbol, side, amount, stopPrice) - Stop-market ordercreateStopLossOrder(symbol, side, amount, stopPrice) - Stop-loss ordercreateTakeProfitOrder(symbol, side, amount, takeProfitPrice) - Take-profit ordercreateTrailingAmountOrder(symbol, side, amount, trailingAmount) - Trailing stopcreateTrailingPercentOrder(symbol, side, amount, trailingPercent) - Trailing stop %createTriggerOrder(symbol, side, amount, triggerPrice) - Trigger ordercreatePostOnlyOrder(symbol, side, amount, price) - Post-only ordercreateReduceOnlyOrder(symbol, side, amount, price) - Reduce-only ordercreateOrders([orders]) - Create multiple orders at oncecreateOrderWithTakeProfitAndStopLoss(symbol, type, side, amount, price, tpPrice, slPrice) - OCO orderfetchOrder(orderId, symbol) - Fetch single orderfetchOrders(symbol, since, limit) - Fetch all ordersfetchOpenOrders(symbol, since, limit) - Fetch open ordersfetchClosedOrders(symbol, since, limit) - Fetch closed ordersfetchCanceledOrders(symbol, since, limit) - Fetch canceled ordersfetchOpenOrder(orderId, symbol) - Fetch specific open orderfetchOrdersByStatus(status, symbol) - Fetch orders by statuscancelOrder(orderId, symbol) - Cancel single ordercancelOrders([orderIds], symbol) - Cancel multiple orderscancelAllOrders(symbol) - Cancel all orders for symboleditOrder(orderId, symbol, type, side, amount, price) - Modify orderfetchBorrowRate(code) - Fetch borrow rate for marginfetchBorrowRates([codes]) - Fetch multiple borrow ratesfetchBorrowRateHistory(code, since, limit) - Historical borrow ratesfetchCrossBorrowRate(code) - Cross margin borrow ratefetchIsolatedBorrowRate(symbol, code) - Isolated margin borrow rateborrowMargin(code, amount, symbol) - Borrow marginrepayMargin(code, amount, symbol) - Repay marginfetchLeverage(symbol) - Fetch leveragesetLeverage(leverage, symbol) - Set leveragefetchLeverageTiers(symbols) - Fetch leverage tiersfetchMarketLeverageTiers(symbol) - Leverage tiers for marketsetMarginMode(marginMode, symbol) - Set margin mode (cross/isolated)fetchMarginMode(symbol) - Fetch margin modefetchPosition(symbol) - Fetch single positionfetchPositions([symbols]) - Fetch all positionsfetchPositionsForSymbol(symbol) - Fetch positions for symbolfetchPositionHistory(symbol, since, limit) - Position historyfetchPositionsHistory(symbols, since, limit) - Multiple position historyfetchPositionMode(symbol) - Fetch position mode (one-way/hedge)setPositionMode(hedged, symbol) - Set position modeclosePosition(symbol, side) - Close positioncloseAllPositions() - Close all positionsfetchFundingRate(symbol) - Current funding ratefetchFundingRates([symbols]) - Multiple funding ratesfetchFundingRateHistory(symbol, since, limit) - Funding rate historyfetchFundingHistory(symbol, since, limit) - Your funding paymentsfetchFundingInterval(symbol) - Funding intervalfetchSettlementHistory(symbol, since, limit) - Settlement historyfetchMySettlementHistory(symbol, since, limit) - Your settlement historyfetchOpenInterest(symbol) - Open interest for symbolfetchOpenInterests([symbols]) - Multiple open interestsfetchOpenInterestHistory(symbol, timeframe, since, limit) - OI historyfetchLiquidations(symbol, since, limit) - Public liquidationsfetchMyLiquidations(symbol, since, limit) - Your liquidationsfetchOption(symbol) - Fetch option infofetchOptionChain(code) - Fetch option chainfetchGreeks(symbol) - Fetch option greeksfetchVolatilityHistory(code, since, limit) - Volatility historyfetchUnderlyingAssets() - Fetch underlying assetsfetchTradingFee(symbol) - Trading fee for symbolfetchTradingFees([symbols]) - Trading fees for multiple symbolsfetchTradingLimits([symbols]) - Trading limitsfetchTransactionFee(code) - Transaction/withdrawal feefetchTransactionFees([codes]) - Multiple transaction feesfetchDepositWithdrawFee(code) - Deposit/withdrawal feefetchDepositWithdrawFees([codes]) - Multiple deposit/withdraw feesfetchDepositAddress(code, params) - Get deposit addressfetchDepositAddresses([codes]) - Multiple deposit addressesfetchDepositAddressesByNetwork(code) - Addresses by networkcreateDepositAddress(code, params) - Create new deposit addressfetchDeposit(id, code) - Fetch single depositfetchWithdrawal(id, code) - Fetch single withdrawalfetchWithdrawAddresses(code) - Fetch withdrawal addressesfetchWithdrawalWhitelist(code) - Fetch whitelistwithdraw(code, amount, address, tag, params) - Withdraw fundsdeposit(code, amount, params) - Deposit funds (if supported)transfer(code, amount, fromAccount, toAccount) - Internal transferfetchTransfer(id, code) - Fetch transfer infofetchTransfers(code, since, limit) - Fetch transfer historyfetchConvertCurrencies() - Currencies available for convertfetchConvertQuote(fromCode, toCode, amount) - Get conversion quotecreateConvertTrade(fromCode, toCode, amount) - Execute conversionfetchConvertTrade(id) - Fetch convert tradefetchConvertTradeHistory(code, since, limit) - Convert historyfetchMarkets() - Fetch all marketsfetchCurrencies() - Fetch all currenciesfetchTime() - Fetch exchange server timefetchStatus() - Fetch exchange statusfetchBorrowInterest(code, symbol, since, limit) - Borrow interest paidfetchLongShortRatio(symbol, timeframe, since, limit) - Long/short ratiofetchLongShortRatioHistory(symbol, timeframe, since, limit) - L/S ratio historyAll REST methods have WebSocket equivalents with watch* prefix:
watchTicker(symbol) - Watch single tickerwatchTickers([symbols]) - Watch multiple tickerswatchOrderBook(symbol) - Watch order book updateswatchOrderBookForSymbols([symbols]) - Watch multiple order bookswatchTrades(symbol) - Watch public tradeswatchOHLCV(symbol, timeframe) - Watch candlestick updateswatchBidsAsks([symbols]) - Watch best bid/askwatchBalance() - Watch balance updateswatchOrders(symbol) - Watch your order updateswatchMyTrades(symbol) - Watch your trade updateswatchPositions([symbols]) - Watch position updateswatchPositionsForSymbol(symbol) - Watch positions for symbolMethods marked with š require API credentials:
create* methods (creating orders, addresses)cancel* methods (canceling orders)edit* methods (modifying orders)fetchMy* methods (your trades, orders)fetchBalance, fetchLedger, fetchAccountswithdraw, transfer, depositwatchBalance, watchOrders, watchMyTrades, watchPositionsNot all exchanges support all methods. Check before using:
// Check if method is supported
if (exchange.has['fetchOHLCV']) {
const candles = await exchange.fetchOHLCV('BTC/USDT', '1h')
}
// Check multiple capabilities
console.log(exchange.has)
// {
// fetchTicker: true,
// fetchOHLCV: true,
// fetchMyTrades: true,
// fetchPositions: false,
// ...
// }
fetch* - REST API methods (HTTP requests)watch* - WebSocket methods (real-time streams)create* - Create new resources (orders, addresses)cancel* - Cancel existing resourcesedit* - Modify existing resourcesset* - Configure settings (leverage, margin mode)*Ws suffix - WebSocket variant (some exchanges)CCXT supports HTTP, HTTPS, and SOCKS proxies for both REST and WebSocket connections.
// HTTP Proxy
exchange.httpProxy = 'http://your-proxy-host:port'
// HTTPS Proxy
exchange.httpsProxy = 'https://your-proxy-host:port'
// SOCKS Proxy
exchange.socksProxy = 'socks://your-proxy-host:port'
// Proxy with authentication
exchange.httpProxy = 'http://user:pass@proxy-host:port'
WebSocket connections also respect proxy settings:
exchange.httpsProxy = 'https://proxy:8080'
// WebSocket connections will use this proxy
exchange.httpProxy = 'http://localhost:8080'
try {
await exchange.fetchTicker('BTC/USDT')
console.log('Proxy working!')
} catch (error) {
console.error('Proxy connection failed:', error)
}
Some exchanges provide WebSocket variants of REST methods for faster order placement and management. These use the *Ws suffix:
Creating Orders:
createOrderWs - Create order via WebSocket (faster than REST)createLimitOrderWs - Create limit order via WebSocketcreateMarketOrderWs - Create market order via WebSocketcreateLimitBuyOrderWs - Buy limit order via WebSocketcreateLimitSellOrderWs - Sell limit order via WebSocketcreateMarketBuyOrderWs - Buy market order via WebSocketcreateMarketSellOrderWs - Sell market order via WebSocketcreateStopLimitOrderWs - Stop-limit order via WebSocketcreateStopMarketOrderWs - Stop-market order via WebSocketcreateStopLossOrderWs - Stop-loss order via WebSocketcreateTakeProfitOrderWs - Take-profit order via WebSocketcreateTrailingAmountOrderWs - Trailing stop via WebSocketcreateTrailingPercentOrderWs - Trailing stop % via WebSocketcreatePostOnlyOrderWs - Post-only order via WebSocketcreateReduceOnlyOrderWs - Reduce-only order via WebSocketManaging Orders:
editOrderWs - Edit order via WebSocketcancelOrderWs - Cancel order via WebSocket (faster than REST)cancelOrdersWs - Cancel multiple orders via WebSocketcancelAllOrdersWs - Cancel all orders via WebSocketFetching Data:
fetchOrderWs - Fetch order via WebSocketfetchOrdersWs - Fetch orders via WebSocketfetchOpenOrdersWs - Fetch open orders via WebSocketfetchClosedOrdersWs - Fetch closed orders via WebSocketfetchMyTradesWs - Fetch your trades via WebSocketfetchBalanceWs - Fetch balance via WebSocketfetchPositionWs - Fetch position via WebSocketfetchPositionsWs - Fetch positions via WebSocketfetchPositionsForSymbolWs - Fetch positions for symbol via WebSocketfetchTradingFeesWs - Fetch trading fees via WebSocketUse *Ws methods when:
Use REST methods when:
REST API (slower, more reliable):
const order = await exchange.createOrder('BTC/USDT', 'limit', 'buy', 0.01, 50000)
WebSocket API (faster, lower latency):
const order = await exchange.createOrderWs('BTC/USDT', 'limit', 'buy', 0.01, 50000)
Not all exchanges support WebSocket trading methods:
if (exchange.has['createOrderWs']) {
// Exchange supports WebSocket order creation
const order = await exchange.createOrderWs('BTC/USDT', 'limit', 'buy', 0.01, 50000)
} else {
// Fall back to REST
const order = await exchange.createOrder('BTC/USDT', 'limit', 'buy', 0.01, 50000)
}
using System;
// During instantiation (recommended)
var exchange = new Binance
{
ApiKey = Environment.GetEnvironmentVariable("BINANCE_API_KEY"),
Secret = Environment.GetEnvironmentVariable("BINANCE_SECRET"),
EnableRateLimit = true
};
// After instantiation
exchange.ApiKey = Environment.GetEnvironmentVariable("BINANCE_API_KEY");
exchange.Secret = Environment.GetEnvironmentVariable("BINANCE_SECRET");
try
{
var balance = await exchange.FetchBalance();
Console.WriteLine("Authentication successful!");
}
catch (AuthenticationError)
{
Console.WriteLine("Invalid API credentials");
}
BaseError
āā NetworkError (recoverable - retry)
ā āā RequestTimeout
ā āā ExchangeNotAvailable
ā āā RateLimitExceeded
ā āā DDoSProtection
āā ExchangeError (non-recoverable - don't retry)
āā AuthenticationError
āā InsufficientFunds
āā InvalidOrder
āā NotSupported
using ccxt;
try
{
var ticker = await exchange.FetchTicker("BTC/USDT");
}
catch (NetworkError ex)
{
Console.WriteLine($"Network error - retry: {ex.Message}");
}
catch (ExchangeError ex)
{
Console.WriteLine($"Exchange error - do not retry: {ex.Message}");
}
catch (Exception ex)
{
Console.WriteLine($"Unknown error: {ex.Message}");
}
try
{
var order = await exchange.CreateOrder("BTC/USDT", "limit", "buy", 0.01, 50000);
}
catch (InsufficientFunds)
{
Console.WriteLine("Not enough balance");
}
catch (InvalidOrder)
{
Console.WriteLine("Invalid order parameters");
}
catch (RateLimitExceeded)
{
Console.WriteLine("Rate limit hit - wait before retrying");
await Task.Delay(1000); // Wait 1 second
}
catch (AuthenticationError)
{
Console.WriteLine("Check your API credentials");
}
async Task<Ticker> FetchWithRetry(int maxRetries = 3)
{
for (int i = 0; i < maxRetries; i++)
{
try
{
return await exchange.FetchTicker("BTC/USDT");
}
catch (NetworkError)
{
if (i < maxRetries - 1)
{
Console.WriteLine($"Retry {i + 1}/{maxRetries}");
await Task.Delay(1000 * (i + 1)); // Exponential backoff
}
else
{
throw;
}
}
}
return null;
}
var exchange = new Binance
{
EnableRateLimit = true // Automatically throttles requests
};
await exchange.FetchTicker("BTC/USDT");
await Task.Delay((int)exchange.RateLimit); // Wait between requests
await exchange.FetchTicker("ETH/USDT");
Console.WriteLine(exchange.RateLimit); // Milliseconds between requests
// Wrong - lowercase (JavaScript style)
var ticker = await exchange.fetchTicker("BTC/USDT"); // ERROR!
// Correct - PascalCase (C# style)
var ticker = await exchange.FetchTicker("BTC/USDT");
// Wrong - missing await
var ticker = exchange.FetchTicker("BTC/USDT"); // Returns Task, not Ticker!
Console.WriteLine(ticker.Last); // ERROR!
// Correct
var ticker = await exchange.FetchTicker("BTC/USDT");
Console.WriteLine(ticker.Last); // Works!
// Wrong - wastes rate limits
while (true)
{
var ticker = await exchange.FetchTicker("BTC/USDT"); // REST
Console.WriteLine(ticker.Last);
await Task.Delay(1000);
}
// Correct - use WebSocket
using ccxt.pro;
var exchange = new Binance();
while (true)
{
var ticker = await exchange.WatchTicker("BTC/USDT"); // WebSocket
Console.WriteLine(ticker.Last);
}
// Wrong - memory leak
var exchange = new ccxt.pro.Binance();
var ticker = await exchange.WatchTicker("BTC/USDT");
// Forgot to close!
// Correct
var exchange = new ccxt.pro.Binance();
try
{
while (true)
{
var ticker = await exchange.WatchTicker("BTC/USDT");
Console.WriteLine(ticker.Last);
}
}
finally
{
await exchange.Close();
}
// Wrong symbol formats
"BTCUSDT" // Wrong - no separator
"BTC-USDT" // Wrong - dash separator
"btc/usdt" // Wrong - lowercase
// Correct symbol format
"BTC/USDT" // Unified CCXT format
1. "Package CCXT.NET not found"
dotnet add package CCXT.NET2. "RateLimitExceeded"
EnableRateLimit = true3. "AuthenticationError"
4. "InvalidNonce"
5. "InsufficientFunds"
balance["BTC"].Free)6. "ExchangeNotAvailable"
// Enable verbose logging
exchange.Verbose = true;
// Check exchange capabilities
Console.WriteLine(exchange.Has);
// {
// FetchTicker = true,
// FetchOrderBook = true,
// CreateOrder = true,
// ...
// }
// Check market information
var market = exchange.Markets["BTC/USDT"];
// Check last request/response
Console.WriteLine(exchange.LastHttpResponse);
Console.WriteLine(exchange.LastJsonResponse);
CCXT supports prediction-market exchanges (Polymarket, Kalshi, Limitless, Myriad, Hyperliquid) under a dedicated ccxt.prediction namespace. They use the same unified API, but prices are quoted 0ā1 (USDC per outcome share) and the tradeable unit is an outcome (e.g. a market's YES/NO token), not a regular market symbol.
using ccxt;
var exchange = new ccxt.prediction.polymarket();
await exchange.loadMarkets();
// discover events -> markets -> outcomes (each outcome has: outcome (handle),
// outcomeId, market, label); also fetchEvents / fetchEvent are available
var events = await exchange.fetchEvents(new Dictionary<string, object>() {{ "query", "Trump" }});
// an outcome handle looks like 'TRUMP_OUT_PRESIDENT_2027:YES'
string handle = "TRUMP_OUT_PRESIDENT_2027:YES";
var ticker = await exchange.fetchTicker(handle);
var book = await exchange.fetchOrderBook(handle);
// limit buy 5 YES shares @ 0.40 USDC (price is 0..1 per share)
var order = await exchange.createOrder(handle, "limit", "buy", 5, 0.40);
await exchange.cancelOrder(exchange.safeString(order, "id"), handle);
fetchTicker, fetchOrderBook, fetchOHLCV, fetchTrades, createOrder, cancelOrder, ā¦) take an outcome handle or outcomeId (the outcome / outcomes parameter), not symbol.exchange.has["prediction"]; discover markets via fetchEvents / fetchEvent (or loadMarkets).Two things, either usable without the other. A client for the CCXT order-router service ā a
separate process holding live books across many venues, which answers "what is the cheapest way to
turn asset A into asset B right now?", including bridges (SOL -> USDT -> BTC when no SOL/BTC
market exists). And an execution engine for plans you build yourself, which needs no router
service and no API key. It is not an exchange: it does not derive from Exchange, has no unified
methods, and is constructed directly.
using dict = System.Collections.Generic.Dictionary<string, object>;
var router = new ccxt.OrderRouter(new dict());
// exactly one of amountIn / amountOut
var route = await router.FetchRoute("USDT", "BTC", new dict() { { "amountIn", 1000 } });
// Execute takes the route directly: it builds the plan, loads each venue's markets and
// runs the safety check itself, refusing to place anything on a blocking violation
var venues = new Dictionary<string, Exchange>() { { "binance", binance }, { "kraken", kraken } };
var report = await router.Execute(route, venues, new dict() {
{ "strategy", "sequential" },
{ "usdRates", new dict() { { "USDT", 1 } } },
});
// want to see or change the plan first? the steps in between are public and PURE (no I/O):
// BuildExecutionPlan(route, new dict()) then CheckExecutionPlanSafety(plan, markets, new dict())
execute defaults to dry_run, and anything other than an explicit live flag forces dry_run
regardless of the strategy requested ā a call that looks live but forgot the flag places nothing.
https://docs.ccxt.com/router/api. Every endpoint is public: there is no API key, no signup
and no login. The service rate-limits by client IP address instead.
The client still accepts an apiKey and still sends it as x-api-key when you pass one, so a
deployment that fronts the service with its own authentication keeps working. With no key the
header is omitted entirely rather than sent empty.
The full contract is published as OpenAPI 3.1 at https://docs.ccxt.com/router/openapi.yaml.
curl -O https://docs.ccxt.com/router/openapi.yaml and point codegen at it, import it into
Postman/Insomnia, or diff it between deploys. It is the authority on every field this client
reads; where the two disagree, the spec is right. Rendered prose version:
/router/docs and
/router/docs/api.
Free to use for now, up to the published rate limit ā not a permanent commitment, so expect a
paid tier eventually. Your existing key is how that would be billed; nothing in the client changes.
Read the limit off the response headers (x-ratelimit-limit, x-ratelimit-remaining,
x-ratelimit-reset) rather than hardcoding a number. A 429 raises RateLimitExceeded with the
retry interval folded into the message.
A router that has restarted is alive long before it can price anything. Asked to route in that
window it refuses with 503 cache_cold, and the client raises ExchangeNotAvailable ā a
retry, distinct from the ExchangeError that means something is actually wrong.
Holdings are POSTed, never put in a URL. FetchRoute normally sends a GET, but when you pass
balances the client switches to POST /route and puts every parameter in the body: the service
scrubs holdings from its own logs, but a reverse proxy, an ALB, a CDN, browser history and a
Referer all see the full request line, and no in-process redaction reaches them.
FetchRouteWithBalances does this for you.
Two flags the client verifies for you, because one silently lost in transit looks identical to
one never sent. balances: the service ignores them entirely if it predates the feature and
answers byte-identically, so FetchRoute throws unless the router echoes balancesApplied (or
balanceEntryCount, which is how an empty wallet is confirmed) ā pass requireBalancesApplied: false to opt out. requireFullFill: the one flag that fails open, so the client stamps what you
asked for and the safety check makes partial_fill blocking when you asked for a full fill and
did not get one.
An empty value is not an omitted one. Omit bridges and you get the default bridge set; send
bridges= and you have asked for no bridging at all. Same for exchanges= (no venues) and
balances= (you hold nothing). The client forwards an empty value rather than dropping it.
requestId is sent as the x-request-id header, so your log and the router's decision log can
be joined; the service mints one when absent.
| Method | Endpoint | Key? | Answers |
|---|---|---|---|
FetchHealth() |
/health |
no | is the process alive ā 200 from the first millisecond of boot |
FetchReadiness() |
/ready |
no | can it route yet: book counts, and how many are fresh |
FetchVersion() |
/version |
yes | which commit is deployed |
FetchSymbols() |
/symbols |
yes | the symbols it holds a book for |
FetchExchangesStatus() |
/exchanges/status |
yes | per-venue connection health |
FetchCachedOrderBook(exchangeId, symbol) |
/orderbook/{exchange}/{symbol} |
yes | the exact book a route was ranked on |
Gate deploys on readiness, not health ā /health is 200 before a single websocket has connected.
FetchReadiness() does not raise when the answer is no: the service replies 503 carrying the same
body it returns on 200, and you need those counts to know why.
var readiness = await router.FetchReadiness();
if ((string)readiness["status"] != "ready")
{
Console.WriteLine($"{readiness["freshCount"]} of {readiness["bookCount"]} books are fresh");
}
/metrics (Prometheus) has no client method ā it answers text/plain and this class parses every
response as JSON.
Watching a route. WatchRoute holds a WebSocket open and calls your hook with each RouteResult as
the books move; return 'stop' to close cleanly and get the last route back. Every frame is
stamped exactly as FetchRoute stamps its answer, so it can go straight into the plan builder. Three
endpoint rules differ from FetchRoute: balances and balanceMode are refused (a socket outlives
the holdings it was opened with ā refused client-side, before anything opens), includeQuotes
defaults to false, and refusals arrive as close codes rather than statuses ā 1008 raises
BadRequest and 1013 raises ExchangeNotAvailable, the same classes the REST path uses. A hook
that throws stops the stream and reaches you, unlike execute's step hook.
execute is not opaque. options.onStep is called after each step completes AND after its
reconciliation ā never mid-order ā and its return value decides whether the route continues.
var report = await router.Execute(plan, venues, new Dictionary<string, object> {
{ "strategy", "sequential" },
{ "retryFailedSteps", 2 }, // only a DEFINITIVELY REJECTED step is retried
{ "onStep", (Func<IDictionary<string, object>, string>)(ev =>
(string)ev["status"] == "partial" ? "halt" : "") }, // "halt" stops the route
});
The event is a plain dictionary: planId, stepIndex, hopIndex, legIndex, exchangeId,
symbol, side, status, requestedAmount, filledAmount, outAsset, outAmount, orderId,
clientOrderId, errorCode, attempt, reconciliation, ordersPlaced, halted, haltReason,
stepsTotal, stepsRemaining.
'halt' stops the route and sets haltReason to halted_by_on_step;
nothing it returns resumes a route the reconciliation already halted.reconciliation, so it always learns how the
route ended.report['errors'] as on_step_hook_failed and the run
continues; losing the report would destroy the only account of orders already live.For decisions that need I/O, slice the plan and call execute per hop with its own
idempotencyKey instead.
options.retryFailedSteps (default 0, retryDelayMs default 1000) re-places a step the venue
definitively rejected. An outcome_unknown step is never retried at any setting: it may
already be a live position, and re-placing it is the double-fill this class exists to prevent. The
winning attempt is reported as attempt. The router sets no client order id of its own ā venues
disagree on length and charset, so whatever you pass in orderParams travels untouched.
execute takes a plan, not a route, and never checks where the plan came from ā so your own
strategy can supply its own trades and still get the notional cap, halt-and-reconcile between hops,
resting-order cleanup and the unwind plan. A plan that has been through JSON or a database, or a
hand-rebuilt tail of a halted route, is equally valid.
A step is one order on one venue. Required: exchangeId, symbol, side, amount, base,
quote. Optional: stepIndex (defaults to position), hopIndex/legIndex (steps sharing a
hopIndex are one hop ā what parallel_within_hop parallelises), expectedPrice, limitPrice,
notionalQuote.
var plan = new Dictionary<string, object> {
{ "requestId", "my-strategy-0001" }, // identity; a live run refuses without one
{ "calculatedAt", exchange.Milliseconds() },
{ "steps", new List<object> {
new Dictionary<string, object> {
{ "exchangeId", "binance" }, { "symbol", "BTC/USDT" }, { "side", "buy" },
{ "amount", 0.01 }, { "base", "BTC" }, { "quote", "USDT" },
{ "hopIndex", 0 }, { "expectedPrice", 64000 },
},
} },
};
var report = await router.Execute(plan, venues, new Dictionary<string, object> {
{ "strategy", "sequential" }, { "maxNotionalUsd", 25 },
});
A live execute requires an identity and refuses without one: the identity is remembered in-process
so a second execute of the same plan is refused before any venue is contacted. Supply it as the
plan's requestId or as the options' idempotencyKey. execute never sets a clientOrderId of its
own: each exchange's CreateOrder keeps sending whatever identifier it generates internally, and a
clientOrderId you put in the options' orderParams travels untouched (to every step alike).
Make it stable and tied to the intent (a strategy name plus the signal's timestamp). A fresh value
per call ā a wall-clock timestamp and friends ā turns the guard off while looking like it is on. To
re-run deliberately, pass allowReexecution. The guard does not survive a restart.
checkExecutionPlanSafety is worth running on a hand-written plan first: it checks every step
against that venue's real market rules ā minimum amount, minimum cost, precision ā which is where a
hand-picked amount usually goes wrong.
Strategies: dry_run (default), sequential, parallel_within_hop (concurrent across venues,
serialised within a venue), limit_protected (rests a limit order and cancels it at
orderTimeoutMs, polling every pollIntervalMs), atomic_ish (requires the route pre-funded),
best_effort (single-hop, never halts).
Every report carries planAgeMs ā how old the plan's prices were when execute was called (-1
when the route carried no calculatedAt, which means unknown, not fresh). Pass
options.maxPlanAgeMs to refuse a live execution of a plan older than that; there is no default
limit, and under an active limit a plan whose age cannot be determined is refused too.
There is no notional cap by default ā trade cents or trade thousands. maxNotionalUsd is an
opt-in guardrail: pass it to the constructor, or per call in the options, and it is honoured
exactly at whatever value you choose, in either direction; omit it (or pass 0) and no notional
check runs. Only a negative value is refused.
A market order cannot be placed under a cap: the cap is checked against the plan's limit price and
a market order carries no price at all, so asking for allowMarketOrders together with a cap is
refused rather than silently unbounded.
When a cap IS set it is enforced immediately before every order ā not just at plan time, because a reconciliation may have resized the plan since ā and a step that cannot be valued in USD blocks, so supply a USD rate for every quote asset in the plan. With no cap set there is nothing to evaluate and USD rates are not required either.
In the report, status: 'outcome_unknown' means the request may or may not have reached the venue
ā execution halts rather than reconciling, because reconciling would read the fill as 0 and report
"nothing filled", asserting the one thing nobody knows. Check the open orders and the venue before
retrying. placementAttempted is false until an order was actually dispatched.
buildExecutionPlan refuses a route that does not run from the asset you offered to the asset you
wanted, or whose hops do not connect ā the answer is checked against the client's own record of
the question, so a compromised or buggy router response cannot steer orders into another market.
Full reference: Order Router in the CCXT Manual.