Ccxt Documentation - Read The Docs

ccxt DocumentationRelease 1.50.76Igor KroitorJun 02, 2021

General Information1Supported Exchanges32Exchanges By Country73Install3.1 JavaScript (NPM) . . . . . . . . . . . . . .3.2 JavaScript (for use with the script tag):3.3 Python . . . . . . . . . . . . . . . . . . . .3.4 PHP . . . . . . . . . . . . . . . . . . . . . .3.5 Docker . . . . . . . . . . . . . . . . . . . .1111121212134Proxy4.1 JavaScript Proxies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4.2 Python Proxies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1515155CORS (Access-Control-Allow-Origin)5.1 Node.js CORS Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5.2 Python CORS Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5.3 Testing CORS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .191920206Overview217Exchanges7.1 Instantiation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7.2 Exchange Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7.3 Rate Limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .232628328Markets8.1 Market Structure . . . . . .8.2 Currency Structure . . . . .8.3 Loading Markets . . . . . .8.4 Symbols And Market Ids . .8.5 Market Cache Force Reload.353537404145API Methods / Endpoints9.1 Implicit API Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9.2 Public/Private API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9.3 Synchronous vs Asynchronous Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .474748499.i

9.49.59.6Returned JSON Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Passing Parameters To API Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Unified API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50505010 Market Data10.1 Order Book . . . . . . . . . . . .10.2 Price Tickers . . . . . . . . . . .10.3 OHLCV Candlestick Charts . . .10.4 Trades, Executions, Transactions.575760646611 Trading11.1 Authentication . . . . . . .11.2 API Keys Setup . . . . . .11.3 Querying Account Balance .11.4 Orders . . . . . . . . . . .11.5 Personal Trades . . . . . . .11.6 Funding Your Account . . .11.7 Fees . . . . . . . . . . . . .11.8 Ledger . . . . . . . . . . .11.9 Overriding The Nonce . . .69697072738588939597.12 Error Handling9912.1 Exception Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10012.2 ExchangeError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10212.3 NetworkError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10313 Troubleshooting10513.1 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10614 CCXT Pro10715 How To Install15.1 JavaScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15.2 Python . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15.3 PHP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10910911011016 Manual11317 Exchanges11518 Usage18.1 Prerequisites . . . .18.2 Streaming Specifics18.3 Linking . . . . . . .18.4 Instantiation . . . .18.5 Exchange Properties18.6 Unified API . . . . .18.7 Error Handling . . .11711711912112112212313019 Frequently Asked Questions19.1 I’m trying to run the code, but it’s not working, how do I fix it? .19.2 What is required to get help? . . . . . . . . . . . . . . . . . . . .19.3 I am calling a method and I get an error, what am I doing wrong?19.4 I got an incorrect result from a method call, can you help? . . . .19.5 Can you implement feature foo in exchange bar? . . . . . . . .131131131132132132ii.

19.6 When will you add feature foo for exchange bar ? What’s the estimated time? When should weexpect this? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19.7 When will you add the support for an exchange requested in the Issues? . . . . . . . . . . . . . . . .19.8 What’s your progress on adding the feature foo that was requested earlier? How do you do implementing exchange bar? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19.9 What is the status of this PR? Any update? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19.10 Can you point out the errors or what should I edit in my PR to get it merged into master branch? . . .19.11 Hey! The fix you’ve uploaded is in JS, would you fix Python / PHP as well, please? . . . . . . . . .20 CCXT – CryptoCurrency eXchange Trading Library20.1 Install · Usage · Manual · FAQ · Examples · Contributing · Social20.2 JavaScript (NPM) . . . . . . . . . . . . . . . . . . . . . . . . .20.3 JavaScript (for use with the script tag): . . . . . . . . . . .20.4 Python . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20.5 PHP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20.6 Docker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20.7 Intro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20.8 JavaScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20.9 Python . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20.10 PHP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20.11 Sponsors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20.12 Supporters . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20.13 Backers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20.14 Crypto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21 Supported Cryptocurrency Exchange Markets.23 Documentation25 214314414514514514514722 Install22.1 JavaScript (NPM) . . . . . . . . . . . . . .22.2 JavaScript (for use with the script tag):22.3 Python . . . . . . . . . . . . . . . . . . . .22.4 PHP . . . . . . . . . . . . . . . . . . . . . .24 Usage24.1 Intro . . .24.2 JavaScript .24.3 Python . .24.4 PHP . . . .132133153153154154154155.157157158159159161iii

iv

ccxt Documentation, Release 1.50.76A JavaScript / Python / PHP library for cryptocurrency trading and e-commerce with support for many bitcoin/ether/altcoin exchange markets and merchant APIs.General Information1

ccxt Documentation, Release 1.50.762General Information

CHAPTER1Supported ExchangesThe CCXT library currently supports the following 124 cryptocurrency exchange markets and trading ntBiboxBigONEBinanceBinance JerseyBinance APIAPIAPIAPIAPIAPIAPIAPIAPIcertifiedproCCXT ProCCXT CertifiedCCXT ProCCXT ProCCXT ProCCXT CertifiedCCXT ProCCXT ProCCXT ProCCXT Certified CCXT ProContinued on next page3

ccxt Documentation, Release btcTable 1 – continued from previous pageidnamever C-Alpha1APIbtcboxBtcBox1APIbtcmarketsBTC Markets*APIbtctradeimBtcTrade.im*APIbtctradeuaBTC Trade base Prime*APIcoinbaseproCoinbase base1APIexmoEXMO1.1 ertifiedCCXT CertifiedproCCXT ProCCXT CertifiedCCXT ProCCXT ProCCXT CertifiedCCXT CertifiedCCXT ProCCXT ProContinued on next page4Chapter 1. Supported Exchanges

ccxt Documentation, Release ebitxbtceyobitzaifzbTable 1 – continued from previous pageidnamever dochitbtcHitBTC2APIhollaexHollaEx1APIhuobiproHuobi Pro1APIhuobiruHuobi erve Independent Reserve *APIindodaxINDODAX2.0 eCoin*APIlunoluno1APIlykkeLykke1APImercadoMercado n1APItheoceanThe bZB1APIcertifiedproCCXT ProCCXT ProCCXT ProCCXT CertifiedCCXT CertifiedCCXT ProCCXT ProCCXT ProCCXT ProCCXT CertifiedCCXT ProCCXT CertifiedCCXT Pro5

ccxt Documentation, Release 1.50.766Chapter 1. Supported Exchanges

CHAPTER2Exchanges By CountryThe ccxt library currently supports the following cryptocurrency exchange markets and trading APIs:country / BrazilBritish Virgin IslandsBritish Virgin IslandsBritish Virgin IslandsBulgariaCanadaCayman udazbbitmartbwcoineggcoinexcoinginamever docBuda2APISouthXchange*APIBTC Markets*APIIndependent Reserve aziliex*APIflowBTC1APIFoxBit1APIMercado Coingi*APIContinued on next page7

ccxt Documentation, Release 1.50.76country / Czech RepublicEstoniaEstoniaEstoniaEUEUEUEUEUFranceHong KongHong KongHong KongHong KongHong KongHong KongHong KongHong KongHong KongHong panJapanJapanJapan8Table 1 – continued from previous pagelogoidnamever e.io2APIhbtchbtcHBTC1APIhuobiprohuobiproHuobi coincheck*APIindodaxindodaxINDODAX2.0 IContinued on next pageChapter 2. Exchanges By Country

ccxt Documentation, Release 1.50.76country / therlandsNetherlandsNetherlandsNetherlandsNew ZealandNew ngaporeSingaporeSingaporeSingaporeSlovakiaSouth AfricaSouth AfricaSouth KoreaSouth KoreaSouth KoreaSouth KoreaSouth KoreaSouth KoreaSouth UKUKTable 1 – continued from previous pagelogoidnamever er1APIbinancejebinancejeBinance serve independentreserve Independent Reserve dabudaBuda2APIcexcexCEX.IO*APIexmoexmoEXMO1.1 APIhuobiruhuobiruHuobi ollaexHollaEx1APIexmoexmoEXMO1.1 mpBitstamp2APIContinued on next page9

ccxt Documentation, Release 1.50.76country / regionUKUKUKUKUKUKUKUKUKUKUKUkraineUkraineUnited Arab USUSVenezuelaVietnam10Table 1 – continued from previous ctradeuaBTC Trade aseprimecoinbaseprimeCoinbase PrimecoinbaseprocoinbaseproCoinbase itBitkkexkkexKKEXbinanceusbinanceusBinance eoceanThe IAPIAPIAPIAPIAPIAPIAPIAPIAPIChapter 2. Exchanges By Country

CHAPTER3InstallThe easiest way to install the ccxt library is to use builtin package managers: ccxt in NPM (JavaScript / Node v7.6 ) ccxt in PyPI (Python 3)This library is shipped as an all-in-one module implementation with minimalistic dependencies and requirements: ccxt.js https://github.com/ccxt/ccxt/blob/master/ccxt.js ‘ in JavaScript ./python/ https://github.com/ccxt/ccxt/blob/master/python/ ‘ in Python (generated from JS) ccxt.php https://github.com/ccxt/ccxt/blob/master/ccxt.php ‘ in PHP (generated from JS)You can also clone it into your project directory from ccxt GitHub repository and copy files manually into your workingdirectory with language extension appropriate for your environment.git clone https://github.com/ccxt/ccxt.gitAn alternative way of installing this library is to build a custom bundle from source. Choose exchanges you need inexchanges.cfg.3.1 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 in your babel-loaderconfig.ccxt crypto trading library in npmnpm install ccxtvar ccxt require ('ccxt')console.log (ccxt.exchanges) // print all available exchanges11

ccxt Documentation, Release 1.50.763.1.1 Node.js WindowsWindows users having difficulties installing w3, scrypt or node-gyp dependencies for the ccxt library, try installing scrypt first:npm install -g web3 --unsafe-perm true --allow-rootorsudo npm install -g web3 --unsafe-perm true --allow-rootThen install ccxt as usual with npm install ccxt.If that does not help, please, follow here: https://github.com/nodejs/node-gyp#on-windows3.2 JavaScript (for use with the script tag):All-in-one browser bundle (dependencies included),

A JavaScript / Python / PHP library for cryptocurrency trading and e-commerce with support for many bit- coin/ether/altcoin