skip to navigation
skip to content

ccxt 1.3.67

A library for cryptocurrency trading and e-commerce with support for many bitcoin/ether/altcoin exchange markets and merchant APIs

Latest Version: 1.10.394

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 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-exchange or cross-currency analytics and arbitrage
  • an out-of-the box unified all-in-one API extremely easy to integrate
  • works in Node 6+, Python 2 and 3, PHP 5.3+

ccxt on GitHub | Install | Usage | Manual | Examples | Contributing | Public Offer

Supported Cryptocurrency Exchange Markets

The ccxt library currently supports the following 71 cryptocurrency exchange markets and trading APIs:

id name ver doc countries
_1broker 1Broker 2 API US
_1btcxe 1BTCXE * API Panama
anxpro ANXPro 2 API Japan, Singapore, Hong Kong, New Zealand
bit2c Bit2C * API Israel
bitbay BitBay * API Poland, EU
bitbays BitBays 1 API China, UK, Hong Kong, Australia, Canada
bitcoincoid Bitcoin.co.id * API Indonesia
bitfinex Bitfinex 1 API US
bitflyer bitFlyer 1 API Japan
bitlish bitlish 1 API UK, EU, Russia
bitmarket BitMarket * API Poland, EU
bitmex BitMEX 1 API Seychelles
bitso Bitso 3 API Mexico
bitstamp Bitstamp 2 API UK
bittrex Bittrex 1.1 API US
bl3p BL3P 1 API Netherlands, EU
btcchina BTCChina 1 API China
btce BTC-e 3 API Bulgaria, Russia
btcexchange BTCExchange * API Philippines
btcmarkets BTC Markets * API Australia
btctradeua BTC Trade UA * API Ukraine
btcturk BTCTurk * API Turkey
btcx BTCX 1 API Iceland, US, EU
bter Bter 2 API British Virgin Islands, China
bxinth BX.in.th * API Thailand
ccex C-CEX * API Germany, EU
cex CEX.IO * API UK, EU, Cyprus, Russia
chbtc CHBTC 1 API China
chilebit ChileBit 1 API Chile
coincheck coincheck * API Japan, Indonesia
coingi Coingi * API Panama, Bulgaria, China, US
coinmarketcap CoinMarketCap 1 API US
coinmate CoinMate * API UK, Czech Republic
coinsecure Coinsecure 1 API India
coinspot CoinSpot * API Australia
dsx DSX * API UK
exmo EXMO 1 API Spain, Russia
flowbtc flowBTC 1 API Brazil
foxbit FoxBit 1 API Brazil
fybse FYB-SE * API Sweden
fybsg FYB-SG * API Singapore
gatecoin Gatecoin * API Hong Kong
gdax GDAX * API US
gemini Gemini 1 API US
hitbtc HitBTC 1 API Hong Kong
huobi Huobi 3 API China
itbit itBit 1 API US
jubi jubi.com 1 API China
kraken Kraken 0 API US
lakebtc LakeBTC 2 API US
livecoin LiveCoin * API US, UK, Russia
liqui Liqui 3 API Ukraine
luno luno 1 API UK, Singapore, South Africa
mercado Mercado Bitcoin 3 API Brazil
okcoincny OKCoin CNY 1 API China
okcoinusd OKCoin USD 1 API China, US
paymium Paymium 1 API France, EU
poloniex Poloniex * API US
quadrigacx QuadrigaCX 2 API Canada
quoine QUOINE 2 API Japan, Singapore, Vietnam
southxchange SouthXchange * API Argentina
surbitcoin SurBitcoin 1 API Venezuela
therock TheRockTrading 1 API Malta
urdubit UrduBit 1 API Pakistan
vaultoro Vaultoro 1 API Switzerland
vbtc VBTC 1 API Vietnam
virwox VirWoX * API Austria
xbtce xBTCe 1 API Russia
yobit YoBit 3 API Russia
yunbi YUNBI 2 API China
zaif Zaif 1 API Japan

The list above is updated frequently, new crypto markets, altcoin exchanges, bug fixes, API endpoints are introduced and added on regular basis. See the Manual 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, 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.

Developer team is open to 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.

Install

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 and web browsers)
  • ccxt/__init__.py in Python (works in both Python 2 and 3, ccxt in PyPI)
  • ccxt.php in PHP

The easiest way to install the ccxt library is to use builtin package managers.

You can also clone it into your project directory from ccxt GitHub repository:

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)

ccxt crypto trading library in npm

npm install ccxt

Node version of the ccxt library requires crypto-js and node-fetch, both of them are installed automatically by npm.

var ccxt = require ('ccxt')
console.log (ccxt.exchanges) // print all available exchanges

Python

ccxt algotrading library in PyPI

pip install ccxt

Python version of the ccxt library does not require any additional dependencies and uses builtin modules only.

import ccxt
print (ccxt.exchanges) # print a list of all available exchange classes

PHP

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

include "ccxt.php";
var_dump (\cxxt\Exchange::$exchanges); // print a list of all available exchange classes

Web Browsers

The ccxt library can also be used in web browser client-side JavaScript for various purposes.

git clone https://github.com/kroitor/ccxt.git

The client-side JavaScript version also requires CryptoJS. Download and unpack CryptoJS into your working directory or clone CryptoJS from GitHub.

git clone https://github.com/sytelus/CryptoJS

Finally, add links to CryptoJS components and ccxt to your HTML page code:

<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 exchanges
    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 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

See the Manual for more details.

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 krakenMarkets = await kraken.loadMarkets ()

    console.log (kraken.id,    krakenMarkets)
    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 BTC when the order is closed
    console.log (okcoinusd.id, await okcoinusd.createLimitBuyOrder ('BTC/USD', 1, 2500.00))

}) ()

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_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 BTC/USD 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 BTC when the order is closed
print (exmo.id, exmo.create_limit_buy_order ('BTC/EUR', 1, 2500.00))

PHP

include 'ccxt.php';

$poloniex = new \ccxt\poloniex  ();
$bittrex  = new \ccxt\bittrex   (array ('verbose' => true));
$quoine   = new \ccxt\zaif      ();
$zaif     = new \ccxt\quoine    (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 ($quoine->load_markets ());

var_dump ($poloniex->fetch_order_book ($poloniex->symbols[0]));
var_dump ($bittrex->fetch_trades ('BTC/USD'));
var_dump ($quoine->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 BTC immediately
var_dump ($zaif->id, $zaif->create_market_sell_order ('BTC/JPY', 1));

// buy BTC/JPY, you receive 1 BTC for ¥285000 when the order closes
var_dump ($zaif->id, $zaif->create_limit_buy_order ('BTC/JPY', 1, 285000));

Contributing

Please read the CONTRIBUTING document before making changes that you would like adopted in the code.

Public Offer

Developer team is open to 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 your own bitcoin/altcoin exchange
  • 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 by email if you’re interested in integrating this software into an existing project or in developing new opensource and commercial projects. Questions are welcome. Also, if want to make your own algorithmic cryptocurrency trading bot or you want us to make a bot for you, here’s our checklist for success.

 
File Type Py Version Uploaded on Size
ccxt-1.3.67.tar.gz (md5) Source 2017-08-13 86KB