CCXT – CryptoCurrency eXchange Trading Library
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>
__ NSP Status <https://nodesecurity.io/orgs/ccxt/projects/856d3088-8b46-4515-9324-6b7cd2470522>
__ 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>
__
A JavaScript / Python / PHP library for cryptocurrency trading and e-commerce with support for many bitcoin/ether/altcoin exchange markets and merchant APIs.
The CCXT library is used to connect and trade with cryptocurrency / altcoin 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, webshop integration 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 on top of it.
Current feature list:
- support for many exchange markets, even more upcoming soon
- fully implemented public and private APIs for all exchanges
- all currencies, altcoins and symbols, prices, order books, trades, tickers, etc…
- optional normalized data for cross-exchange or cross-currency analytics and arbitrage
- an out-of-the box unified all-in-one API extremely easy to integrate
- works in Node 7.6+, Python 2 and 3, PHP 5.3+, web browsers
ccxt on GitHub <https://github.com/ccxt/ccxt>
__ | Install <#install>
__ | Usage <#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>
__ | Changelog <https://github.com/ccxt/ccxt/blob/master/CHANGELOG.md>
__ | Contributing <https://github.com/ccxt/ccxt/blob/master/CONTRIBUTING.md>
__
Supported Cryptocurrency Exchange Markets
The ccxt library currently supports the following 125 cryptocurrency exchange markets and trading APIs:
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| | id | name | ver | doc | countries |
+======================+====================+=================================================================================+=====+=====================================================================================================+==========================================+
| |1broker| | 1broker | 1Broker <https://1broker.com>
| 2 | API <https://1broker.com/?c=en/content/api-documentation>
__ | US |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |1btcxe| | 1btcxe | 1BTCXE <https://1btcxe.com>
| * | API <https://1btcxe.com/api-docs.php>
__ | Panama |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |acx| | acx | ACX <https://acx.io>
__ | 2 | API <https://acx.io/documents/api_v2>
__ | Australia |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |allcoin| | allcoin | Allcoin <https://www.allcoin.com>
__ | 1 | API <https://www.allcoin.com/About/APIReference>
__ | Canada |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |anxpro| | anxpro | ANXPro <https://anxpro.com>
__ | 2 | API <http://docs.anxv2.apiary.io>
__ | Japan, Singapore, Hong Kong, New Zealand |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |anybits| | anybits | Anybits <https://anybits.com>
__ | * | API <https://anybits.com/help/api>
__ | Ireland |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |bibox| | bibox | Bibox <https://www.bibox.com>
__ | 1 | API <https://github.com/Biboxcom/api_reference/wiki/home_en>
__ | China, US, South Korea |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |binance| | binance | Binance <https://www.binance.com/?ref=10205187>
__ | * | API <https://github.com/binance-exchange/binance-official-api-docs/blob/master/rest-api.md>
__ | Japan |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |bit2c| | bit2c | Bit2C <https://www.bit2c.co.il>
__ | * | API <https://www.bit2c.co.il/home/api>
__ | Israel |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |bitbank| | bitbank | bitbank <https://bitbank.cc/>
__ | 1 | API <https://docs.bitbank.cc/>
__ | Japan |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |bitbay| | bitbay | BitBay <https://bitbay.net>
__ | * | API <https://bitbay.net/public-api>
__ | Malta, EU |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |bitfinex| | bitfinex | Bitfinex <https://www.bitfinex.com>
__ | 1 | API <https://bitfinex.readme.io/v1/docs>
__ | British Virgin Islands |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |bitfinex2| | bitfinex2 | Bitfinex v2 <https://www.bitfinex.com>
__ | 2 | API <https://bitfinex.readme.io/v2/docs>
__ | British Virgin Islands |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |bitflyer| | bitflyer | bitFlyer <https://bitflyer.jp>
__ | 1 | API <https://bitflyer.jp/API>
__ | Japan |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |bithumb| | bithumb | Bithumb <https://www.bithumb.com>
__ | * | API <https://www.bithumb.com/u1/US127>
__ | South Korea |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |bitkk| | bitkk | bitkk <https://www.bitkk.com>
__ | 1 | API <https://www.bitkk.com/i/developer>
__ | China |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |bitlish| | bitlish | Bitlish <https://bitlish.com>
__ | 1 | API <https://bitlish.com/api>
__ | UK, EU, Russia |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |bitmarket| | bitmarket | BitMarket <https://www.bitmarket.pl>
__ | * | API <https://www.bitmarket.net/docs.php?file=api_public.html>
__ | Poland, EU |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |bitmex| | bitmex | BitMEX <https://www.bitmex.com/register/rm3C16>
__ | 1 | API <https://www.bitmex.com/app/apiOverview>
__ | Seychelles |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |bitsane| | bitsane | Bitsane <https://bitsane.com>
__ | * | API <https://bitsane.com/info-api>
__ | Ireland |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |bitso| | bitso | Bitso <https://bitso.com>
__ | 3 | API <https://bitso.com/api_info>
__ | Mexico |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |bitstamp| | bitstamp | Bitstamp <https://www.bitstamp.net>
__ | 2 | API <https://www.bitstamp.net/api>
__ | UK |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |bitstamp1| | bitstamp1 | Bitstamp v1 <https://www.bitstamp.net>
__ | 1 | API <https://www.bitstamp.net/api>
__ | UK |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |bittrex| | bittrex | Bittrex <https://bittrex.com>
__ | 1.1 | API <https://bittrex.com/Home/Api>
__ | US |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |bitz| | bitz | Bit-Z <https://www.bit-z.com>
__ | 1 | API <https://www.bit-z.com/api.html>
__ | Hong Kong |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |bl3p| | bl3p | BL3P <https://bl3p.eu>
__ | 1 | API <https://github.com/BitonicNL/bl3p-api/tree/master/docs>
__ | Netherlands, EU |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |bleutrade| | bleutrade | Bleutrade <https://bleutrade.com>
__ | 2 | API <https://bleutrade.com/help/API>
__ | Brazil |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |braziliex| | braziliex | Braziliex <https://braziliex.com/>
__ | * | API <https://braziliex.com/exchange/api.php>
__ | Brazil |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |btcalpha| | btcalpha | BTC-Alpha <https://btc-alpha.com/?r=123788>
__ | 1 | API <https://btc-alpha.github.io/api-docs>
__ | US |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |btcbox| | btcbox | BtcBox <https://www.btcbox.co.jp/>
__ | 1 | API <https://www.btcbox.co.jp/help/asm>
__ | Japan |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |btcchina| | btcchina | BTCChina <https://www.btcchina.com>
__ | 1 | API <https://www.btcchina.com/apidocs>
__ | China |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |btcexchange| | btcexchange | BTCExchange <https://www.btcexchange.ph>
__ | * | API <https://github.com/BTCTrader/broker-api-docs>
__ | Philippines |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |btcmarkets| | btcmarkets | BTC Markets <https://btcmarkets.net/>
__ | * | API <https://github.com/BTCMarkets/API>
__ | Australia |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |btctradeim| | btctradeim | BtcTrade.im <https://www.btctrade.im>
__ | * | API <https://www.btctrade.im/help.api.html>
__ | Hong Kong |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |btctradeua| | btctradeua | BTC Trade UA <https://btc-trade.com.ua>
__ | * | API <https://docs.google.com/document/d/1ocYA0yMy_RXd561sfG3qEPZ80kyll36HUxvCRe5GbhE/edit>
__ | Ukraine |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |btcturk| | btcturk | BTCTurk <https://www.btcturk.com>
__ | * | API <https://github.com/BTCTrader/broker-api-docs>
__ | Turkey |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |btcx| | btcx | BTCX <https://btc-x.is>
__ | 1 | API <https://btc-x.is/custom/api-document.html>
__ | Iceland, US, EU |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |bxinth| | bxinth | BX.in.th <https://bx.in.th>
__ | * | API <https://bx.in.th/info/api>
__ | Thailand |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |ccex| | ccex | C-CEX <https://c-cex.com>
__ | * | API <https://c-cex.com/?id=api>
__ | Germany, EU |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |cex| | cex | CEX.IO <https://cex.io>
__ | * | API <https://cex.io/cex-api>
__ | UK, EU, Cyprus, Russia |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |chbtc| | chbtc | CHBTC <https://trade.chbtc.com/api>
__ | 1 | API <https://www.chbtc.com/i/developer>
__ | China |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |chilebit| | chilebit | ChileBit <https://chilebit.net>
__ | 1 | API <https://blinktrade.com/docs>
__ | Chile |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |cobinhood| | cobinhood | COBINHOOD <https://cobinhood.com>
__ | * | API <https://cobinhood.github.io/api-public>
__ | Taiwan |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |coinbase| | coinbase | coinbase <https://www.coinbase.com/join/58cbe25a355148797479dbd2>
__ | 2 | API <https://developers.coinbase.com/api/v2>
__ | US |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |coinbasepro| | coinbasepro | Coinbase Pro <https://pro.coinbase.com/>
__ | * | API <https://docs.gdax.com>
__ | US |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |coincheck| | coincheck | coincheck <https://coincheck.com>
__ | * | API <https://coincheck.com/documents/exchange/api>
__ | Japan, Indonesia |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |coinegg| | coinegg | CoinEgg <https://www.coinegg.com>
__ | * | API <https://www.coinegg.com/explain.api.html>
__ | China, UK |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |coinex| | coinex | CoinEx <https://www.coinex.com/account/signup?refer_code=yw5fz>
__ | 1 | API <https://github.com/coinexcom/coinex_exchange_api/wiki>
__ | China |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |coinexchange| | coinexchange | CoinExchange <https://www.coinexchange.io>
__ | * | API <https://coinexchangeio.github.io/slate/>
__ | India, Japan, South Korea, Vietnam, US |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |coinfalcon| | coinfalcon | CoinFalcon <https://coinfalcon.com/?ref=CFJSVGTUPASB>
__ | * | API <https://docs.coinfalcon.com>
__ | UK |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |coinfloor| | coinfloor | coinfloor <https://www.coinfloor.co.uk>
__ | * | API <https://github.com/coinfloor/api>
__ | UK |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |coingi| | coingi | Coingi <https://coingi.com>
__ | * | API <http://docs.coingi.apiary.io/>
__ | Panama, Bulgaria, China, US |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |coinmarketcap| | coinmarketcap | CoinMarketCap <https://coinmarketcap.com>
__ | 1 | API <https://coinmarketcap.com/api>
__ | US |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |coinmate| | coinmate | CoinMate <https://coinmate.io>
__ | * | API <http://docs.coinmate.apiary.io>
__ | UK, Czech Republic, EU |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |coinnest| | coinnest | coinnest <https://www.coinnest.co.kr>
__ | * | API <https://www.coinnest.co.kr/doc/intro.html>
__ | South Korea |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |coinone| | coinone | CoinOne <https://coinone.co.kr>
__ | 2 | API <https://doc.coinone.co.kr>
__ | South Korea |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |coinsecure| | coinsecure | Coinsecure <https://coinsecure.in>
__ | 1 | API <https://api.coinsecure.in>
__ | India |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |coinspot| | coinspot | CoinSpot <https://www.coinspot.com.au>
__ | * | API <https://www.coinspot.com.au/api>
__ | Australia |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |cointiger| | cointiger | CoinTiger <https://www.cointiger.pro/exchange/register.html?refCode=FfvDtt>
__ | 1 | API <https://github.com/cointiger/api-docs-en/wiki>
__ | China |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |coolcoin| | coolcoin | CoolCoin <https://www.coolcoin.com>
__ | * | API <https://www.coolcoin.com/help.api.html>
__ | Hong Kong |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |crypton| | crypton | Crypton <https://cryptonbtc.com>
__ | 1 | API <https://cryptonbtc.docs.apiary.io/>
__ | EU |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |cryptopia| | 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 | Deribit <https://www.deribit.com/reg-1189.4038>
__ | 1 | API <https://www.deribit.com/pages/docs/api>
__ | Netherlands |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |dsx| | dsx | DSX <https://dsx.uk>
__ | 3 | API <https://api.dsx.uk>
__ | UK |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |ethfinex| | ethfinex | Ethfinex <https://www.ethfinex.com>
__ | 1 | API <https://bitfinex.readme.io/v1/docs>
__ | British Virgin Islands |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |exmo| | exmo | EXMO <https://exmo.me/?ref=131685>
__ | 1 | API <https://exmo.me/en/api_doc?ref=131685>
__ | Spain, Russia |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |exx| | exx | EXX <https://www.exx.com/>
__ | * | API <https://www.exx.com/help/restApi>
__ | China |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |fcoin| | fcoin | FCoin <https://www.fcoin.com/i/Z5P7V>
__ | 2 | API <https://developer.fcoin.com>
__ | China |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |flowbtc| | flowbtc | flowBTC <https://trader.flowbtc.com>
__ | 1 | API <https://www.flowbtc.com.br/api.html>
__ | Brazil |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |foxbit| | foxbit | FoxBit <https://foxbit.exchange>
__ | 1 | API <https://blinktrade.com/docs>
__ | Brazil |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |fybse| | fybse | FYB-SE <https://www.fybse.se>
__ | * | API <http://docs.fyb.apiary.io>
__ | Sweden |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |fybsg| | fybsg | FYB-SG <https://www.fybsg.com>
__ | * | API <http://docs.fyb.apiary.io>
__ | Singapore |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |gatecoin| | gatecoin | Gatecoin <https://gatecoin.com>
__ | * | API <https://gatecoin.com/api>
__ | Hong Kong |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |gateio| | gateio | Gate.io <https://gate.io/>
__ | 2 | API <https://gate.io/api2>
__ | China |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |gdax| | gdax | GDAX <https://www.gdax.com>
__ | * | API <https://docs.gdax.com>
__ | US |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |gemini| | gemini | Gemini <https://gemini.com>
__ | 1 | API <https://docs.gemini.com/rest-api>
__ | US |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |getbtc| | getbtc | GetBTC <https://getbtc.org>
__ | * | API <https://getbtc.org/api-docs.php>
__ | St. Vincent & Grenadines, Russia |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |hadax| | 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 | HitBTC <https://hitbtc.com/?ref_id=5a5d39a65d466>
__ | 1 | API <https://github.com/hitbtc-com/hitbtc-api/blob/master/APIv1.md>
__ | Hong Kong |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |hitbtc2| | hitbtc2 | HitBTC v2 <https://hitbtc.com/?ref_id=5a5d39a65d466>
__ | 2 | API <https://api.hitbtc.com>
__ | Hong Kong |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |huobi| | huobi | Huobi <https://www.huobi.com>
__ | 3 | API <https://github.com/huobiapi/API_Docs_en/wiki>
__ | China |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |huobicny| | huobicny | Huobi CNY <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 |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |huobipro| | 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 | ICE3X <https://ice3x.com>
__ | * | API <https://ice3x.co.za/ice-cubed-bitcoin-exchange-api-documentation-1-june-2017>
__ | South Africa |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |independentreserve| | independentreserve | Independent Reserve <https://www.independentreserve.com>
__ | * | API <https://www.independentreserve.com/API>
__ | Australia, New Zealand |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |indodax| | indodax | INDODAX <https://www.indodax.com>
__ | 1.8 | API <https://indodax.com/downloads/BITCOINCOID-API-DOCUMENTATION.pdf>
__ | Indonesia |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |itbit| | itbit | itBit <https://www.itbit.com>
__ | 1 | API <https://api.itbit.com/docs>
__ | US |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |jubi| | jubi | jubi.com <https://www.jubi.com>
__ | 1 | API <https://www.jubi.com/help/api.html>
__ | China |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |kraken| | kraken | Kraken <https://www.kraken.com>
__ | 0 | API <https://www.kraken.com/en-us/help/api>
__ | US |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |kucoin| | kucoin | Kucoin <https://www.kucoin.com/?r=E5wkqe>
__ | 1 | API <https://kucoinapidocs.docs.apiary.io>
__ | Hong Kong |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |kuna| | kuna | Kuna <https://kuna.io>
__ | 2 | API <https://kuna.io/documents/api>
__ | Ukraine |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |lakebtc| | lakebtc | LakeBTC <https://www.lakebtc.com>
__ | 2 | API <https://www.lakebtc.com/s/api_v2>
__ | US |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |lbank| | lbank | LBank <https://www.lbank.info>
__ | 1 | API <https://github.com/LBank-exchange/lbank-official-api-docs>
__ | China |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |liqui| | liqui | Liqui <https://liqui.io>
__ | 3 | API <https://liqui.io/api>
__ | Ukraine |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |livecoin| | livecoin | LiveCoin <https://www.livecoin.net>
__ | * | API <https://www.livecoin.net/api?lang=en>
__ | US, UK, Russia |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |luno| | luno | luno <https://www.luno.com>
__ | 1 | API <https://www.luno.com/en/api>
__ | UK, Singapore, South Africa |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |lykke| | lykke | Lykke <https://www.lykke.com>
__ | 1 | API <https://hft-api.lykke.com/swagger/ui/>
__ | Switzerland |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |mercado| | mercado | Mercado Bitcoin <https://www.mercadobitcoin.com.br>
__ | 3 | API <https://www.mercadobitcoin.com.br/api-doc>
__ | Brazil |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |mixcoins| | mixcoins | MixCoins <https://mixcoins.com>
__ | 1 | API <https://mixcoins.com/help/api/>
__ | UK, Hong Kong |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |negociecoins| | negociecoins | NegocieCoins <https://www.negociecoins.com.br>
__ | 3 | API <https://www.negociecoins.com.br/documentacao-tradeapi>
__ | Brazil |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |nova| | nova | Novaexchange <https://novaexchange.com>
__ | 2 | API <https://novaexchange.com/remote/faq>
__ | Tanzania |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |okcoincny| | okcoincny | OKCoin CNY <https://www.okcoin.cn>
__ | 1 | API <https://www.okcoin.cn/rest_getStarted.html>
__ | China |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |okcoinusd| | okcoinusd | OKCoin USD <https://www.okcoin.com>
__ | 1 | API <https://www.okcoin.com/rest_getStarted.html>
__ | China, US |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |okex| | okex | OKEX <https://www.okex.com>
__ | 1 | API <https://github.com/okcoin-okex/API-docs-OKEx.com>
__ | China, US |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |paymium| | paymium | Paymium <https://www.paymium.com>
__ | 1 | API <https://github.com/Paymium/api-documentation>
__ | France, EU |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |poloniex| | poloniex | Poloniex <https://poloniex.com>
__ | * | API <https://poloniex.com/support/api/>
__ | US |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |qryptos| | qryptos | QRYPTOS <https://www.qryptos.com>
__ | 2 | API <https://developers.quoine.com>
__ | China, Taiwan |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |quadrigacx| | quadrigacx | QuadrigaCX <https://www.quadrigacx.com>
__ | 2 | API <https://www.quadrigacx.com/api_info>
__ | Canada |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |quoinex| | quoinex | QUOINEX <https://quoinex.com/>
__ | 2 | API <https://developers.quoine.com>
__ | Japan, Singapore, Vietnam |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |rightbtc| | rightbtc | RightBTC <https://www.rightbtc.com>
__ | * | API <https://www.rightbtc.com/api/trader>
__ | United Arab Emirates |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |southxchange| | southxchange | SouthXchange <https://www.southxchange.com>
__ | * | API <https://www.southxchange.com/Home/Api>
__ | Argentina |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |surbitcoin| | surbitcoin | SurBitcoin <https://surbitcoin.com>
__ | 1 | API <https://blinktrade.com/docs>
__ | Venezuela |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |therock| | therock | TheRockTrading <https://therocktrading.com>
__ | 1 | API <https://api.therocktrading.com/doc/v1/index.html>
__ | Malta |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |tidebit| | tidebit | TideBit <https://www.tidebit.com>
__ | 2 | API <https://www.tidebit.com/documents/api_v2>
__ | Hong Kong |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |tidex| | tidex | Tidex <https://tidex.com>
__ | 3 | API <https://tidex.com/exchange/public-api>
__ | UK |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |urdubit| | urdubit | UrduBit <https://urdubit.com>
__ | 1 | API <https://blinktrade.com/docs>
__ | Pakistan |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |vaultoro| | vaultoro | Vaultoro <https://www.vaultoro.com>
__ | 1 | API <https://api.vaultoro.com>
__ | Switzerland |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |vbtc| | vbtc | VBTC <https://vbtc.exchange>
__ | 1 | API <https://blinktrade.com/docs>
__ | Vietnam |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |virwox| | virwox | VirWoX <https://www.virwox.com>
__ | * | API <https://www.virwox.com/developers.php>
__ | Austria, EU |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |wex| | wex | WEX <https://wex.nz>
__ | 3 | API <https://wex.nz/api/3/docs>
__ | New Zealand |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |xbtce| | xbtce | xBTCe <https://www.xbtce.com>
__ | 1 | API <https://www.xbtce.com/tradeapi>
__ | Russia |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |yobit| | yobit | YoBit <https://www.yobit.net>
__ | 3 | API <https://www.yobit.net/en/api/>
__ | Russia |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |yunbi| | yunbi | YUNBI <https://yunbi.com>
__ | 2 | API <https://yunbi.com/documents/api/guide>
__ | China |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |zaif| | zaif | Zaif <https://zaif.jp>
__ | 1 | API <http://techbureau-api-document.readthedocs.io/ja/latest/index.html>
__ | Japan |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
| |zb| | zb | ZB <https://www.zb.com>
__ | 1 | API <https://www.zb.com/i/developer>
__ | China |
+----------------------+--------------------+---------------------------------------------------------------------------------+-----+-----------------------------------------------------------------------------------------------------+------------------------------------------+
The list above is updated frequently, new crypto markets, altcoin exchanges, bug fixes, API endpoints are introduced and added on a regular basis. See the Manual <https://github.com/ccxt/ccxt/wiki>
__ for details. If you don’t find a cryptocurrency exchange market in the list above and/or want another exchange to be added, post or send us a link to it by opening an issue here on GitHub or via 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 builtin package managers:
ccxt in NPM <http://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.3+)
This library is shipped as an all-in-one module implementation with minimalistic dependencies and requirements:
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
An alternative way of installing this library into your code is to copy a single file manually into your working directory with language extension appropriate for your environment.
JavaScript (NPM)
JavaScript version of CCXT works both in 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 <http://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 <https://unpkg.com/ccxt>
__ (dependencies included), served from unpkg CDN <https://unpkg.com/>
__, which is a fast, global content delivery network for everything on NPM.
.. code:: html
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.3+)
It requires common PHP modules:
- cURL
- mbstring (using UTF-8 is highly recommended)
- PCRE
- iconv
.. code:: php
include "ccxt.php";
var_dump (\ccxt\Exchange::$exchanges); // print a list of all available exchange classes
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 out-of-the-box immediately after installation. Public APIs open access to public information from all exchange markets without registering user accounts and without having API keys.
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
For trading with private APIs you need to obtain API keys from/to exchange markets. It often means registering with exchanges and creating API keys with your account. Most exchanges require personal info or identification. Some kind of verification may be necessary as well. If you want to trade you need to register yourself, this library will not create accounts or API keys for you. Some exchange APIs expose interface methods for registering an account from within the code itself, but most of exchanges don’t. You have to sign up and create API keys with 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.
::
// 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 huobi = new ccxt.huobi ()
let okcoinusd = new ccxt.okcoinusd ({
apiKey: 'YOUR_PUBLIC_API_KEY',
secret: 'YOUR_SECRET_PRIVATE_KEY',
})
console.log (kraken.id, await kraken.loadMarkets ())
console.log (bitfinex.id, await bitfinex.loadMarkets ())
console.log (huobi.id, await huobi.loadMarkets ())
console.log (kraken.id, await kraken.fetchOrderBook (kraken.symbols[0]))
console.log (bitfinex.id, await bitfinex.fetchTicker ('BTC/USD'))
console.log (huobi.id, await huobi.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()
huobi = ccxt.huobi()
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',
})
hitbtc_markets = hitbtc.load_markets()
print(hitbtc.id, hitbtc_markets)
print(bitmex.id, bitmex.load_markets())
print(huobi.id, huobi.load_markets())
print(hitbtc.fetch_order_book(hitbtc.symbols[0]))
print(bitmex.fetch_ticker('BTC/USD'))
print(huobi.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',
));
$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 like it and want to help us improve it further or if you want to speed up 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>
__]
Backers
Thank you to all our backers! [`Become a backer <https://opencollective.com/ccxt#backer>`__]
Crypto
~~~~~~
::
ETH 0xa7c2b18b7c8b86984560cad3b1bc3224b388ded0
BTC 33RmVRfhK2WZVQR1R83h2e9yXoqRNDvJva
BCH 1GN9p233TvNcNQFthCgfiHUnj5JRKEc2Ze
LTC LbT8mkAqQBphc4yxLXEDgYDfEax74et3bP
Thank you!
.. |_1broker| image:: https://user-images.githubusercontent.com/1294454/27766021-420bd9fc-5ecb-11e7-8ed6-56d0081efed2.jpg
.. |_1btcxe| image:: https://user-images.githubusercontent.com/1294454/27766049-2b294408-5ecc-11e7-85cc-adaff013dc1a.jpg
.. |acx| image:: https://user-images.githubusercontent.com/1294454/30247614-1fe61c74-9621-11e7-9e8c-f1a627afa279.jpg
.. |allcoin| image:: https://user-images.githubusercontent.com/1294454/31561809-c316b37c-b061-11e7-8d5a-b547b4d730eb.jpg
.. |anxpro| image:: https://user-images.githubusercontent.com/1294454/27765983-fd8595da-5ec9-11e7-82e3-adb3ab8c2612.jpg
.. |anybits| image:: https://user-images.githubusercontent.com/1294454/41388454-ae227544-6f94-11e8-82a4-127d51d34903.jpg
.. |bibox| image:: https://user-images.githubusercontent.com/1294454/34902611-2be8bf1a-f830-11e7-91a2-11b2f292e750.jpg
.. |binance| image:: https://user-images.githubusercontent.com/1294454/29604020-d5483cdc-87ee-11e7-94c7-d1a8d9169293.jpg
.. |bit2c| image:: https://user-images.githubusercontent.com/1294454/27766119-3593220e-5ece-11e7-8b3a-5a041f6bcc3f.jpg
.. |bitbank| image:: https://user-images.githubusercontent.com/1294454/37808081-b87f2d9c-2e59-11e8-894d-c1900b7584fe.jpg
.. |bitbay| image:: https://user-images.githubusercontent.com/1294454/27766132-978a7bd8-5ece-11e7-9540-bc96d1e9bbb8.jpg
.. |bitfinex| image:: https://user-images.githubusercontent.com/1294454/27766244-e328a50c-5ed2-11e7-947b-041416579bb3.jpg
.. |bitfinex2| image:: https://user-images.githubusercontent.com/1294454/27766244-e328a50c-5ed2-11e7-947b-041416579bb3.jpg
.. |bitflyer| image:: https://user-images.githubusercontent.com/1294454/28051642-56154182-660e-11e7-9b0d-6042d1e6edd8.jpg
.. |bithumb| image:: https://user-images.githubusercontent.com/1294454/30597177-ea800172-9d5e-11e7-804c-b9d4fa9b56b0.jpg
.. |bitkk| image:: https://user-images.githubusercontent.com/1294454/32859187-cd5214f0-ca5e-11e7-967d-96568e2e2bd1.jpg
.. |bitlish| image:: https://user-images.githubusercontent.com/1294454/27766275-dcfc6c30-5ed3-11e7-839d-00a846385d0b.jpg
.. |bitmarket| image:: https://user-images.githubusercontent.com/1294454/27767256-a8555200-5ef9-11e7-96fd-469a65e2b0bd.jpg
.. |bitmex| image:: https://user-images.githubusercontent.com/1294454/27766319-f653c6e6-5ed4-11e7-933d-f0bc3699ae8f.jpg
.. |bitsane| image:: https://user-images.githubusercontent.com/1294454/41387105-d86bf4c6-6f8d-11e8-95ea-2fa943872955.jpg
.. |bitso| image:: https://user-images.githubusercontent.com/1294454/27766335-715ce7aa-5ed5-11e7-88a8-173a27bb30fe.jpg
.. |bitstamp| image:: https://user-images.githubusercontent.com/1294454/27786377-8c8ab57e-5fe9-11e7-8ea4-2b05b6bcceec.jpg
.. |bitstamp1| image:: https://user-images.githubusercontent.com/1294454/27786377-8c8ab57e-5fe9-11e7-8ea4-2b05b6bcceec.jpg
.. |bittrex| image:: https://user-images.githubusercontent.com/1294454/27766352-cf0b3c26-5ed5-11e7-82b7-f3826b7a97d8.jpg
.. |bitz| image:: https://user-images.githubusercontent.com/1294454/35862606-4f554f14-0b5d-11e8-957d-35058c504b6f.jpg
.. |bl3p| image:: https://user-images.githubusercontent.com/1294454/28501752-60c21b82-6feb-11e7-818b-055ee6d0e754.jpg
.. |bleutrade| image:: https://user-images.githubusercontent.com/1294454/30303000-b602dbe6-976d-11e7-956d-36c5049c01e7.jpg
.. |braziliex| image:: https://user-images.githubusercontent.com/1294454/34703593-c4498674-f504-11e7-8d14-ff8e44fb78c1.jpg
.. |btcalpha| image:: https://user-images.githubusercontent.com/1294454/42625213-dabaa5da-85cf-11e8-8f99-aa8f8f7699f0.jpg
.. |btcbox| image:: https://user-images.githubusercontent.com/1294454/31275803-4df755a8-aaa1-11e7-9abb-11ec2fad9f2d.jpg
.. |btcchina| image:: https://user-images.githubusercontent.com/1294454/27766368-465b3286-5ed6-11e7-9a11-0f6467e1d82b.jpg
.. |btcexchange| image:: https://user-images.githubusercontent.com/1294454/27993052-4c92911a-64aa-11e7-96d8-ec6ac3435757.jpg
.. |btcmarkets| image:: https://user-images.githubusercontent.com/1294454/29142911-0e1acfc2-7d5c-11e7-98c4-07d9532b29d7.jpg
.. |btctradeim| image:: https://user-images.githubusercontent.com/1294454/36770531-c2142444-1c5b-11e8-91e2-a4d90dc85fe8.jpg
.. |btctradeua| image:: https://user-images.githubusercontent.com/1294454/27941483-79fc7350-62d9-11e7-9f61-ac47f28fcd96.jpg
.. |btcturk| image:: https://user-images.githubusercontent.com/1294454/27992709-18e15646-64a3-11e7-9fa2-b0950ec7712f.jpg
.. |btcx| image:: https://user-images.githubusercontent.com/1294454/27766385-9fdcc98c-5ed6-11e7-8f14-66d5e5cd47e6.jpg
.. |bxinth| image:: https://user-images.githubusercontent.com/1294454/27766412-567b1eb4-5ed7-11e7-94a8-ff6a3884f6c5.jpg
.. |ccex| image:: https://user-images.githubusercontent.com/1294454/27766433-16881f90-5ed8-11e7-92f8-3d92cc747a6c.jpg
.. |cex| image:: https://user-images.githubusercontent.com/1294454/27766442-8ddc33b0-5ed8-11e7-8b98-f786aef0f3c9.jpg
.. |chbtc| image:: https://user-images.githubusercontent.com/1294454/28555659-f0040dc2-7109-11e7-9d99-688a438bf9f4.jpg
.. |chilebit| image:: https://user-images.githubusercontent.com/1294454/27991414-1298f0d8-647f-11e7-9c40-d56409266336.jpg
.. |cobinhood| image:: https://user-images.githubusercontent.com/1294454/35755576-dee02e5c-0878-11e8-989f-1595d80ba47f.jpg
.. |coinbase| image:: https://user-images.githubusercontent.com/1294454/40811661-b6eceae2-653a-11e8-829e-10bfadb078cf.jpg
.. |coinbasepro| image:: https://user-images.githubusercontent.com/1294454/41764625-63b7ffde-760a-11e8-996d-a6328fa9347a.jpg
.. |coincheck| image:: https://user-images.githubusercontent.com/1294454/27766464-3b5c3c74-5ed9-11e7-840e-31b32968e1da.jpg
.. |coinegg| image:: https://user-images.githubusercontent.com/1294454/36770310-adfa764e-1c5a-11e8-8e09-449daac3d2fb.jpg
.. |coinex| image:: https://user-images.githubusercontent.com/1294454/38046312-0b450aac-32c8-11e8-99ab-bc6b136b6cc7.jpg
.. |coinexchange| image:: https://user-images.githubusercontent.com/1294454/34842303-29c99fca-f71c-11e7-83c1-09d900cb2334.jpg
.. |coinfalcon| image:: https://user-images.githubusercontent.com/1294454/41822275-ed982188-77f5-11e8-92bb-496bcd14ca52.jpg
.. |coinfloor| image:: https://user-images.githubusercontent.com/1294454/28246081-623fc164-6a1c-11e7-913f-bac0d5576c90.jpg
.. |coingi| image:: https://user-images.githubusercontent.com/1294454/28619707-5c9232a8-7212-11e7-86d6-98fe5d15cc6e.jpg
.. |coinmarketcap| image:: https://user-images.githubusercontent.com/1294454/28244244-9be6312a-69ed-11e7-99c1-7c1797275265.jpg
.. |coinmate| image:: https://user-images.githubusercontent.com/1294454/27811229-c1efb510-606c-11e7-9a36-84ba2ce412d8.jpg
.. |coinnest| image:: https://user-images.githubusercontent.com/1294454/38065728-7289ff5c-330d-11e8-9cc1-cf0cbcb606bc.jpg
.. |coinone| image:: https://user-images.githubusercontent.com/1294454/38003300-adc12fba-323f-11e8-8525-725f53c4a659.jpg
.. |coinsecure| image:: https://user-images.githubusercontent.com/1294454/27766472-9cbd200a-5ed9-11e7-9551-2267ad7bac08.jpg
.. |coinspot| image:: https://user-images.githubusercontent.com/1294454/28208429-3cacdf9a-6896-11e7-854e-4c79a772a30f.jpg
.. |cointiger| image:: https://user-images.githubusercontent.com/1294454/39797261-d58df196-5363-11e8-9880-2ec78ec5bd25.jpg
.. |coolcoin| image:: https://user-images.githubusercontent.com/1294454/36770529-be7b1a04-1c5b-11e8-9600-d11f1996b539.jpg
.. |crypton| image:: https://user-images.githubusercontent.com/1294454/41334251-905b5a78-6eed-11e8-91b9-f3aa435078a1.jpg
.. |cryptopia| image:: https://user-images.githubusercontent.com/1294454/29484394-7b4ea6e2-84c6-11e7-83e5-1fccf4b2dc81.jpg
.. |deribit| image:: https://user-images.githubusercontent.com/1294454/41933112-9e2dd65a-798b-11e8-8440-5bab2959fcb8.jpg
.. |dsx| image:: https://user-images.githubusercontent.com/1294454/27990275-1413158a-645a-11e7-931c-94717f7510e3.jpg
.. |ethfinex| image:: https://user-images.githubusercontent.com/1294454/37555526-7018a77c-29f9-11e8-8835-8e415c038a18.jpg
.. |exmo| image:: https://user-images.githubusercontent.com/1294454/27766491-1b0ea956-5eda-11e7-9225-40d67b481b8d.jpg
.. |exx| image:: https://user-images.githubusercontent.com/1294454/37770292-fbf613d0-2de4-11e8-9f79-f2dc451b8ccb.jpg
.. |fcoin| image:: https://user-images.githubusercontent.com/1294454/42244210-c8c42e1e-7f1c-11e8-8710-a5fb63b165c4.jpg
.. |flowbtc| image:: https://user-images.githubusercontent.com/1294454/28162465-cd815d4c-67cf-11e7-8e57-438bea0523a2.jpg
.. |foxbit| image:: https://user-images.githubusercontent.com/1294454/27991413-11b40d42-647f-11e7-91ee-78ced874dd09.jpg
.. |fybse| image:: https://user-images.githubusercontent.com/1294454/27766512-31019772-5edb-11e7-8241-2e675e6797f1.jpg
.. |fybsg| image:: https://user-images.githubusercontent.com/1294454/27766513-3364d56a-5edb-11e7-9e6b-d5898bb89c81.jpg
.. |gatecoin| image:: https://user-images.githubusercontent.com/1294454/28646817-508457f2-726c-11e7-9eeb-3528d2413a58.jpg
.. |gateio| image:: https://user-images.githubusercontent.com/1294454/31784029-0313c702-b509-11e7-9ccc-bc0da6a0e435.jpg
.. |gdax| image:: https://user-images.githubusercontent.com/1294454/27766527-b1be41c6-5edb-11e7-95f6-5b496c469e2c.jpg
.. |gemini| image:: https://user-images.githubusercontent.com/1294454/27816857-ce7be644-6096-11e7-82d6-3c257263229c.jpg
.. |getbtc| image:: https://user-images.githubusercontent.com/1294454/33801902-03c43462-dd7b-11e7-992e-077e4cd015b9.jpg
.. |hadax| image:: https://user-images.githubusercontent.com/1294454/38059952-4756c49e-32f1-11e8-90b9-45c1eccba9cd.jpg
.. |hitbtc| image:: https://user-images.githubusercontent.com/1294454/27766555-8eaec20e-5edc-11e7-9c5b-6dc69fc42f5e.jpg
.. |hitbtc2| image:: https://user-images.githubusercontent.com/1294454/27766555-8eaec20e-5edc-11e7-9c5b-6dc69fc42f5e.jpg
.. |huobi| image:: https://user-images.githubusercontent.com/1294454/27766569-15aa7b9a-5edd-11e7-9e7f-44791f4ee49c.jpg
.. |huobicny| image:: https://user-images.githubusercontent.com/1294454/27766569-15aa7b9a-5edd-11e7-9e7f-44791f4ee49c.jpg
.. |huobipro| image:: https://user-images.githubusercontent.com/1294454/27766569-15aa7b9a-5edd-11e7-9e7f-44791f4ee49c.jpg
.. |ice3x| image:: https://user-images.githubusercontent.com/1294454/38012176-11616c32-3269-11e8-9f05-e65cf885bb15.jpg
.. |independentreserve| image:: https://user-images.githubusercontent.com/1294454/30521662-cf3f477c-9bcb-11e7-89bc-d1ac85012eda.jpg
.. |indodax| image:: https://user-images.githubusercontent.com/1294454/37443283-2fddd0e4-281c-11e8-9741-b4f1419001b5.jpg
.. |itbit| image:: https://user-images.githubusercontent.com/1294454/27822159-66153620-60ad-11e7-89e7-005f6d7f3de0.jpg
.. |jubi| image:: https://user-images.githubusercontent.com/1294454/27766581-9d397d9a-5edd-11e7-8fb9-5d8236c0e692.jpg
.. |kraken| image:: https://user-images.githubusercontent.com/1294454/27766599-22709304-5ede-11e7-9de1-9f33732e1509.jpg
.. |kucoin| image:: https://user-images.githubusercontent.com/1294454/33795655-b3c46e48-dcf6-11e7-8abe-dc4588ba7901.jpg
.. |kuna| image:: https://user-images.githubusercontent.com/1294454/31697638-912824fa-b3c1-11e7-8c36-cf9606eb94ac.jpg
.. |lakebtc| image:: https://user-images.githubusercontent.com/1294454/28074120-72b7c38a-6660-11e7-92d9-d9027502281d.jpg
.. |lbank| image:: https://user-images.githubusercontent.com/1294454/38063602-9605e28a-3302-11e8-81be-64b1e53c4cfb.jpg
.. |liqui| image:: https://user-images.githubusercontent.com/1294454/27982022-75aea828-63a0-11e7-9511-ca584a8edd74.jpg
.. |livecoin| image:: https://user-images.githubusercontent.com/1294454/27980768-f22fc424-638a-11e7-89c9-6010a54ff9be.jpg
.. |luno| image:: https://user-images.githubusercontent.com/1294454/27766607-8c1a69d8-5ede-11e7-930c-540b5eb9be24.jpg
.. |lykke| image:: https://user-images.githubusercontent.com/1294454/34487620-3139a7b0-efe6-11e7-90f5-e520cef74451.jpg
.. |mercado| image:: https://user-images.githubusercontent.com/1294454/27837060-e7c58714-60ea-11e7-9192-f05e86adb83f.jpg
.. |mixcoins| image:: https://user-images.githubusercontent.com/1294454/30237212-ed29303c-9535-11e7-8af8-fcd381cfa20c.jpg
.. |negociecoins| image:: https://user-images.githubusercontent.com/1294454/38008571-25a6246e-3258-11e8-969b-aeb691049245.jpg
.. |nova| image:: https://user-images.githubusercontent.com/1294454/30518571-78ca0bca-9b8a-11e7-8840-64b83a4a94b2.jpg
.. |okcoincny| image:: https://user-images.githubusercontent.com/1294454/27766792-8be9157a-5ee5-11e7-926c-6d69b8d3378d.jpg
.. |okcoinusd| image:: https://user-images.githubusercontent.com/1294454/27766791-89ffb502-5ee5-11e7-8a5b-c5950b68ac65.jpg
.. |okex| image:: https://user-images.githubusercontent.com/1294454/32552768-0d6dd3c6-c4a6-11e7-90f8-c043b64756a7.jpg
.. |paymium| image:: https://user-images.githubusercontent.com/1294454/27790564-a945a9d4-5ff9-11e7-9d2d-b635763f2f24.jpg
.. |poloniex| image:: https://user-images.githubusercontent.com/1294454/27766817-e9456312-5ee6-11e7-9b3c-b628ca5626a5.jpg
.. |qryptos| image:: https://user-images.githubusercontent.com/1294454/30953915-b1611dc0-a436-11e7-8947-c95bd5a42086.jpg
.. |quadrigacx| image:: https://user-images.githubusercontent.com/1294454/27766825-98a6d0de-5ee7-11e7-9fa4-38e11a2c6f52.jpg
.. |quoinex| image:: https://user-images.githubusercontent.com/1294454/35047114-0e24ad4a-fbaa-11e7-96a9-69c1a756083b.jpg
.. |rightbtc| image:: https://user-images.githubusercontent.com/1294454/42633917-7d20757e-85ea-11e8-9f53-fffe9fbb7695.jpg
.. |southxchange| image:: https://user-images.githubusercontent.com/1294454/27838912-4f94ec8a-60f6-11e7-9e5d-bbf9bd50a559.jpg
.. |surbitcoin| image:: https://user-images.githubusercontent.com/1294454/27991511-f0a50194-6481-11e7-99b5-8f02932424cc.jpg
.. |therock| image:: https://user-images.githubusercontent.com/1294454/27766869-75057fa2-5ee9-11e7-9a6f-13e641fa4707.jpg
.. |tidebit| image:: https://user-images.githubusercontent.com/1294454/39034921-e3acf016-4480-11e8-9945-a6086a1082fe.jpg
.. |tidex| image:: https://user-images.githubusercontent.com/1294454/30781780-03149dc4-a12e-11e7-82bb-313b269d24d4.jpg
.. |urdubit| image:: https://user-images.githubusercontent.com/1294454/27991453-156bf3ae-6480-11e7-82eb-7295fe1b5bb4.jpg
.. |vaultoro| image:: https://user-images.githubusercontent.com/1294454/27766880-f205e870-5ee9-11e7-8fe2-0d5b15880752.jpg
.. |vbtc| image:: https://user-images.githubusercontent.com/1294454/27991481-1f53d1d8-6481-11e7-884e-21d17e7939db.jpg
.. |virwox| image:: https://user-images.githubusercontent.com/1294454/27766894-6da9d360-5eea-11e7-90aa-41f2711b7405.jpg
.. |wex| image:: https://user-images.githubusercontent.com/1294454/30652751-d74ec8f8-9e31-11e7-98c5-71469fcef03e.jpg
.. |xbtce| image:: https://user-images.githubusercontent.com/1294454/28059414-e235970c-662c-11e7-8c3a-08e31f78684b.jpg
.. |yobit| image:: https://user-images.githubusercontent.com/1294454/27766910-cdcbfdae-5eea-11e7-9859-03fea873272d.jpg
.. |yunbi| image:: https://user-images.githubusercontent.com/1294454/28570548-4d646c40-7147-11e7-9cf6-839b93e6d622.jpg
.. |zaif| image:: https://user-images.githubusercontent.com/1294454/27766927-39ca2ada-5eeb-11e7-972f-1b4199518ca6.jpg
.. |zb| image:: https://user-images.githubusercontent.com/1294454/32859187-cd5214f0-ca5e-11e7-967d-96568e2e2bd1.jpg