Requirements
The exchange is required to implement the following list of methods and structures in order to get integrated with CCXT.
CCXT Integration Requirements
The exchange is required to implement the following list of methods and structures in order to get integrated with CCXT.
Public API
Exchange Information, Fee Schedule and Trading Rules
fetchMarkets– a list of trading pairs and their statuses + market structurefetchCurrencies– a list of tokens or assets and their statuses + currency structurefetchTradingLimits– min/max order volume, price, cost, precision, etc...fetchTradingFees– trading fees, either public or personalfetchFundingLimits– a list of withdrawal limits
Market Data
fetchTicker– 24h volumes and stats + ticker structurefetchOrderBook– L2/L3 + orderbook structurefetchTrades– a list of recent public trades + trade structurefetchOHLCV– a list of candles or kline data for traded volumes in different timeframes 1m, 15m, 1h, 1d, ... + OHLCV structure
Private API
Trading
fetchBalance– for all types of accounts + balance structurefetchAccounts– required if the exchange has multiple accounts or sub-accountscreateOrder– limit/market orders + order structurecancelOrdereditOrder– change the price and/or amount of an open order
Trading History
fetchOrder– one order by order id + order structurefetchOpenOrders– a list of all open ordersfetchOrders– a list of all ordersfetchMyTrades– the personal history of filled trades for the account + trade structure
Funding
fetchDepositAddress– deposit address(es) + address structurefetchDepositsfetchWithdrawalsfetchTransactions+ transaction structurefetchLedger– transactions, transfers, referrals, cashbacks + ledger entry structurewithdrawtransfer– required if exchange has multiple accounts or sub-accounts
FAQ
If your question is formulated in a short manner like the above, we won't help. We don't teach programming. If you're unable to read and understand the…
Contributing
Read the notes when opening a new issue on github and provide the requested details, so we can assist you better. You can also read the Troubleshooting section.