Package: ccxt
CCXT – CryptoCurrency eXchange Trading LibraryA JavaScript / Python / PHP / C# library for cryptocurrency trading and e-commerce with support for many bitcoin/ether/altcoin exchange markets and merchant APIs.Install·Usage·Manual·FAQ·Examples·Contributing·SocialTheCCXTlibrary 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 bycoders, developers, technically-skilled traders, data-scientists and financial analystsfor building trading algorithms.Current feature list:support for many cryptocurrency exchanges — more coming soonfully implemented public and private APIsoptional normalized data for cross-exchange analytics and arbitragean out of the box unified API that is extremely easy to integrateworks in Node 10.4+, Python 3, PHP 8.1+, netstandard2.0/2.1 and web browsersSponsored PromotionSee AlsoTabTrader– trading on all exchanges in one app. Available onAndroidandiOS!Freqtrade– leading opensource cryptocurrency algorithmic trading software!OctoBot– cryptocurrency trading bot with an advanced web interface.TokenBot– discover and copy the best algorithmic traders in the world.Certified Cryptocurrency ExchangeslogoidnamevercertifiedprodiscountbinanceBinancebinancecoinmBinance COIN-MbinanceusdmBinance USDⓈ-MbingxBingXbitgetBitgetbitmartBitMartbitmexBitMEXbybitBybitcoinexCoinExcryptocomCrypto.comgateGate.iohtxHTXkucoinKuCoinkucoinfuturesKuCoin FuturesmexcMEXC GlobalokxOKXwooWOO XSupported Cryptocurrency Exchange MarketsThe CCXT library currently supports the following 94 cryptocurrency exchange markets and trading APIs:logoidnamevercertifiedproaceACEalpacaAlpacaascendexAscendEXbequantBequantbigoneBigONEbinanceBinancebinancecoinmBinance COIN-MbinanceusBinance USbinanceusdmBinance USDⓈ-MbingxBingXbit2cBit2CbitbankbitbankbitbnsBitbnsbitfinexBitfinexbitfinex2BitfinexbitflyerbitFlyerbitgetBitgetbithumbBithumbbitmartBitMartbitmexBitMEXbitoproBitoProbitrueBitruebitsoBitsobitstampBitstampbitteamBIT.TEAMbitvavoBitvavobl3pBL3PblockchaincomBlockchain.comblofinBloFinbtcalphaBTC-AlphabtcboxBtcBoxbtcmarketsBTC MarketsbtcturkBTCTurkbybitBybitcexCEX.IOcoinbaseCoinbasecoinbaseproCoinbase ProcoincheckcoincheckcoinexCoinExcoinlistCoinlistcoinmateCoinMatecoinmetroCoinmetrocoinoneCoinOnecoinsphCoins.phcoinspotCoinSpotcryptocomCrypto.comcurrencycomCurrency.comdeltaDelta ExchangederibitDeribitdigifinexDigiFinexexmoEXMOfmfwioFMFW.iogateGate.iogeminiGeminihitbtcHitBTChollaexHollaExhtxHTXhuobijpHuobi JapanidexIDEXindependentreserveIndependent ReserveindodaxINDODAXkrakenKrakenkrakenfuturesKraken FutureskucoinKuCoinkucoinfuturesKuCoin FutureskunaKunalatokenLatokenlbankLBanklunolunolykkeLykkemercadoMercado BitcoinmexcMEXC GlobalndaxNDAXnovadaxNovaDAXoceanexOceanExokcoinOKCoinokxOKXonetradingOne Tradingp2bp2bpaymiumPaymiumphemexPhemexpoloniexPoloniexpoloniexfuturesPoloniex FuturesprobitProBittimexTimeXtokocryptoTokocryptoupbitUpbitwavesexchangeWaves.ExchangewazirxWazirXwhitebitWhiteBitwooWOO XyobitYoBitzaifZaifzondaZondaThe list above is updated frequently, new crypto markets, exchanges, bug fixes, and API endpoints are introduced on a regular basis. See theManualfor 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 underMIT license, 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.InstallThe easiest way to install the CCXT library is to use a package manager:ccxt inNPM(JavaScript / Node v7.6+)ccxt inPyPI(Python 3.7.0+)ccxt inPackagist/Composer(PHP 7.0+)ccxt inNuget(netstandard 2.0)This library is shipped as an all-in-one module implementation with minimalistic dependencies and requirements:js/in JavaScriptpython/in Python (generated from JS)php/in PHP (generated from JS)You can also clone it into your project directory fromccxt GitHub repository:gitclonehttps://github.com/ccxt/ccxt.git# including 1GB of commit history# orgitclonehttps://github.com/ccxt/ccxt.git--depth1# avoid downloading 1GB of commit historyJavaScript (NPM)JavaScript version of CCXT works in both Node and web browsers. Requires ES6 andasync/awaitsyntax support (Node 7.6.0+). When compiling with Webpack and Babel, make sure it isnot excludedin yourbabel-loaderconfig.ccxt inNPMnpminstallccxt//cjsvarccxt=require('ccxt')console.log(ccxt.exchanges)// print all available exchanges//esmimport{version,exchanges}from'ccxt';console.log(version,Object.keys(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@4.2.54/dist/ccxt.browser.jsunpkg:https://unpkg.com/ccxt@4.2.54/dist/ccxt.browser.jsCDNs 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.<scripttype="text/javascript"src="https://cdn.jsdelivr.net/npm/ccxt@4.2.54/dist/ccxt.browser.js"></script>Creates a globalccxtobject:console.log(ccxt.exchanges)// print all available exchangesPythonccxt inPyPIpipinstallccxtimportccxtprint(ccxt.exchanges)# print a list of all available exchange classesThe library supports concurrent asynchronous mode with asyncio and async/await in Python 3.7.0+importccxt.async_supportasccxt# link against the asynchronous version of ccxtPHPccxt in PHP withPackagist/Composer(PHP 7.0+)It requires common PHP modules:cURLmbstring (using UTF-8 is highly recommended)PCREiconvgmp (this is a built-in extension as of PHP 7.2+)include "ccxt.php";var_dump (\ccxt\Exchange::$exchanges); // print a list of all available exchange classesThe library supports concurrent asynchronous mode using tools fromRecoilPHPandReactPHPin PHP 7.1+. Read theManualfor more details..net/C#ccxt in C# withNuget(netstandard 2.0 and netstandard 2.1)usingccxt;Console.WriteLine(ccxt.Exchanges)// check this laterDockerYou 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 theContributingdocument for the details on that).Usingdocker-compose(in the cloned CCXT repository):docker-composerun--rmccxtYou don't need the Docker image if you're not going to develop CCXT. If you just want to use CCXT – just install it as a regular package into your project.DocumentationRead theManualfor more details.UsageIntroThe 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 datainstruments/trading pairsprice feeds (exchange rates)order bookstrade historytickersOHLC(V) for chartingother public endpointsIn 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 infoquery account balancestrade by making market and limit ordersdeposit and withdraw fiat and crypto fundsquery personal ordersget ledger historytransfer funds between accountsuse merchant servicesThis library implements full public and private REST and WebSocket APIs for all exchanges in TypeScript, JavaScript, PHP and Python.The CCXT library supports both camelcase notation (preferred in TypeScript and 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/PHPexchange.methodName()// camelcase pseudocodeexchange.method_name()// underscore pseudocodeRead theManualfor more details.JavaScriptCCXT now supports ESM and CJS modulesCJS// cjs example'use strict';constccxt=require('ccxt');(asyncfunction(){letkraken=newccxt.kraken()letbitfinex=newccxt.bitfinex({verbose:true})lethuobipro=newccxt.huobipro()letokcoinusd=newccxt.okcoin({apiKey:'YOUR_PUBLIC_API_KEY',secret:'YOUR_SECRET_PRIVATE_KEY',})constexchangeId='binance',exchangeClass=ccxt[exchangeId],exchange=newexchangeClass({'apiKey':'YOUR_API_KEY','secret':'YOUR_SECRET',})console.log(kraken.id,awaitkraken.loadMarkets())console.log(bitfinex.id,awaitbitfinex.loadMarkets())console.log(huobipro.id,awaithuobipro.loadMarkets())console.log(kraken.id,awaitkraken.fetchOrderBook(kraken.symbols[0]))console.log(bitfinex.id,awaitbitfinex.fetchTicker('BTC/USD'))console.log(huobipro.id,awaithuobipro.fetchTrades('ETH/USDT'))console.log(okcoinusd.id,awaitokcoinusd.fetchBalance())// sell 1 BTC/USD for market price, sell a bitcoin for dollars immediatelyconsole.log(okcoinusd.id,awaitokcoinusd.createMarketSellOrder('BTC/USD',1))// buy 1 BTC/USD for $2500, you pay $2500 and receive ฿1 when the order is closedconsole.log(okcoinusd.id,awaitokcoinusd.createLimitBuyOrder('BTC/USD',1,2500.00))// pass/redefine custom exchange-specific order params: type, amount, price or whatever// use a custom order typebitfinex.createLimitSellOrder('BTC/USD',1,10,{'type':'trailing-stop'})})();ESM//esm exampleimport{version,binance}from'ccxt';console.log(version);constexchange=newbinance();constticker=awaitexchange.fetchTicker('BTC/USDT');console.log(ticker);Python# coding=utf-8importccxthitbtc=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',})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/USDT'))print(exmo.fetch_balance())# sell one ฿ for market price and receive $ right nowprint(exmo.id,exmo.create_market_sell_order('BTC/USD',1))# limit buy BTC/EUR, you pay €2500 and receive ฿1  when the order is closedprint(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'})PHPinclude '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',));$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 ฿ immediatelyvar_dump ($zaif->id, $zaif->create_market_sell_order ('BTC/JPY', 1));// buy BTC/JPY, you receive ฿1 for ¥285000 when the order closesvar_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'));.net/C#usingccxt;// importing ccxtnamespaceProject;classProject{publicasyncstaticTaskCreateOrder(){varexchange=newBinance();exchange.apiKey="my api key";exchange.secret="my secret";// always use the capitalized method (CreateOrder instead of createOrder)varorder=awaitexchange.CreateOrder("BTC/USDT","limit","buy",1,50);Console.WriteLine("Placed Order, order id: "+order.id);}}ContributingPlease read theCONTRIBUTINGdocument before making changes that you would like adopted in the code. Also, read theManualfor more details.Support Developer TeamWe 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!SponsorsSupport this project by becoming a sponsor. Your logo will show up here with a link to your website.[Become a sponsor]SupportersSupport this project by becoming a supporter. Your avatar will show up here with a link to your website.[Become a supporter]BackersThank you to all our backers! [Become a backer]Thank you!SocialFollow us on TwitterRead our blog on MediumJoin our DiscordCCXT Channel on Telegram (important announcements)CCXT Chat on Telegram (technical support)Star HistoryContact UsFor business inquiries:info@ccxt.trade