preidman-ccxt
Version:
A JavaScript / Python / PHP cryptocurrency trading library with support for 100+ exchanges
149 lines (141 loc) • 222 kB
Markdown
# Overview
The ccxt library is a collection of available crypto *exchanges* or exchange classes. Each class implements the public and private API for a particular crypto exchange. All exchanges are derived from the base Exchange class and share a set of common methods. To access a particular exchange from ccxt library you need to create an instance of corresponding exchange class. Supported exchanges are updated frequently and new exchanges are added regularly.
The structure of the library can be outlined as follows:
```
User
+-------------------------------------------------------------+
| CCXT |
+------------------------------+------------------------------+
| Public | Private |
+=============================================================+
│ . |
│ The Unified CCXT API |
│ . |
| loadMarkets . fetchBalance |
| fetchMarkets . createOrder |
| fetchCurrencies . cancelOrder |
| fetchTicker . fetchOrder |
| fetchTickers . fetchOrders |
| fetchOrderBook . fetchOpenOrders |
| fetchOHLCV . fetchClosedOrders |
| fetchTrades . fetchMyTrades |
| . deposit |
| . withdraw |
│ . |
+=============================================================+
│ . |
| Custom Exchange API |
| (Derived Classes And Their Implicit Methods) |
│ . |
| publicGet... . privateGet... |
| publicPost... . privatePost... |
| . privatePut... |
| . privateDelete... |
| . sign |
│ . |
+=============================================================+
│ . |
| Base Exchange Class |
│ . |
+=============================================================+
```
Full public and private HTTP REST APIs for all exchanges are implemented. WebSocket and FIX implementations in JavaScript, PHP, Python and other languages coming soon.
- [Exchanges](#exchanges)
- [Markets](#markets)
- [API Methods / Endpoints](#api-methods--endpoints)
- [Market Data](#market-data)
- [Trading](#trading)
# Exchanges
The ccxt library currently supports the following 133 cryptocurrency exchange markets and trading APIs:
| | id | name | certified | ver | doc | countries |
|---------------------------------------------------------------------------------------------------------------------------|--------------------|--------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------:|:-----:|--------------------------------------------------------------------------------------------------|-----------------------------------------|
| | _1btcxe | [1BTCXE](https://1btcxe.com) | | * | [API](https://1btcxe.com/api-docs.php) | Panama |
| | acx | [ACX](https://acx.io) | | 2 | [API](https://acx.io/documents/api_v2) | Australia |
| | allcoin | [Allcoin](https://www.allcoin.com) | | 1 | [API](https://www.allcoin.com/api_market/market) | Canada |
| | anxpro | [ANXPro](https://anxpro.com) | | 2 | [API](http://docs.anxv2.apiary.io) | Japan, Singapore, Hong Kong, New Zealand|
| | anybits | [Anybits](https://anybits.com) | | * | [API](https://anybits.com/help/api) | Ireland |
| | bcex | [BCEX](https://www.bcex.top/user/reg/type/2/pid/758978) | | 1 | [API](https://www.bcex.top/api_market/market/) | China, Canada |
| | bibox | [Bibox](https://www.bibox.com/signPage?id=11114745&lang=en) | | 1 | [API](https://github.com/Biboxcom/api_reference/wiki/home_en) | China, US, South Korea |
| | bigone | [BigONE](https://b1.run/users/new?code=D3LLBVFT) | | 2 | [API](https://open.big.one/docs/api.html) | UK |
| | binance | [Binance](https://www.binance.com/?ref=10205187) | [](https://github.com/ccxt/ccxt/wiki/Certification) | * | [API](https://github.com/binance-exchange/binance-official-api-docs/blob/master/rest-api.md) | Japan |
| | bit2c | [Bit2C](https://www.bit2c.co.il) | | * | [API](https://www.bit2c.co.il/home/api) | Israel |
| | bitbank | [bitbank](https://bitbank.cc/) | | 1 | [API](https://docs.bitbank.cc/) | Japan |
| | bitbay | [BitBay](https://bitbay.net) | | * | [API](https://bitbay.net/public-api) | Malta, EU |
| | bitfinex | [Bitfinex](https://www.bitfinex.com) | [](https://github.com/ccxt/ccxt/wiki/Certification) | 1 | [API](https://bitfinex.readme.io/v1/docs) | British Virgin Islands |
| | bitfinex2 | [Bitfinex v2](https://www.bitfinex.com) | | 2 | [API](https://bitfinex.readme.io/v2/docs) | British Virgin Islands |
| | bitflyer | [bitFlyer](https://bitflyer.jp) | | 1 | [API](https://bitflyer.jp/API) | Japan |
| | bitforex | [Bitforex](https://www.bitforex.com/registered?inviterId=1867438) | | 1 | [API](https://github.com/bitforexapi/API_Docs/wiki) | China |
| | bithumb | [Bithumb](https://www.bithumb.com) | | * | [API](https://apidocs.bithumb.com) | South Korea |
| | bitibu | [Bitibu](https://bitibu.com) | | 2 | [API](https://bitibu.com/documents/api_v2) | Cyprus |
| | bitkk | [bitkk](https://vip.zb.com/user/register?recommendCode=bn070u) | | 1 | [API](https://www.bitkk.com/i/developer) | China |
| | bitlish | [Bitlish](https://bitlish.com) | | 1 | [API](https://bitlish.com/api) | UK, EU, Russia |
| | bitmarket | [BitMarket](https://www.bitmarket.net/?ref=23323) | | * | [API](https://www.bitmarket.net/docs.php?file=api_public.html) | Poland, EU |
| | bitmex | [BitMEX](https://www.bitmex.com/register/rm3C16) | | 1 | [API](https://www.bitmex.com/app/apiOverview) | Seychelles |
| | bitsane | [Bitsane](https://bitsane.com) | | * | [API](https://bitsane.com/info-api) | Ireland |
| | bitso | [Bitso](https://bitso.com/?ref=itej) | | 3 | [API](https://bitso.com/api_info) | Mexico |
| | bitstamp | [Bitstamp](https://www.bitstamp.net) | | 2 | [API](https://www.bitstamp.net/api) | UK |
| | bitstamp1 | [Bitstamp v1](https://www.bitstamp.net) | | 1 | [API](https://www.bitstamp.net/api) | UK |
| | bittrex | [Bittrex](https://bittrex.com) | [](https://github.com/ccxt/ccxt/wiki/Certification) | 1.1 | [API](https://bittrex.com/Home/Api) | US |
| | bitz | [Bit-Z](https://u.bit-z.com/register?invite_code=1429193) | | 2 | [API](https://apidoc.bit-z.com/en) | Hong Kong |
| | bl3p | [BL3P](https://bl3p.eu) | | 1 | [API](https://github.com/BitonicNL/bl3p-api/tree/master/docs) | Netherlands, EU |
| | bleutrade | [Bleutrade](https://bleutrade.com) | | 2 | [API](https://bleutrade.com/help/API) | Brazil |
| | braziliex | [Braziliex](https://braziliex.com/?ref=5FE61AB6F6D67DA885BC98BA27223465) | | * | [API](https://braziliex.com/exchange/api.php) | Brazil |
| | btcalpha | [BTC-Alpha](https://btc-alpha.com/?r=123788) | | 1 | [API](https://btc-alpha.github.io/api-docs) | US |
| | btcbox | [BtcBox](https://www.btcbox.co.jp/) | | 1 | [API](https://www.btcbox.co.jp/help/asm) | Japan |
| | btcchina | [BTCChina](https://www.btcchina.com) | | 1 | [API](https://www.btcchina.com/apidocs) | China |
| | btcexchange | [BTCExchange](https://www.btcexchange.ph) | | * | [API](https://github.com/BTCTrader/broker-api-docs) | Philippines |
| | btcmarkets | [BTC Markets](https://btcmarkets.net) | | * | [API](https://github.com/BTCMarkets/API) | Australia |
| | btctradeim | [BtcTrade.im](https://www.btctrade.im) | | * | [API](https://www.btctrade.im/help.api.html) | Hong Kong |
| | btctradeua | [BTC Trade UA](https://btc-trade.com.ua) | | * | [API](https://docs.google.com/document/d/1ocYA0yMy_RXd561sfG3qEPZ80kyll36HUxvCRe5GbhE/edit) | Ukraine |
| | btcturk | [BTCTurk](https://www.btcturk.com) | | * | [API](https://github.com/BTCTrader/broker-api-docs) | Turkey |
| | buda | [Buda](https://www.buda.com) | | 2 | [API](https://api.buda.com) | Argentina, Chile, Colombia, Peru |
| | bxinth | [BX.in.th](https://bx.in.th) | | * | [API](https://bx.in.th/info/api) | Thailand |
| | ccex | [C-CEX](https://c-cex.com) | | * | [API](https://c-cex.com/?id=api) | Germany, EU |
| | cex | [CEX.IO](https://cex.io/r/0/up105393824/0/) | | * | [API](https://cex.io/cex-api) | UK, EU, Cyprus, Russia |
| | chbtc | [CHBTC](https://vip.zb.com/user/register?recommendCode=bn070u) | | 1 | [API](https://www.chbtc.com/i/developer) | China |
| | chilebit | [ChileBit](https://chilebit.net) | | 1 | [API](https://blinktrade.com/docs) | Chile |
| | cobinhood | [COBINHOOD](https://cobinhood.com) | | 1 | [API](https://cobinhood.github.io/api-public) | Taiwan |
| | coinbase | [Coinbase](https://www.coinbase.com/join/58cbe25a355148797479dbd2) | | 2 | [API](https://developers.coinbase.com/api/v2) | US |
| | coinbaseprime | [Coinbase Prime](https://prime.coinbase.com) | | * | [API](https://docs.prime.coinbase.com) | US |
| | coinbasepro | [Coinbase Pro](https://pro.coinbase.com/) | | * | [API](https://docs.pro.coinbase.com/) | US |
| | coincheck | [coincheck](https://coincheck.com) | | * | [API](https://coincheck.com/documents/exchange/api) | Japan, Indonesia |
| | coinegg | [CoinEgg](https://www.coinegg.com) | | * | [API](https://www.coinegg.com/explain.api.html) | China, UK |
| | coinex | [CoinEx](https://www.coinex.com/account/signup?refer_code=yw5fz) | | 1 | [API](https://github.com/coinexcom/coinex_exchange_api/wiki) | China |
| | coinexchange | [CoinExchange](https://www.coinexchange.io) | | * | [API](https://coinexchangeio.github.io/slate/) | India, Japan, South Korea, Vietnam, US |
| | coinfalcon | [CoinFalcon](https://coinfalcon.com/?ref=CFJSVGTUPASB) | | 1 | [API](https://docs.coinfalcon.com) | UK |
| | coinfloor | [coinfloor](https://www.coinfloor.co.uk) | | * | [API](https://github.com/coinfloor/api) | UK |
| | coingi | [Coingi](https://coingi.com) | | * | [API](http://docs.coingi.apiary.io/) | Panama, Bulgaria, China, US |
| | coinmarketcap | [CoinMarketCap](https://coinmarketcap.com) | | 1 | [API](https://coinmarketcap.com/api) | US |
| | coinmate | [CoinMate](https://coinmate.io?referral=YTFkM1RsOWFObVpmY1ZjMGREQmpTRnBsWjJJNVp3PT0) | | * | [API](http://docs.coinmate.apiary.io) | UK, Czech Republic, EU |
| | coinnest | [coinnest](https://www.coinnest.co.kr) | | * | [API](https://www.coinnest.co.kr/doc/intro.html) | South Korea |
| | coinone | [CoinOne](https://coinone.co.kr) | | 2 | [API](https://doc.coinone.co.kr) | South Korea |
| | coinspot | [CoinSpot](https://www.coinspot.com.au) | | * | [API](https://www.coinspot.com.au/api) | Australia |
| | cointiger | [CoinTiger](https://www.cointiger.pro/exchange/register.html?refCode=FfvDtt) | | 1 | [API](https://github.com/cointiger/api-docs-en/wiki) | China |
| | coolcoin | [CoolCoin](https://www.coolcoin.com) | | * | [API](https://www.coolcoin.com/help.api.html) | Hong Kong |
| | coss | [COSS](https://www.coss.io/c/reg?r=OWCMHQVW2Q) | [](https://github.com/ccxt/ccxt/wiki/Certification) | 1 | [API](https://api.coss.io/v1/spec) | Singapore, Netherlands |
| | crex24 | [CREX24](https://crex24.com/?refid=slxsjsjtil8xexl9hksr) | | 2 | [API](https://docs.crex24.com/trade-api/v2) | Estonia |
| | crypton | [Crypton](https://cryptonbtc.com) | | 1 | [API](https://cryptonbtc.docs.apiary.io/) | EU |
| | cryptopia | [Cryptopia](https://www.cryptopia.co.nz/Register?referrer=kroitor) | | * | [API](https://support.cryptopia.co.nz/csm?id=kb_article&sys_id=a75703dcdbb9130084ed147a3a9619bc) | New Zealand |
| | deribit | [Deribit](https://www.deribit.com/reg-1189.4038) | | 1 | [API](https://www.deribit.com/pages/docs/api) | Netherlands |
| | dsx | [DSX](https://dsx.uk) | | 2 | [API](https://api.dsx.uk) | UK |
| | ethfinex | [Ethfinex](https://www.ethfinex.com) | | 1 | [API](https://bitfinex.readme.io/v1/docs) | British Virgin Islands |
| | exmo | [EXMO](https://exmo.me/?ref=131685) | | 1 | [API](https://exmo.me/en/api_doc?ref=131685) | Spain, Russia |
| | exx | [EXX](https://www.exx.com/r/fde4260159e53ab8a58cc9186d35501f) | | * | [API](https://www.exx.com/help/restApi) | China |
| | fcoin | [FCoin](https://www.fcoin.com/i/Z5P7V) | | 2 | [API](https://developer.fcoin.com) | China |
| | flowbtc | [flowBTC](https://trader.flowbtc.com) | | 1 | [API](https://www.flowbtc.com.br/api.html) | Brazil |
| | foxbit | [FoxBit](https://foxbit.exchange) | | 1 | [API](https://blinktrade.com/docs) | Brazil |
| | fybse | [FYB-SE](https://www.fybse.se) | | * | [API](http://docs.fyb.apiary.io) | Sweden |
| | fybsg | [FYB-SG](https://www.fybsg.com) | | * | [API](http://docs.fyb.apiary.io) | Singapore |
| | gatecoin | [Gatecoin](https://gatecoin.com) | | * | [API](https://gatecoin.com/api) | Hong Kong |
| | gateio | [Gate.io](https://www.gate.io/signup/2436035) | | 2 | [API](https://gate.io/api2) | China |
| | gdax | [GDAX](https://www.gdax.com) | | * | [API](https://docs.gdax.com) | US |
| | gemini | [Gemini](https://gemini.com) | | 1 | [API](https://docs.gemini.com/rest-api) | US |
| | getbtc | [GetBTC](https://getbtc.org) | | * | [API](https://getbtc.org/api-docs.php) | St. Vincent & Grenadines, Russia |
| | hadax | [HADAX](https://www.huobi.br.com/en-us/topic/invited/?invite_code=rwrd3) | | 1 | [API](https://github.com/huobiapi/API_Docs/wiki) | China |
| | hitbtc | [HitBTC](https://hitbtc.com/?ref_id=5a5d39a65d466) | | 1 | [API](https://github.com/hitbtc-com/hitbtc-api/blob/master/APIv1.md) | Hong Kong |
| | hitbtc2 | [HitBTC v2](https://hitbtc.com/?ref_id=5a5d39a65d466) | | 2 | [API](https://api.hitbtc.com) | Hong Kong |
| | huobipro | [Huobi Pro](https://www.huobi.br.com/en-us/topic/invited/?invite_code=rwrd3) | | 1 | [API](https://github.com/huobiapi/API_Docs/wiki/REST_api_reference) | China |
| | ice3x | [ICE3X](https://ice3x.com?ref=14341802) | | 1 | [API](https://ice3x.co.za/ice-cubed-bitcoin-exchange-api-documentation-1-june-2017) | South Africa |
| | independentreserve | [Independent Reserve](https://www.independentreserve.com) | | * | [API](https://www.independentreserve.com/API) | Australia, New Zealand |
| | indodax | [INDODAX](https://indodax.com/ref/testbitcoincoid/1) | | 1.8 | [API](https://indodax.com/downloads/BITCOINCOID-API-DOCUMENTATION.pdf) | Indonesia |
| | itbit | [itBit](https://www.itbit.com) |