A JavaScript / Python / PHP cryptocurrency trading library with support for 100+ exchanges
Readme
Build Status <https://travis-ci.org/ccxt/ccxt>__ npm <https://npmjs.com/package/ccxt>__ PyPI <https://pypi.python.org/pypi/ccxt>__ NPM Downloads <https://www.npmjs.com/package/ccxt>__ Gitter <https://gitter.im/ccxt-dev/ccxt?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge>__ Supported Exchanges <https://github.com/ccxt/ccxt/wiki/Exchange-Markets>__ Open Collective <https://opencollective.com/ccxt>__
Twitter Follow <https://twitter.com/ccxt_official>__
A JavaScript / Python / PHP library for cryptocurrency trading and e-commerce with support for many bitcoin/ether/altcoin exchange markets and merchant APIs.
Install · Usage · Manual <https://github.com/ccxt/ccxt/wiki>__ · FAQ <https://github.com/ccxt/ccxt/wiki/FAQ>__ · Examples <https://github.com/ccxt/ccxt/tree/master/examples>__ · Contributing <https://github.com/ccxt/ccxt/blob/master/CONTRIBUTING.md>__ · Social
The **CCXT** library is used to connect and trade with cryptocurrency exchanges and payment processing services worldwide. It provides quick access to market data for storage, analysis, visualization, indicator development, algorithmic trading, strategy backtesting, bot programming, and related software engineering.
It is intended to be used by **coders, developers, technically-skilled traders, data-scientists and financial analysts** for building trading algorithms.
Current feature list:
- support for many cryptocurrency exchanges — more coming soon
- fully implemented public and private APIs
- optional normalized data for cross-exchange analytics and arbitrage
- an out of the box unified API that is extremely easy to integrate
- works in Node 7.6+, Python 2 and 3, PHP 5.4+, and web browsers
Sponsored Promotion
-------------------
Want this place? Contact us: info@ccxt.trade
`Placehodler <https://ccxt.trade/advertise/>`__
See Also
--------
- \ `Nomics API <https://p.nomics.com/cryptocurrency-bitcoin-api>`__\ `Nomics API <https://p.nomics.com/cryptocurrency-bitcoin-api>`__ — enterprise-grade `crypto market cap & pricing data <https://nomics.com>`__ API for your fund, smart contract, or app.
- \ `CoinGecko API <https://www.coingecko.com/api?utm_source=ccxt>`__\ `CoinGecko API <https://www.coingecko.com/api?utm_source=ccxt>`__ — free, reliable, and complete cryptocurrency data for your app. No keys required!
Certified Cryptocurrency Exchanges
----------------------------------
+-------------------------------------------------------------------------+----------+-------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| logo | id | name | ver | doc | certified |
+=========================================================================+==========+=========================================================================+=====+=================================================================================================+======================================================================+
| `binance <https://www.binance.com/?ref=10205187>`__ | binance | `Binance <https://www.binance.com/?ref=10205187>`__ | \* | `API <https://github.com/binance-exchange/binance-official-api-docs/blob/master/rest-api.md>`__ | `CCXT Certified <https://github.com/ccxt/ccxt/wiki/Certification>`__ |
+-------------------------------------------------------------------------+----------+-------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| `bitfinex <https://www.bitfinex.com>`__ | bitfinex | `Bitfinex <https://www.bitfinex.com>`__ | 1 | `API <https://docs.bitfinex.com/v1/docs>`__ | `CCXT Certified <https://github.com/ccxt/ccxt/wiki/Certification>`__ |
+-------------------------------------------------------------------------+----------+-------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| `bittrex <https://bittrex.com>`__ | bittrex | `Bittrex <https://bittrex.com>`__ | 1.1 | `API <https://bittrex.github.io/api/>`__ | `CCXT Certified <https://github.com/ccxt/ccxt/wiki/Certification>`__ |
+-------------------------------------------------------------------------+----------+-------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| `coss <https://www.coss.io/c/reg?r=OWCMHQVW2Q>`__ | coss | `COSS <https://www.coss.io/c/reg?r=OWCMHQVW2Q>`__ | 1 | `API <https://api.coss.io/v1/spec>`__ | `CCXT Certified <https://github.com/ccxt/ccxt/wiki/Certification>`__ |
+-------------------------------------------------------------------------+----------+-------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| `idex <https://idex.market>`__ | idex | `IDEX <https://idex.market>`__ | \* | `API <https://github.com/AuroraDAO/idex-api-docs>`__ | `CCXT Certified <https://github.com/ccxt/ccxt/wiki/Certification>`__ |
+-------------------------------------------------------------------------+----------+-------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| `kraken <https://www.kraken.com>`__ | kraken | `Kraken <https://www.kraken.com>`__ | 0 | `API <https://www.kraken.com/features/api>`__ | `CCXT Certified <https://github.com/ccxt/ccxt/wiki/Certification>`__ |
+-------------------------------------------------------------------------+----------+-------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| `kucoin <https://www.kucoin.com/?rcode=E5wkqe>`__ | kucoin | `KuCoin <https://www.kucoin.com/?rcode=E5wkqe>`__ | 2 | `API <https://docs.kucoin.com>`__ | `CCXT Certified <https://github.com/ccxt/ccxt/wiki/Certification>`__ |
+-------------------------------------------------------------------------+----------+-------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| `poloniex <https://www.poloniex.com/?utm_source=ccxt&utm_medium=web>`__ | poloniex | `Poloniex <https://www.poloniex.com/?utm_source=ccxt&utm_medium=web>`__ | \* | `API <https://docs.poloniex.com>`__ | `CCXT Certified <https://github.com/ccxt/ccxt/wiki/Certification>`__ |
+-------------------------------------------------------------------------+----------+-------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| `upbit <https://upbit.com>`__ | upbit | `Upbit <https://upbit.com>`__ | 1 | `API <https://docs.upbit.com/docs/%EC%9A%94%EC%B2%AD-%EC%88%98-%EC%A0%9C%ED%95%9C>`__ | `CCXT Certified <https://github.com/ccxt/ccxt/wiki/Certification>`__ |
+-------------------------------------------------------------------------+----------+-------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
Supported Cryptocurrency Exchange Markets
-----------------------------------------
The ccxt library currently supports the following 125 cryptocurrency exchange markets and trading APIs:
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| id | name | ver | doc | certified |
+====================+============================================================================================+=====+=================================================================================================+======================================================================+
| _1btcxe | `1BTCXE <https://1btcxe.com>`__ | \* | `API <https://1btcxe.com/api-docs.php>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| acx | `ACX <https://acx.io>`__ | 2 | `API <https://acx.io/documents/api_v2>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| allcoin | `Allcoin <https://www.allcoin.com>`__ | 1 | `API <https://www.allcoin.com/api_market/market>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| anxpro | `ANXPro <https://anxpro.com>`__ | \* | `API <https://anxv2.docs.apiary.io>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| bcex | `BCEX <https://www.bcex.top/register?invite_code=758978&lang=en>`__ | 1 | `API <https://github.com/BCEX-TECHNOLOGY-LIMITED/API_Docs/wiki/Interface>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| bequant | `Bequant <https://bequant.io>`__ | 2 | `API <https://api.bequant.io/>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| bibox | `Bibox <https://www.bibox.com/signPage?id=11114745&lang=en>`__ | 1 | `API <https://github.com/Biboxcom/api_reference/wiki/home_en>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| bigone | `BigONE <https://b1.run/users/new?code=D3LLBVFT>`__ | 2 | `API <https://open.big.one/docs/api.html>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| binance | `Binance <https://www.binance.com/?ref=10205187>`__ | \* | `API <https://github.com/binance-exchange/binance-official-api-docs/blob/master/rest-api.md>`__ | `CCXT Certified <https://github.com/ccxt/ccxt/wiki/Certification>`__ |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| binanceje | `Binance Jersey <https://www.binance.je/?ref=35047921>`__ | \* | `API <https://github.com/binance-exchange/binance-official-api-docs/blob/master/rest-api.md>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| bit2c | `Bit2C <https://bit2c.co.il/Aff/63bfed10-e359-420c-ab5a-ad368dab0baf>`__ | \* | `API <https://www.bit2c.co.il/home/api>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| bitbank | `bitbank <https://bitbank.cc/>`__ | 1 | `API <https://docs.bitbank.cc/>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| bitbay | `BitBay <https://auth.bitbay.net/ref/jHlbB4mIkdS1>`__ | \* | `API <https://bitbay.net/public-api>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| bitfinex | `Bitfinex <https://www.bitfinex.com>`__ | 1 | `API <https://docs.bitfinex.com/v1/docs>`__ | `CCXT Certified <https://github.com/ccxt/ccxt/wiki/Certification>`__ |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| bitfinex2 | `Bitfinex <https://www.bitfinex.com>`__ | 2 | `API <https://docs.bitfinex.com/v2/docs/>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| bitflyer | `bitFlyer <https://bitflyer.jp>`__ | 1 | `API <https://lightning.bitflyer.com/docs?lang=en>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| bitforex | `Bitforex <https://www.bitforex.com/en/invitationRegister?inviterId=1867438>`__ | 1 | `API <https://github.com/bitforexapi/API_Docs/wiki>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| bithumb | `Bithumb <https://www.bithumb.com>`__ | \* | `API <https://apidocs.bithumb.com>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| bitkk | `bitkk <https://www.bitkk.com>`__ | 1 | `API <https://www.bitkk.com/i/developer>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| bitlish | `Bitlish <https://bitlish.com>`__ | 1 | `API <https://bitlish.com/api>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| bitmart | `BitMart <http://www.bitmart.com/?r=rQCFLh>`__ | 2 | `API <https://github.com/bitmartexchange/bitmart-official-api-docs>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| bitmex | `BitMEX <https://www.bitmex.com/register/rm3C16>`__ | 1 | `API <https://www.bitmex.com/app/apiOverview>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| bitso | `Bitso <https://bitso.com/?ref=itej>`__ | 3 | `API <https://bitso.com/api_info>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| bitstamp | `Bitstamp <https://www.bitstamp.net>`__ | 2 | `API <https://www.bitstamp.net/api>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| bitstamp1 | `Bitstamp <https://www.bitstamp.net>`__ | 1 | `API <https://www.bitstamp.net/api>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| bittrex | `Bittrex <https://bittrex.com>`__ | 1.1 | `API <https://bittrex.github.io/api/>`__ | `CCXT Certified <https://github.com/ccxt/ccxt/wiki/Certification>`__ |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| bitz | `Bit-Z <https://u.bit-z.com/register?invite_code=1429193>`__ | 2 | `API <https://apidoc.bit-z.com/en/>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| bl3p | `BL3P <https://bl3p.eu>`__ | 1 | `API <https://github.com/BitonicNL/bl3p-api/tree/master/docs>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| bleutrade | `Bleutrade <https://bleutrade.com>`__ | 2 | `API <https://app.swaggerhub.com/apis-docs/bleu/white-label/3.0.0>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| braziliex | `Braziliex <https://braziliex.com/?ref=5FE61AB6F6D67DA885BC98BA27223465>`__ | \* | `API <https://braziliex.com/exchange/api.php>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| btcalpha | `BTC-Alpha <https://btc-alpha.com/?r=123788>`__ | 1 | `API <https://btc-alpha.github.io/api-docs>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| btcbox | `BtcBox <https://www.btcbox.co.jp/>`__ | 1 | `API <https://www.btcbox.co.jp/help/asm>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| btcchina | `BTCChina <https://www.btcchina.com>`__ | 1 | `API <https://www.btcchina.com/apidocs>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| btcmarkets | `BTC Markets <https://btcmarkets.net>`__ | \* | `API <https://github.com/BTCMarkets/API>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| btctradeim | `BtcTrade.im <https://m.baobi.com/invite?inv=1765b2>`__ | \* | `API <https://www.btctrade.im/help.api.html>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| btctradeua | `BTC Trade UA <https://btc-trade.com.ua/registration/22689>`__ | \* | `API <https://docs.google.com/document/d/1ocYA0yMy_RXd561sfG3qEPZ80kyll36HUxvCRe5GbhE/edit>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| btcturk | `BTCTurk <https://www.btcturk.com>`__ | \* | `API <https://github.com/BTCTrader/broker-api-docs>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| buda | `Buda <https://www.buda.com>`__ | 2 | `API <https://api.buda.com>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| bxinth | `BX.in.th <https://bx.in.th/ref/cYHknT/>`__ | \* | `API <https://bx.in.th/info/api>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| cex | `CEX.IO <https://cex.io/r/0/up105393824/0/>`__ | \* | `API <https://cex.io/cex-api>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| chilebit | `ChileBit <https://chilebit.net>`__ | 1 | `API <https://blinktrade.com/docs>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| cobinhood | `COBINHOOD <https://cobinhood.com?referrerId=a9d57842-99bb-4d7c-b668-0479a15a458b>`__ | 1 | `API <https://cobinhood.github.io/api-public>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| coinbase | `Coinbase <https://www.coinbase.com/join/58cbe25a355148797479dbd2>`__ | 2 | `API <https://developers.coinbase.com/api/v2>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| coinbaseprime | `Coinbase Prime <https://prime.coinbase.com>`__ | \* | `API <https://docs.prime.coinbase.com>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| coinbasepro | `Coinbase Pro <https://pro.coinbase.com/>`__ | \* | `API <https://docs.pro.coinbase.com/>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| coincheck | `coincheck <https://coincheck.com>`__ | \* | `API <https://coincheck.com/documents/exchange/api>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| coinegg | `CoinEgg <https://www.coinegg.com/user/register?invite=523218>`__ | \* | `API <https://www.coinegg.com/explain.api.html>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| coinex | `CoinEx <https://www.coinex.com/register?refer_code=yw5fz>`__ | 1 | `API <https://github.com/coinexcom/coinex_exchange_api/wiki>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| coinexchange | `CoinExchange <https://www.coinexchange.io/?r=a1669e56>`__ | \* | `API <https://coinexchangeio.github.io/slate/>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| coinfalcon | `CoinFalcon <https://coinfalcon.com/?ref=CFJSVGTUPASB>`__ | 1 | `API <https://docs.coinfalcon.com>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| coinfloor | `coinfloor <https://www.coinfloor.co.uk>`__ | \* | `API <https://github.com/coinfloor/api>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| coingi | `Coingi <https://www.coingi.com/?r=XTPPMC>`__ | \* | `API <https://coingi.docs.apiary.io>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| coinmarketcap | `CoinMarketCap <https://coinmarketcap.com>`__ | 1 | `API <https://coinmarketcap.com/api>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| coinmate | `CoinMate <https://coinmate.io?referral=YTFkM1RsOWFObVpmY1ZjMGREQmpTRnBsWjJJNVp3PT0>`__ | \* | `API <https://coinmate.docs.apiary.io>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| coinone | `CoinOne <https://coinone.co.kr>`__ | 2 | `API <https://doc.coinone.co.kr>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| coinspot | `CoinSpot <https://www.coinspot.com.au/register?code=PJURCU>`__ | \* | `API <https://www.coinspot.com.au/api>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| cointiger | `CoinTiger <https://www.cointiger.one/#/register?refCode=FfvDtt>`__ | 1 | `API <https://github.com/cointiger/api-docs-en/wiki>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| coolcoin | `CoolCoin <https://www.coolcoin.com/user/register?invite_code=bhaega>`__ | \* | `API <https://www.coolcoin.com/help.api.html>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| coss | `COSS <https://www.coss.io/c/reg?r=OWCMHQVW2Q>`__ | 1 | `API <https://api.coss.io/v1/spec>`__ | `CCXT Certified <https://github.com/ccxt/ccxt/wiki/Certification>`__ |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| crex24 | `CREX24 <https://crex24.com/?refid=slxsjsjtil8xexl9hksr>`__ | 2 | `API <https://docs.crex24.com/trade-api/v2>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| crypton | `Crypton <https://cryptonbtc.com>`__ | 1 | `API <https://cryptonbtc.docs.apiary.io/>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| deribit | `Deribit <https://www.deribit.com/reg-1189.4038>`__ | 1 | `API <https://docs.deribit.com>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| digifinex | `DigiFinex <https://www.digifinex.vip/en-ww/from/DhOzBg/3798****5114>`__ | 3 | `API <https://docs.digifinex.vip>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| dsx | `DSX <https://dsx.uk>`__ | 3 | `API <https://dsx.uk/developers/publicApi>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| dx | `DX.Exchange <https://dx.exchange/registration?dx_cid=20&dx_scname=100001100000038139>`__ | 1 | `API <https://apidocs.dx.exchange>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| ethfinex | `Ethfinex <https://www.ethfinex.com>`__ | 1 | `API <https://bitfinex.readme.io/v1/docs>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| exmo | `EXMO <https://exmo.me/?ref=131685>`__ | 1 | `API <https://exmo.me/en/api_doc?ref=131685>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| exx | `EXX <https://www.exx.com/r/fde4260159e53ab8a58cc9186d35501f?recommQd=1>`__ | \* | `API <https://www.exx.com/help/restApi>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| fcoin | `FCoin <https://www.fcoin.com/i/Z5P7V>`__ | 2 | `API <https://developer.fcoin.com>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| fcoinjp | `FCoinJP <https://www.fcoinjp.com>`__ | 2 | `API <https://developer.fcoin.com>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| flowbtc | `flowBTC <https://www.flowbtc.com.br>`__ | 1 | `API <https://www.flowbtc.com.br/api.html>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| foxbit | `FoxBit <https://foxbit.com.br/exchange>`__ | 1 | `API <https://foxbit.com.br/api/>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| fybse | `FYB-SE <https://www.fybse.se>`__ | \* | `API <https://fyb.docs.apiary.io>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| gateio | `Gate.io <https://www.gate.io/signup/2436035>`__ | 2 | `API <https://gate.io/api2>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| gdax | `GDAX <https://www.gdax.com>`__ | \* | `API <https://docs.gdax.com>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| gemini | `Gemini <https://gemini.com/>`__ | 1 | `API <https://docs.gemini.com/rest-api>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| hitbtc | `HitBTC <https://hitbtc.com/?ref_id=5a5d39a65d466>`__ | 1 | `API <https://github.com/hitbtc-com/hitbtc-api/blob/master/APIv1.md>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| hitbtc2 | `HitBTC <https://hitbtc.com/?ref_id=5a5d39a65d466>`__ | 2 | `API <https://api.hitbtc.com>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| huobipro | `Huobi Pro <https://www.huobi.co/en-us/topic/invited/?invite_code=rwrd3>`__ | 1 | `API <https://huobiapi.github.io/docs/spot/v1/cn/>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| huobiru | `Huobi Russia <https://www.huobi.com.ru/invite?invite_code=esc74>`__ | 1 | `API <https://github.com/cloudapidoc/API_Docs_en>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| ice3x | `ICE3X <https://ice3x.com?ref=14341802>`__ | 1 | `API <https://ice3x.co.za/ice-cubed-bitcoin-exchange-api-documentation-1-june-2017>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| idex | `IDEX <https://idex.market>`__ | \* | `API <https://github.com/AuroraDAO/idex-api-docs>`__ | `CCXT Certified <https://github.com/ccxt/ccxt/wiki/Certification>`__ |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| independentreserve | `Independent Reserve <https://www.independentreserve.com>`__ | \* | `API <https://www.independentreserve.com/API>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| indodax | `INDODAX <https://indodax.com/ref/testbitcoincoid/1>`__ | 1.8 | `API <https://indodax.com/downloads/BITCOINCOID-API-DOCUMENTATION.pdf>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| itbit | `itBit <https://www.itbit.com>`__ | 1 | `API <https://api.itbit.com/docs>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| kkex | `KKEX <https://kkex.com>`__ | 2 | `API <https://kkex.com/api_wiki/cn/>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| kraken | `Kraken <https://www.kraken.com>`__ | 0 | `API <https://www.kraken.com/features/api>`__ | `CCXT Certified <https://github.com/ccxt/ccxt/wiki/Certification>`__ |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| kucoin | `KuCoin <https://www.kucoin.com/?rcode=E5wkqe>`__ | 2 | `API <https://docs.kucoin.com>`__ | `CCXT Certified <https://github.com/ccxt/ccxt/wiki/Certification>`__ |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| kuna | `Kuna <https://kuna.io?r=kunaid-gvfihe8az7o4>`__ | 2 | `API <https://kuna.io/documents/api>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| lakebtc | `LakeBTC <https://www.lakebtc.com>`__ | 2 | `API <https://www.lakebtc.com/s/api_v2>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| latoken | `Latoken <https://latoken.com>`__ | 1 | `API <https://api.latoken.com>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| lbank | `LBank <https://www.lbex.io/invite?icode=7QCY>`__ | 1 | `API <https://github.com/LBank-exchange/lbank-official-api-docs>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| liquid | `Liquid <https://www.liquid.com?affiliate=SbzC62lt30976>`__ | 2 | `API <https://developers.liquid.com>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| livecoin | `LiveCoin <https://livecoin.net/?from=Livecoin-CQ1hfx44>`__ | \* | `API <https://www.livecoin.net/api?lang=en>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| luno | `luno <https://www.luno.com/invite/44893A>`__ | 1 | `API <https://www.luno.com/en/api>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| lykke | `Lykke <https://www.lykke.com>`__ | 1 | `API <https://hft-api.lykke.com/swagger/ui/>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| mandala | `Mandala <https://trade.mandalaex.com/?ref=564377>`__ | 1.1 | `API <https://apidocs.mandalaex.com>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| mercado | `Mercado Bitcoin <https://www.mercadobitcoin.com.br>`__ | 3 | `API <https://www.mercadobitcoin.com.br/api-doc>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| mixcoins | `MixCoins <https://mixcoins.com>`__ | 1 | `API <https://mixcoins.com/help/api/>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| negociecoins | `NegocieCoins <https://www.negociecoins.com.br>`__ | 3 | `API <https://www.negociecoins.com.br/documentacao-tradeapi>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| nova | `Novaexchange <https://novaexchange.com/signup/?re=is8vz2hsl3qxewv1uawd>`__ | 2 | `API <https://novaexchange.com/remote/faq>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| oceanex | `OceanEx <https://oceanex.pro/signup?referral=VE24QX>`__ | 1 | `API <https://api.oceanex.pro/doc/v1>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| okcoincny | `OKCoin CNY <https://www.okcoin.cn>`__ | 1 | `API <https://www.okcoin.cn/rest_getStarted.html>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| okcoinusd | `OKCoin USD <https://www.okcoin.com/account/register?flag=activity&channelId=600001513>`__ | 1 | `API <https://www.okcoin.com/docs/en/>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| okex | `OKEX <https://www.okex.com>`__ | 1 | `API <https://github.com/okcoin-okex/API-docs-OKEx.com>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| okex3 | `OKEX <https://www.okex.com>`__ | 3 | `API <https://www.okex.com/docs/en/>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| paymium | `Paymium <https://www.paymium.com>`__ | 1 | `API <https://github.com/Paymium/api-documentation>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| poloniex | `Poloniex <https://www.poloniex.com/?utm_source=ccxt&utm_medium=web>`__ | \* | `API <https://docs.poloniex.com>`__ | `CCXT Certified <https://github.com/ccxt/ccxt/wiki/Certification>`__ |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| rightbtc | `RightBTC <https://www.rightbtc.com>`__ | \* | `API <https://52.53.159.206/api/trader/>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| southxchange | `SouthXchange <https://www.southxchange.com>`__ | \* | `API <https://www.southxchange.com/Home/Api>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| stronghold | `Stronghold <https://stronghold.co>`__ | 1 | `API <https://docs.stronghold.co>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| surbitcoin | `SurBitcoin <https://surbitcoin.com>`__ | 1 | `API <https://blinktrade.com/docs>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| theocean | `The Ocean <https://theocean.trade>`__ | 1 | `API <https://docs.theocean.trade>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| therock | `TheRockTrading <https://therocktrading.com>`__ | 1 | `API <https://api.therocktrading.com/doc/v1/index.html>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| tidebit | `TideBit <http://bit.ly/2IX0LrM>`__ | 2 | `API <https://www.tidebit.com/documents/api/guide>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| tidex | `Tidex <https://tidex.com>`__ | 3 | `API <https://tidex.com/exchange/public-api>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| upbit | `Upbit <https://upbit.com>`__ | 1 | `API <https://docs.upbit.com/docs/%EC%9A%94%EC%B2%AD-%EC%88%98-%EC%A0%9C%ED%95%9C>`__ | `CCXT Certified <https://github.com/ccxt/ccxt/wiki/Certification>`__ |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| vaultoro | `Vaultoro <https://www.vaultoro.com>`__ | 1 | `API <https://api.vaultoro.com>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| vbtc | `VBTC <https://vbtc.exchange>`__ | 1 | `API <https://blinktrade.com/docs>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| virwox | `VirWoX <https://www.virwox.com>`__ | \* | `API <https://www.virwox.com/developers.php>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| xbtce | `xBTCe <https://xbtce.com/?agent=XX97BTCXXXG687021000B>`__ | 1 | `API <https://www.xbtce.com/tradeapi>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| yobit | `YoBit <https://www.yobit.net>`__ | 3 | `API <https://www.yobit.net/en/api/>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| zaif | `Zaif <https://zaif.jp>`__ | 1 | `API <https://techbureau-api-document.readthedocs.io/ja/latest/index.html>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| zb | `ZB <https://www.zb.com>`__ | 1 | `API <https://www.zb.com/i/developer>`__ | |
+--------------------+--------------------------------------------------------------------------------------------+-----+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
The list above is updated frequently, new crypto markets, exchanges, bug fixes, and API endpoints are introduced on a regular basis. See the `Manual <https://github.com/ccxt/ccxt/wiki>`__ for more details. If you can’t find a cryptocurrency exchange in the list above and want it to be added, post a link to it by opening an issue here on GitHub or send us an email.
The library is under `MIT license <https://github.com/ccxt/ccxt/blob/master/LICENSE.txt>`__, that means it’s absolutely free for any developer to build commercial and opensource software on top of it, but use it at your own risk with no warranties, as is.
--------------
Install
-------
The easiest way to install the CCXT library is to use a package manager:
- `ccxt in NPM <https://www.npmjs.com/package/ccxt>`__ (JavaScript / Node v7.6+)
- `ccxt in PyPI <https://pypi.python.org/pypi/ccxt>`__ (Python 2 and 3.5.3+)
- `ccxt in Packagist/Composer <https://packagist.org/packages/ccxt/ccxt>`__ (PHP 5.4+)
This library is shipped as an all-in-one module implementation with minimalistic dependencies and requirements:
- ```js/`` <https://github.com/ccxt/ccxt/blob/master/js/>`__ in JavaScript
- ```python/`` <https://github.com/ccxt/ccxt/blob/master/python/>`__ in Python (generated from JS)
- ```php/`` <https://github.com/ccxt/ccxt/blob/master/php/>`__ in PHP (generated from JS)
You can also clone it into your project directory from `ccxt GitHub repository <https://github.com/ccxt/ccxt>`__:
.. code:: shell
git clone https://github.com/ccxt/ccxt.git
JavaScript (NPM)
~~~~~~~~~~~~~~~~
JavaScript version of CCXT works in both Node and web browsers. Requires ES6 and ``async/await`` syntax support (Node 7.6.0+). When compiling with Webpack and Babel, make sure it is `not excluded <https://github.com/ccxt/ccxt/issues/225#issuecomment-331905178>`__ in your ``babel-loader`` config.
`ccxt in NPM <https://www.npmjs.com/package/ccxt>`__
.. code:: shell
npm install ccxt
.. code:: javascript
var ccxt = require ('ccxt')
console.log (ccxt.exchanges) // print all available exchanges
JavaScript (for use with the ``<script>`` tag):
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
All-in-one browser bundle (dependencies included), served from a CDN of your choice:
- jsDelivr: https://cdn.jsdelivr.net/npm/ccxt@1.88.1094/dist/ccxt.browser.js
- unpkg: https://unpkg.com/ccxt@1.88.1094/dist/ccxt.browser.js
CDNs are not updated in real-time and may have delays. Defaulting to the most recent version without specifying the version number is not recommended. Please, keep in mind that we are not responsible for the correct operation of those CDN servers.
.. code:: html
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/ccxt@1.88.1094/dist/ccxt.browser.js"></script>
Creates a global ``ccxt`` object:
.. code:: javascript
console.log (ccxt.exchanges) // print all available exchanges
Python
~~~~~~
`ccxt in PyPI <https://pypi.python.org/pypi/ccxt>`__
.. code:: shell
pip install ccxt
.. code:: python
import ccxt
print(ccxt.exchanges) # print a list of all available exchange classes
The library supports concurrent asynchronous mode with asyncio and async/await in Python 3.5.3+
.. code:: python
import ccxt.async_support as ccxt # link against the asynchronous version of ccxt
PHP
~~~
`ccxt in PHP with Packagist/Composer <https://packagist.org/packages/ccxt/ccxt>`__ (PHP 5.4+)
It requires common PHP modules:
- cURL
- mbstring (using UTF-8 is highly recommended)
- PCRE
- iconv
- gmp (this is a built-in extension as of PHP 7.2+)
.. code:: php
include "ccxt.php";
var_dump (\ccxt\Exchange::$exchanges); // print a list of all available exchange classes
Docker
~~~~~~
You can get CCXT installed in a container along with all the supported languages and dependencies. This may be useful if you want to contribute to CCXT (e.g. run the build scripts and tests — please see the `Contributing <https://github.com/ccxt/ccxt/blob/master/CONTRIBUTING.md>`__ document for the details on that).
Using ``docker-compose`` (in the cloned CCXT repository):
.. code:: shell
docker-compose run --rm ccxt
--------------
Documentation
-------------
Read the `Manual <https://github.com/ccxt/ccxt/wiki>`__ for more details.
Usage
-----
Intro
~~~~~
The CCXT library consists of a public part and a private part. Anyone can use the public part immediately after installation. Public APIs provide unrestricted access to public information for all exchange markets without the need to register a user account or have an API key.
Public APIs include the following:
- market data
- instruments/trading pairs
- price feeds (exchange rates)
- order books
- trade history
- tickers
- OHLC(V) for charting
- other public endpoints
In order to trade with private APIs you need to obtain API keys from an exchange’s website. It usually means signing up to the exchange and creating API keys for your account. Some exchanges require personal info or identification. Sometimes verification may be necessary as well. In this case you will need to register yourself, this library will not create accounts or API keys for you. Some exchanges expose API endpoints for registering an account, but most exchanges don’t. You will have to sign up and create API keys on their websites.
Private APIs allow the following:
- manage personal account info
- query account balances
- trade by making market and limit orders
- deposit and withdraw fiat and crypto funds
- query personal orders
- get ledger history
- transfer funds between accounts
- use merchant services
This library implements full public and private REST APIs for all exchanges. WebSocket and FIX implementations in JavaScript, PHP, Python and other languages coming soon.
The CCXT library supports both camelcase notation (preferred in JavaScript) and underscore notation (preferred in Python and PHP), therefore all methods can be called in either notation or coding style in any language.
.. code:: javascript
// both of these notations work in JavaScript/Python/PHP
exchange.methodName () // camelcase pseudocode
exchange.method_name () // underscore pseudocode
Read the `Manual <https://github.com/ccxt/ccxt/wiki>`__ for more details.
JavaScript
~~~~~~~~~~
.. code:: javascript
'use strict';
const ccxt = require ('ccxt');
(async function () {
let kraken = new ccxt.kraken ()
let bitfinex = new ccxt.bitfinex ({ verbose: true })
let huobipro = new ccxt.huobipro ()
let okcoinusd = new ccxt.okcoinusd ({
apiKey: 'YOUR_PUBLIC_API_KEY',
secret: 'YOUR_SECRET_PRIVATE_KEY',
})
const exchangeId = 'binance'
, exchangeClass = ccxt[exchangeId]
, exchange = new exchangeClass ({
'apiKey': 'YOUR_API_KEY',
'secret': 'YOUR_SECRET',
'timeout': 30000,
'enableRateLimit': true,
})
console.log (kraken.id, await kraken.loadMarkets ())
console.log (bitfinex.id, await bitfinex.loadMarkets ())
console.log (huobipro.id, await huobipro.loadMarkets ())
console.log (kraken.id, await kraken.fetchOrderBook (kraken.symbols[0]))
console.log (bitfinex.id, await bitfinex.fetchTicker ('BTC/USD'))
console.log (huobipro.id, await huobipro.fetchTrades ('ETH/CNY'))
console.log (okcoinusd.id, await okcoinusd.fetchBalance ())
// sell 1 BTC/USD for market price, sell a bitcoin for dollars immediately
console.log (okcoinusd.id, await okcoinusd.createMarketSellOrder ('BTC/USD', 1))
// buy 1 BTC/USD for $2500, you pay $2500 and receive ฿1 when the order is closed
console.log (okcoinusd.id, await okcoinusd.createLimitBuyOrder ('BTC/USD', 1, 2500.00))
// pass/redefine custom exchange-specific order params: type, amount, price or whatever
// use a custom order type
bitfinex.createLimitSellOrder ('BTC/USD', 1, 10, { 'type': 'trailing-stop' })
}) ();
.. _python-1:
Python
~~~~~~
.. code:: python
# coding=utf-8
import ccxt
hitbtc = ccxt.hitbtc({'verbose': True})
bitmex = ccxt.bitmex()
huobipro = ccxt.huobipro()
exmo = ccxt.exmo({
'apiKey': 'YOUR_PUBLIC_API_KEY',
'secret': 'YOUR_SECRET_PRIVATE_KEY',
})
kraken = ccxt.kraken({
'apiKey': 'YOUR_PUBLIC_API_KEY',
'secret': 'YOUR_SECRET_PRIVATE_KEY',
})
exchange_id = 'binance'
exchange_class = getattr(ccxt, exchange_id)
exchange = exchange_class({
'apiKey': 'YOUR_API_KEY',
'secret': 'YOUR_SECRET',
'timeout': 30000,
'enableRateLimit': True,
})
hitbtc_markets = hitbtc.load_markets()
print(hitbtc.id, hitbtc_markets)
print(bitmex.id, bitmex.load_markets())
print(huobipro.id, huobipro.load_markets())
print(hitbtc.fetch_order_book(hitbtc.symbols[0]))
print(bitmex.fetch_ticker('BTC/USD'))
print(huobipro.fetch_trades('LTC/CNY'))
print(exmo.fetch_balance())
# sell one ฿ for market price and receive $ right now
print(exmo.id, exmo.create_market_sell_order('BTC/USD', 1))
# limit buy BTC/EUR, you pay €2500 and receive ฿1 when the order is closed
print(exmo.id, exmo.create_limit_buy_order('BTC/EUR', 1, 2500.00))
# pass/redefine custom exchange-specific order params: type, amount, price, flags, etc...
kraken.create_market_buy_order('BTC/USD', 1, {'trading_agreement': 'agree'})
.. _php-1:
PHP
~~~
.. code:: php
include 'ccxt.php';
$poloniex = new \ccxt\poloniex ();
$bittrex = new \ccxt\bittrex (array ('verbose' => true));
$quoinex = new \ccxt\quoinex ();
$zaif = new \ccxt\zaif (array (
'apiKey' => 'YOUR_PUBLIC_API_KEY',
'secret' => 'YOUR_SECRET_PRIVATE_KEY',
));
$hitbtc = new \ccxt\hitbtc (array (
'apiKey' => 'YOUR_PUBLIC_API_KEY',
'secret' => 'YOUR_SECRET_PRIVATE_KEY',
));
$exchange_id = 'binance';
$exchange_class = "\\ccxt\\$exchange_id";
$exchange = new $exchange_class (array (
'apiKey' => 'YOUR_API_KEY',
'secret' => 'YOUR_SECRET',
'timeout' => 30000,
'enableRateLimit' => true,
));
$poloniex_markets = $poloniex->load_markets ();
var_dump ($poloniex_markets);
var_dump ($bittrex->load_markets ());
var_dump ($quoinex->load_markets ());
var_dump ($poloniex->fetch_order_book ($poloniex->symbols[0]));
var_dump ($bittrex->fetch_trades ('BTC/USD'));
var_dump ($quoinex->fetch_ticker ('ETH/EUR'));
var_dump ($zaif->fetch_ticker ('BTC/JPY'));
var_dump ($zaif->fetch_balance ());
// sell 1 BTC/JPY for market price, you pay ¥ and receive ฿ immediately
var_dump ($zaif->id, $zaif->create_market_sell_order ('BTC/JPY', 1));
// buy BTC/JPY, you receive ฿1 for ¥285000 when the order closes
var_dump ($zaif->id, $zaif->create_limit_buy_order ('BTC/JPY', 1, 285000));
// set a custom user-defined id to your order
$hitbtc->create_order ('BTC/USD', 'limit', 'buy', 1, 3000, array ('clientOrderId' => '123'));
Contributing
------------
Please read the `CONTRIBUTING <https://github.com/ccxt/ccxt/blob/master/CONTRIBUTING.md>`__ document before making changes that you would like adopted in the code. Also, read the `Manual <https://github.com/ccxt/ccxt/wiki>`__ for more details.
Support Developer Team
----------------------
We are investing a significant amount of time into the development of this library. If CCXT made your life easier and you want to help us improve it further, or if you want to speed up development of new features and exchanges, please support us with a tip. We appreciate all contributions!
Sponsors
~~~~~~~~
Support this project by becoming a sponsor. Your logo will show up here with a link to your website.
[`Become a sponsor <https://opencollective.com/ccxt#sponsor>`__]
Supporters
~~~~~~~~~~
Support this project by becoming a supporter. Your avatar will show up here with a link to your website.
[`Become a supporter <https://opencollective.com/ccxt#supporter>`__]
Backers
~~~~~~~
Thank you to all our backers! [`Become a backer <https://opencollective.com/ccxt#backer>`__]
Crypto
~~~~~~
::
ETH 0x26a3CB49578F07000575405a57888681249c35Fd (ETH only)
BTC 33RmVRfhK2WZVQR1R83h2e9yXoqRNDvJva
BCH 1GN9p233TvNcNQFthCgfiHUnj5JRKEc2Ze
LTC LbT8mkAqQBphc4yxLXEDgYDfEax74et3bP
Thank you!
Social
------
- `Follow us on Twitter <https://twitter.com/ccxt_official>`__
- `Read our blog on Medium <https://medium.com/@ccxt>`__
Team
----
- `Igor Kroitor <https://github.com/kroitor>`__
- `Vitaly Gordon <https://github.com/xpl>`__
- `Denis Voropaev <https://github.com/tankakatan>`__
- `Carlo Revelli <https://github.com/frosty00>`__
Contact Us
----------
For business inquiries: info@ccxt.trade
FAQs
A JavaScript / Python / PHP cryptocurrency trading library with support for 100+ exchanges
We found that uvoo demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.