^$10/yr

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.
Install · Usage · Manual · FAQ · Examples · Contributing · Social · CCXT Pro
The CCXT library 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 by coders, developers, technically-skilled traders, data-scientists and financial analysts for building trading algorithms.
Current feature list:
support for many cryptocurrency exchanges — more coming soon
fully implemented public and private APIs
optional normalized data for cross-exchange analytics and arbitrage
an out of the box unified API that is extremely easy to integrate
works in Node 7.6+, Python 3, PHP 5.4+, and web browsers
Sponsored Promotion

See Also
  Quadency — trading automation terminal for leading exchanges with streaming APIs + Python IDE.
  TabTrader — trading on all exchanges in one app. Avaliable on Android and iOS.
  Pionex — 6 grid bots, spot-futures arb bot, smart trade and DCA bots. Free for Android and iOS!
  AAX — trade bitcoin futures with fees as low as 0.02% and up to 100x leverage!
Certified Cryptocurrency Exchanges
logo
id
name
ver
doc
certified
pro

aax
AAX
2
API

binance
Binance
*
API

bitfinex
Bitfinex
1
API

bittrex
Bittrex
3
API

bitvavo
Bitvavo
2
API

bytetrade
ByteTrade
*
API

currencycom
Currency.com
1
API

eterbase
Eterbase
1
API

ftx
FTX
*
API

gopax
GOPAX
1
API

idex
IDEX
2
API

kraken
Kraken
0
API

wavesexchange
Waves.Exchange
*
API

xena
Xena Exchange
*
API

Supported Cryptocurrency Exchange Markets
The CCXT library currently supports the following 124 cryptocurrency exchange markets and trading APIs:
logo
id
name
ver
doc
certified
pro

aax
AAX
2
API

acx
ACX
2
API

aofex
AOFEX
*
API

bequant
Bequant
2
API

bibox
Bibox
1
API

bigone
BigONE
3
API

binance
Binance
*
API

binanceus
Binance US
*
API

bit2c
Bit2C
*
API

bitbank
bitbank
1
API

bitbay
BitBay
*
API

bitcoincom
bitcoin.com
2
API

bitfinex
Bitfinex
1
API

bitfinex2
Bitfinex
2
API

bitflyer
bitFlyer
1
API

bitforex
Bitforex
1
API

bitget
Bitget
3
API

bithumb
Bithumb
*
API

bitkk
bitkk
1
API

bitmart
BitMart
1
API

bitmax
BitMax
1
API

bitmex
BitMEX
1
API

bitpanda
Bitpanda Pro
1
API

bitso
Bitso
3
API

bitstamp
Bitstamp
2
API

bitstamp1
Bitstamp
1
API

bittrex
Bittrex
3
API

bitvavo
Bitvavo
2
API

bitz
Bit-Z
2
API

bl3p
BL3P
1
API

bleutrade
Bleutrade
*
API

braziliex
Braziliex
*
API

btcalpha
BTC-Alpha
1
API

btcbox
BtcBox
1
API

btcmarkets
BTC Markets
3
API

btctradeua
BTC Trade UA
*
API

btcturk
BTCTurk
*
API

buda
Buda
2
API

bw
BW
1
API

bybit
Bybit
2
API

bytetrade
ByteTrade
*
API

cdax
CDAX
1
API

cex
CEX.IO
*
API

chilebit
ChileBit
1
API

coinbase
Coinbase
2
API

coinbaseprime
Coinbase Prime
*
API

coinbasepro
Coinbase Pro
*
API

coincheck
coincheck
*
API

coinegg
CoinEgg
*
API

coinex
CoinEx
1
API

coinfalcon
CoinFalcon
1
API

coinfloor
coinfloor
*
API

coingi
Coingi
*
API

coinmarketcap
CoinMarketCap
1
API

coinmate
CoinMate
*
API

coinone
CoinOne
2
API

coinspot
CoinSpot
*
API

crex24
CREX24
2
API

currencycom
Currency.com
1
API

delta
Delta Exchange
2
API

deribit
Deribit
2
API

digifinex
DigiFinex
3
API

dsx
DSX
3
API

eterbase
Eterbase
1
API

exmo
EXMO
1.1
API

exx
EXX
*
API

fcoin
FCoin
2
API

fcoinjp
FCoinJP
2
API

flowbtc
flowBTC
1
API

foxbit
FoxBit
1
API

ftx
FTX
*
API

gateio
Gate.io
2
API

gemini
Gemini
1
API

gopax
GOPAX
1
API

hbtc
HBTC
1
API

hitbtc
HitBTC
2
API

hollaex
HollaEx
1
API

huobijp
Huobi Japan
1
API

huobipro
Huobi Pro
1
API

ice3x
ICE3X
1
API

idex
IDEX
2
API

independentreserve
Independent Reserve
*
API

indodax
INDODAX
2.0
API

itbit
itBit
1
API

kraken
Kraken
0
API

kucoin
KuCoin
2
API

kuna
Kuna
2
API

lakebtc
LakeBTC
2
API

latoken
Latoken
1
API

lbank
LBank
1
API

liquid
Liquid
2
API

luno
luno
1
API

lykke
Lykke
1
API

mercado
Mercado Bitcoin
3
API

mixcoins
MixCoins
1
API

novadax
NovaDAX
1
API

oceanex
OceanEx
1
API

okcoin
OKCoin
3
API

okex
OKEX
3
API

paymium
Paymium
1
API

phemex
Phemex
1
API

poloniex
Poloniex
*
API

probit
ProBit
1
API

qtrade
qTrade
1
API

rightbtc
RightBTC
*
API

ripio
Ripio
1
API

southxchange
SouthXchange
*
API

stex
STEX
3
API

surbitcoin
SurBitcoin
1
API

therock
TheRockTrading
1
API

tidebit
TideBit
2
API

tidex
Tidex
3
API

timex
TimeX
1
API

upbit
Upbit
1
API

vaultoro
Vaultoro
1
API

vbtc
VBTC
1
API

vcc
VCC Exchange
3
API

wavesexchange
Waves.Exchange
*
API

whitebit
WhiteBit
2
API

xbtce
xBTCe
1
API

xena
Xena Exchange
*
API

yobit
YoBit
3
API

zaif
Zaif
1
API

zb
ZB
1
API

The list above is updated frequently, new crypto markets, exchanges, bug fixes, and API endpoints are introduced on a regular basis. See the Manual for 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 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.
Install
The easiest way to install the CCXT library is to use a package manager:
ccxt in NPM (JavaScript / Node v7.6+)
ccxt in PyPI (Python 3.5.3+)
ccxt in Packagist/Composer (PHP 5.4+)
This library is shipped as an all-in-one module implementation with minimalistic dependencies and requirements:
js/ in JavaScript
python/ in Python (generated from JS)
php/ in PHP (generated from JS)
You can also clone it into your project directory from ccxt GitHub repository:
git clone https://github.com/ccxt/ccxt.git
JavaScript (NPM)
JavaScript version of CCXT works in both 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-loader config.
ccxt in NPM
npm install ccxt
var ccxt = require (‘ccxt’)

console.log (ccxt.exchanges) // print all available exchanges
JavaScript (for use with the
Creates a global ccxt object:
console.log (ccxt.exchanges) // print all available exchanges
Python
ccxt in PyPI
pip install ccxt
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+
import ccxt.async_support as ccxt # link against the asynchronous version of ccxt
PHP
ccxt in PHP with Packagist/Composer (PHP 5.4+)
It requires common PHP modules:
cURL
mbstring (using UTF-8 is highly recommended)
PCRE
iconv
gmp (this is a built-in extension as of PHP 7.2+)
include "ccxt.php";
var_dump (ccxtExchange::$exchanges); // print a list of all available exchange classes
The library supports concurrent asynchronous mode using tools from RecoilPHP and ReactPHP in PHP 7.1+. Read the Manual for more details.
Docker
You 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 the Contributing document for the details on that).
Using docker-compose (in the cloned CCXT repository):
docker-compose run --rm ccxt
You 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.
Documentation
Read the Manual for more details.
Usage
Intro
The 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 data
instruments/trading pairs
price feeds (exchange rates)
order books
trade history
tickers
OHLC(V) for charting
other public endpoints
In 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 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 are available in CCXT Pro, which is a professional addon to CCXT with support for WebSocket streams.
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 for more details.
JavaScript
'use strict';
const ccxt = require ('ccxt');

(async function () {
let kraken = new ccxt.kraken ()
let bitfinex = new ccxt.bitfinex ({ verbose: true })
let huobipro = new ccxt.huobipro ()
let okcoinusd = new ccxt.okcoinusd ({
apiKey: 'YOUR_PUBLIC_API_KEY',
secret: 'YOUR_SECRET_PRIVATE_KEY',
})

const exchangeId = 'binance'
, exchangeClass = ccxt[exchangeId]
, exchange = new exchangeClass ({
'apiKey': 'YOUR_API_KEY',
'secret': 'YOUR_SECRET',
'timeout': 30000,
'enableRateLimit': true,
})

console.log (kraken.id, await kraken.loadMarkets ())
console.log (bitfinex.id, await bitfinex.loadMarkets ())
console.log (huobipro.id, await huobipro.loadMarkets ())

console.log (kraken.id, await kraken.fetchOrderBook (kraken.symbols[0]))
console.log (bitfinex.id, await bitfinex.fetchTicker ('BTC/USD'))
console.log (huobipro.id, await huobipro.fetchTrades ('ETH/USDT'))

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
# coding=utf-8

import ccxt

hitbtc = 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',
'timeout': 30000,
'enableRateLimit': True,
})

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 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
include 'ccxt.php';

$poloniex = new ccxtpoloniex ();
$bittrex = new ccxtbittrex (array ('verbose' => true));
$quoinex = new ccxtquoinex ();
$zaif = new ccxtzaif (array (
'apiKey' => 'YOUR_PUBLIC_API_KEY',
'secret' => 'YOUR_SECRET_PRIVATE_KEY',
));
$hitbtc = new ccxthitbtc (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',
'timeout' => 30000,
'enableRateLimit' => true,
));

$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 document before making changes that you would like adopted in the code. Also, read the Manual 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 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!
Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website.
[Become a sponsor]

Supporters
Support this project by becoming a supporter. Your avatar will show up here with a link to your website.
[Become a supporter]

Backers
Thank you to all our backers! [Become a backer]

Thank you!
Social
Follow us on Twitter
Read our blog on Medium

Contact Us
For business inquiries: [email protected]