Requirements.md

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 structure
• fetchCurrencies – a list of tokens or assets and their statuses + currency structure
• fetchTradingLimits – min/max order volume, price, cost, precision, etc...
• fetchTradingFees – trading fees, either public or personal
• fetchFundingLimits – a list of withdrawal limits

Market Data

• fetchTicker – 24h volumes and stats + ticker structure
• fetchOrderBook – L2/L3 + orderbook structure
• fetchTrades – a list of recent public trades + trade structure
• fetchOHLCV – 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 structure
• fetchAccounts – required if the exchange has multiple accounts or sub-accounts
• createOrder – limit/market orders + order structure
• cancelOrder
• editOrder – change the price and/or amount of an open order

Trading History

• fetchOrder – one order by order id + order structure
• fetchOpenOrders – a list of all open orders
• fetchAllOrders – a list of all orders
• fetchMyTrades – the personal history of filled trades for the account + trade structure

Funding

• fetchDepositAddress – deposit address(es) + address structure
• fetchDeposits
• fetchWithdrawals
• fetchTransactions + transaction structure
• fetchLedger – transactions, transfers, referrals, cashbacks + ledger entry structure
• withdraw
• transfer – required if exchange has multiple accounts or sub-accounts