forked from ccxt/ccxt
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
16,859 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,329 @@ | ||
| # ccxt | ||
| # ccxt – CryptoCurrency eXchange Trading Library | ||
|
|
||
| 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, trading strategy backtesting, bot programming, webshop integration and related software engineering. It is intented to be used by coders, developers and financial analysts to build trading algorithms on top of it. | ||
|
|
||
| Current featurelist: | ||
| - 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 normalised data for cross-market or cross-currency analytics and arbitrage | ||
| - an out-of-the box unified all-in-one API extremely easy to integrate | ||
|
|
||
| [Installation](#installation) | [Usage](#usage) | [Documentation](https://github.com/kroitor/ccxt/wiki) | [Public Offer](https://github.com/kroitor/ccxt/blob/master/OFFER.md) | ||
|
|
||
| ## Supported Cryptocurrency Exchange Markets | ||
|
|
||
| | id | name | countries | | ||
| |------------|----------------------------------------------|-----------------------------| | ||
| | _1broker | [1Broker](https://1broker.com) | US | | ||
| | _1btcxe | [1BTCXE](https://1btcxe.com) | Panama | | ||
| | bit2c | [Bit2C](https://www.bit2c.co.il) | Israel | | ||
| | bitbay | [BitBay](https://bitbay.net) | Poland, EU | | ||
| | bitcoid | [Bitcoin.co.id](https://www.bitcoin.co.id) | Indonesia | | ||
| | bitfinex | [Bitfinex](https://www.bitfinex.com) | US | | ||
| | bitlish | [bitlish](https://bitlish.com) | UK, EU, Russia | | ||
| | bitmarket | [BitMarket](https://www.bitmarket.pl) | Poland, EU | | ||
| | bitmex | [BitMEX](https://www.bitmex.com) | Seychelles | | ||
| | bitso | [Bitso](https://bitso.com) | Mexico | | ||
| | bittrex | [Bittrex](https://bittrex.com) | US | | ||
| | btcx | [BTCX](https://btc-x.is) | Iceland, US, EU | | ||
| | bxinth | [BX.in.th](https://bx.in.th) | Thailand | | ||
| | ccex | [C-CEX](https://c-cex.com) | Germany, EU | | ||
| | cex | [CEX.IO](https://cex.io) | UK, EU, Cyprus, Russia | | ||
| | coincheck | [coincheck](https://coincheck.com) | Japan | | ||
| | coinsecure | [Coinsecure](https://coinsecure.in) | India | | ||
| | exmo | [EXMO](https://exmo.me) | Spain, Russia | | ||
| | fybse | [FYB-SE](https://www.fybse.se) | Sweden | | ||
| | fybsg | [FYB-SG](https://www.fybsg.com) | Singapore | | ||
| | hitbtc | [HitBTC](https://hitbtc.com) | China, Denmark | | ||
| | huobi | [Huobi](https://www.huobi.com) | China | | ||
| | jubi | [jubi.com](https://www.jubi.com) | China | | ||
| | kraken | [Kraken](https://www.kraken.com) | US | | ||
| | luno | [luno](https://www.luno.com) | UK, Singapore, South Africa | | ||
| | okcoinusd | [OKCoin USD](https://www.okcoin.com) | China, US | | ||
| | okcoincny | [OKCoin CNY](https://www.okcoin.cn) | China | | ||
| | poloniex | [Poloniex](https://poloniex.com) | US | | ||
| | quadrigacx | [QuadrigaCX](https://www.quadrigacx.com) | Canada | | ||
| | quoine | [QUOINE](https://www.quoine.com) | Japan, Singapore, Vietnam | | ||
| | therock | [TheRockTrading](https://therocktrading.com) | Malta | | ||
| | vaultoro | [Vaultoro](https://www.vaultoro.com) | Switzerland | | ||
| | virwox | [VirWoX](https://www.virwox.com) | Austria | | ||
| | yobit | [YoBit](https://www.yobit.net) | Russia | | ||
| | zaif | [Zaif](https://zaif.jp) | Japan | | ||
|
|
||
| The list above is updated frequently, new crypto markets, altcoin exchanges, bug fixes, API endpoints are introduced and added on regular basis. If you don't find a cryptocurrency exchange market in the list above and/or want another market 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, that means its absolutely free for any developer to build commercial and opensource software on top of it, but use it as is at your own risk with no warranties. | ||
|
|
||
| Developer team is open for collaboration and available for hiring and outsourcing. If you're interested in integrating this software into an existing project or in developing new opensource and commercial projects we welcome you to read our [Public Offer](https://github.com/kroitor/ccxt/blob/master/OFFER.md). | ||
|
|
||
| <!-- | ||
| - A full list of all cryptocurrency exchange markets sorted by name alphabetically | ||
| - A list of cryptocurrency exchange markets by countries, regions and territories | ||
| - A list of cryptocurrency exchange markets by traded instruments, pairs, currencies, symbols, commodities, assets, stocks, indices and products | ||
| ------------------------------------------------------------------------------- | ||
| - A list of fully supported cryptocurrency exchange markets sorted by name alphabetically | ||
| - A list of cryptocurrency exchange markets scheduled for support in nearest future | ||
| - A list of cryptocurrency exchange markets by countries, regions and territories | ||
| - A list of cryptocurrency exchange markets by traded pairs, currencies, symbols, commodities, assets, stocks, indices and products | ||
| - A list of cryptocurrency exchange markets by full or partial API support status | ||
| - A list of unsupported and closed cryptocurrency exchanges | ||
| --> | ||
|
|
||
| ## Installation | ||
|
|
||
| This library is shipped as a single-file (all-in-one module) implementation with minimalistic dependencies and requirements. | ||
|
|
||
| The main file is: | ||
| - `ccxt.js` in JavaScript ([ccxt for Node.js](http://npmjs.com/package/ccxt) and web browsers) | ||
| - `ccxt.py` in Python (works in both Python 2 and 3) | ||
| - `ccxt.php` in PHP | ||
|
|
||
| The easiest way to install the ccxt library is to use builtin package managers. | ||
|
|
||
| You can also clone it directly into your project directory from GitHub repository: | ||
|
|
||
| ```shell | ||
| git clone https://github.com/kroitor/ccxt.git | ||
| ``` | ||
|
|
||
| An alternative way of installing this library into your code is to copy a single `ccxt.*` file manually into your working directory with language extension appropriate for your environment. | ||
|
|
||
| ### Node.js (npm) | ||
|
|
||
| ```shell | ||
| > npm install ccxt | ||
| ``` | ||
|
|
||
| Node version of the ccxt library requires `crypto` and `node-fetch`, both of them are installed automatically by npm. | ||
|
|
||
| ```JavaScript | ||
| var ccxt = require ('ccxt') | ||
| console.log (Object.keys (ccxt)) // print all available markets | ||
| ``` | ||
|
|
||
| ### Python | ||
|
|
||
| ```shell | ||
| > pip install ccxt | ||
| ``` | ||
|
|
||
| Python version of the ccxt library does not require any additional dependencies and uses builtin modules only. | ||
|
|
||
| ```Python | ||
| import ccxt | ||
| print dir (ccxt) # print a list of all available market classes | ||
| ``` | ||
|
|
||
| ### PHP | ||
|
|
||
| ```shell | ||
| > git clone https://github.com/kroitor/ccxt.git | ||
| ``` | ||
|
|
||
| The ccxt library in PHP requires common PHP modules: | ||
| - cURL | ||
| - mbstring (using UTF-8 is highly recommended) | ||
| - PCRE | ||
| - iconv | ||
|
|
||
| ```PHP | ||
| include "ccxt.php"; | ||
| $market = new \cxxt\$id (); // $id is a string literal id of your desired exchange market | ||
| ``` | ||
|
|
||
| ### Web Browsers | ||
|
|
||
| The ccxt library can also be used in web browser client-side JavaScript for various purposes. | ||
|
|
||
| ```shell | ||
| > git clone https://github.com/kroitor/ccxt.git | ||
| ``` | ||
|
|
||
| The client-side JavaScript version also requires CryptoJS. Download and unpack [CryptoJS](https://code.google.com/archive/p/crypto-js/) into your working directory or clone [CryptoJS from GitHub](https://github.com/sytelus/CryptoJS). | ||
|
|
||
| ```shell | ||
| > git clone https://github.com/sytelus/CryptoJS | ||
| ``` | ||
|
|
||
| Finally, add links to CryptoJS components and ccxt to your HTML page code: | ||
|
|
||
| ```HTML | ||
| <script src="crypto-js/rollups/sha256.js"></script> | ||
| <script src="crypto-js/rollups/hmac-sha256.js"></script> | ||
| <script src="crypto-js/rollups/hmac-sha512.js"></script> | ||
| <script src="crypto-js/components/enc-base64-min.js"></script> | ||
| <script src="crypto-js/components/enc-utf16-min.js"></script> | ||
|
|
||
| <script type="text/javascript" src="ccxt.js"></script> | ||
| <script type="text/javascript"> | ||
| // print all available markets | ||
| document.addEventListener ('DOMContentLoaded', () => console.log (ccxt)) | ||
| </script> | ||
| ``` | ||
|
|
||
| ## 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 API you need to obtain API keys from/to exchange markets. It often means registering with exchange markets 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 | ||
| market.methodName () // camelcase pseudocode | ||
| market.method_name () // underscore pseudocode | ||
| ``` | ||
|
|
||
| ### JavaScript | ||
|
|
||
| ```JavaScript | ||
| 'use strict'; | ||
| var 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', | ||
| }) | ||
|
|
||
| let krakenProducts = await kraken.loadProducts () | ||
|
|
||
| console.log (kraken.id, krakenProducts) | ||
| console.log (bitfinex.id, await bitfinex.loadProducts ()) | ||
| console.log (huobi.id, await huobi.loadProducts ()) | ||
|
|
||
| console.log (kraken.id, await kraken.fetchOrderBook (Object.keys (kraken.products)[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 (create market sell order) | ||
| console.log (okcoinusd.id, await okcoinusd.sell ('BTC/USD', 1)) | ||
|
|
||
| // buy 1 BTC/USD for $2500 (create limit buy order) | ||
| console.log (okcoinusd.id, await okcoinusd.buy ('BTC/USD', 1, 2500.00)) | ||
|
|
||
| }) () | ||
| ``` | ||
|
|
||
| ### Python | ||
|
|
||
| ```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', | ||
| }) | ||
|
|
||
| hitbtc_products = hitbtc.load_products () | ||
|
|
||
| print (hitbtc.id, hitbtc_products) | ||
| print (bitmex.id, bitmex.load_products ()) | ||
| print (huobi.id, huobi.load_products ()) | ||
|
|
||
| print (hitbtc.fetch_order_book (hitbtc_products.keys ()[0])) | ||
| print (bitmex.fetch_ticker ('BTC/USD')) | ||
| print (huobi.fetch_trades ('ETH/CNY')) | ||
|
|
||
| print (exmo.fetch_balance ()) | ||
| ``` | ||
|
|
||
| ### PHP | ||
|
|
||
| ```PHP | ||
| include 'ccxt.php'; | ||
|
|
||
| $poloniex = new \ccxt\poloniex (); | ||
| $bittrex = new \ccxt\bittrex (array ('verbose' => true)); | ||
| $zaif = new \ccxt\zaif (); | ||
| $quoine = new \ccxt\quoine (array ( | ||
| 'apiKey' => 'YOUR_PUBLIC_API_KEY', | ||
| 'secret' => 'YOUR_SECRET_PRIVATE_KEY', | ||
| )); | ||
|
|
||
| $poloniex_products = $poloniex->load_products (); | ||
|
|
||
| var_dump ($poloniex_products); | ||
| var_dump ($bittrex->load_products ()); | ||
| var_dump ($quoine->load_products ()); | ||
|
|
||
| var_dump ($poloniex->fetch_order_book (array_keys ($poloniex_products)[0])); | ||
| var_dump ($bittrex->fetch_trades ('BTC/USD')); | ||
| var_dump ($zaif->fetch_ticker ('BTC/JPY')); | ||
|
|
||
| var_dump ($quoine->fetch_balance ()); | ||
| ``` | ||
|
|
||
| ## Public Offer | ||
|
|
||
| Developer team is open for collaboration and available for hiring and outsourcing. | ||
|
|
||
| We can: | ||
| - implement a cryptocurrency trading strategy for you | ||
| - integrate APIs for any exchange markets you want | ||
| - create bots for algorithmic trading, arbitrage, scalping and HFT | ||
| - perform backtesting and data crunching | ||
| - implement any kind of protocol including REST, WebSockets, FIX, proprietary and legacy standards... | ||
| - actually directly integrate btc/altcoin blockchain or transaction graph into your system | ||
| - program a matching engine for you | ||
| - create a trading terminal for desktops, phones and pads (for web and native OSes) | ||
| - do all of the above in any of the following languages/environments: Javascript, Node.js, PHP, C, C++, C#, Python, Java, ObjectiveC, Linux, FreeBSD, MacOS, iOS, Windows | ||
|
|
||
| We implement bots, algorithmic trading software and strategies by your design. Costs for implementing a basic trading strategy are low (starting from a few coins) and depend on your requirements. | ||
|
|
||
| We are coders, not investors, so we ABSOLUTELY DO NOT do any kind of financial or trading advisory neither we invent profitable strategies to make you a fortune out of thin air. We guarantee the stability of the bot or trading software, but we cannot guarantee the profitability of your strategy nor can we protect you from natural financial risks and economic losses. Exact rules for the trading strategy is up to the trader/investor himself. We charge a fix flat price in cryptocurrency for our programming services and for implementing your requirements in software. | ||
|
|
||
| Please, contact us on GitHub or via email if you're interested in integrating this software into an existing project or in developing new opensource and commercial projects. | ||
|
|
||
| ## Contact Us | ||
|
|
||
| Igor Kroitor | ||
| [email protected] | ||
| https://github.com/kroitor | ||
|
|
||
| Vitaly Gordon | ||
| [email protected] | ||
| https://github.com/xpl |
Oops, something went wrong.