@jmparsons/ccxt NPM

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

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 2 and 3, PHP 5.4+, and web browsers

Certified Cryptocurrency Exchanges

id	name	ver	doc
binance	Binance	*	API	Japan, Malta
bitfinex	Bitfinex	1	API	British Virgin Islands
bittrex	Bittrex	1.1	API	US
bytetrade	ByteTrade	*	API	Hong Kong
coss	COSS	1	API	Singapore, Netherlands
ftx	FTX	*	API	Hong Kong
idex	IDEX	*	API	US
kraken	Kraken	0	API	US
kucoin	KuCoin	2	API	Seychelles
mandala	Mandala	2	API	Malta
poloniex	Poloniex	*	API	US
upbit	Upbit	1	API	South Korea

Supported Cryptocurrency Exchange Markets

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

id	name	ver	doc
_1btcxe	1BTCXE	*	API	Panama
acx	ACX	2	API	Australia
adara	Adara	1	API	Malta
allcoin	Allcoin	1	API	Canada
anxpro	ANXPro	*	API	Japan, Singapore, Hong Kong, New Zealand
bcex	BCEX	1	API	China, Canada
bequant	Bequant	2	API	Malta
bibox	Bibox	1	API	China, US, South Korea
bigone	BigONE	2	API	UK
binance	Binance	*	API	Japan, Malta
binanceje	Binance Jersey	*	API	Jersey
binanceus	Binance US	*	API	US
bit2c	Bit2C	*	API	Israel
bitbank	bitbank	1	API	Japan
bitbay	BitBay	*	API	Malta, EU
bitfinex	Bitfinex	1	API	British Virgin Islands
bitfinex2	Bitfinex	2	API	British Virgin Islands
bitflyer	bitFlyer	1	API	Japan
bitforex	Bitforex	1	API	China
bithumb	Bithumb	*	API	South Korea
bitkk	bitkk	1	API	China
bitlish	Bitlish	1	API	UK, EU, Russia
bitmart	BitMart	2	API	US, China, Hong Kong, South Korea
bitmax	BitMax	1	API	China
bitmex	BitMEX	1	API	Seychelles
bitso	Bitso	3	API	Mexico
bitstamp	Bitstamp	2	API	UK
bitstamp1	Bitstamp	1	API	UK
bittrex	Bittrex	1.1	API	US
bitz	Bit-Z	2	API	Hong Kong
bl3p	BL3P	1	API	Netherlands, EU
bleutrade	Bleutrade	2	API	Brazil
braziliex	Braziliex	*	API	Brazil
btcalpha	BTC-Alpha	1	API	US
btcbox	BtcBox	1	API	Japan
btcchina	BTCChina	1	API	China
btcmarkets	BTC Markets	*	API	Australia
btctradeim	BtcTrade.im	*	API	Hong Kong
btctradeua	BTC Trade UA	*	API	Ukraine
btcturk	BTCTurk	*	API	Turkey
buda	Buda	2	API	Argentina, Chile, Colombia, Peru
bytetrade	ByteTrade	*	API	Hong Kong
cex	CEX.IO	*	API	UK, EU, Cyprus, Russia
chilebit	ChileBit	1	API	Chile
cobinhood	COBINHOOD	1	API	Taiwan
coinbase	Coinbase	2	API	US
coinbaseprime	Coinbase Prime	*	API	US
coinbasepro	Coinbase Pro	*	API	US
coincheck	coincheck	*	API	Japan, Indonesia
coinegg	CoinEgg	*	API	China, UK
coinex	CoinEx	1	API	China
coinexchange	CoinExchange	*	API	India, Japan, South Korea, Vietnam, US
coinfalcon	CoinFalcon	1	API	UK
coinfloor	coinfloor	*	API	UK
coingi	Coingi	*	API	Panama, Bulgaria, China, US
coinmarketcap	CoinMarketCap	1	API	US
coinmate	CoinMate	*	API	UK, Czech Republic, EU
coinone	CoinOne	2	API	South Korea
coinspot	CoinSpot	*	API	Australia
cointiger	CoinTiger	1	API	China
coolcoin	CoolCoin	*	API	Hong Kong
coss	COSS	1	API	Singapore, Netherlands
crex24	CREX24	2	API	Estonia
deribit	Deribit	1	API	Netherlands
digifinex	DigiFinex	3	API	Singapore
dsx	DSX	3	API	UK
dx	DX.Exchange	1	API	UK, EU
exmo	EXMO	1	API	Spain, Russia
exx	EXX	*	API	China
fcoin	FCoin	2	API	China
fcoinjp	FCoinJP	2	API	Japan
flowbtc	flowBTC	1	API	Brazil
foxbit	FoxBit	1	API	Brazil
ftx	FTX	*	API	Hong Kong
fybse	FYB-SE	*	API	Sweden
gateio	Gate.io	2	API	China
gemini	Gemini	1	API	US
hitbtc	HitBTC	1	API	Hong Kong
hitbtc2	HitBTC	2	API	Hong Kong
huobipro	Huobi Pro	1	API	China
huobiru	Huobi Russia	1	API	Russia
ice3x	ICE3X	1	API	South Africa
idex	IDEX	*	API	US
independentreserve	Independent Reserve	*	API	Australia, New Zealand
indodax	INDODAX	1.8	API	Indonesia
itbit	itBit	1	API	US
kkex	KKEX	2	API	China, US, Japan
kraken	Kraken	0	API	US
kucoin	KuCoin	2	API	Seychelles
kuna	Kuna	2	API	Ukraine
lakebtc	LakeBTC	2	API	US
latoken	Latoken	1	API	Cayman Islands
lbank	LBank	1	API	China
liquid	Liquid	2	API	Japan, China, Taiwan
livecoin	LiveCoin	*	API	US, UK, Russia
luno	luno	1	API	UK, Singapore, South Africa
lykke	Lykke	1	API	Switzerland
mandala	Mandala	2	API	Malta
mercado	Mercado Bitcoin	3	API	Brazil
mixcoins	MixCoins	1	API	UK, Hong Kong
negociecoins	NegocieCoins	3	API	Brazil
oceanex	OceanEx	1	API	US
okcoincny	OKCoin CNY	1	API	China
okcoinusd	OKCoin USD	1	API	China, US
okex	OKEX	1	API	China, US
okex3	OKEX	3	API	China, US
paymium	Paymium	1	API	France, EU
poloniex	Poloniex	*	API	US
rightbtc	RightBTC	*	API	United Arab Emirates
southxchange	SouthXchange	*	API	Argentina
stronghold	Stronghold	1	API
surbitcoin	SurBitcoin	1	API	Venezuela
theocean	The Ocean	1	API	US
therock	TheRockTrading	1	API	Malta
tidebit	TideBit	2	API	Hong Kong
tidex	Tidex	3	API	UK
upbit	Upbit	1	API	South Korea
vaultoro	Vaultoro	1	API	Switzerland
vbtc	VBTC	1	API	Vietnam
virwox	VirWoX	*	API	Austria, EU
whitebit	WhiteBit	2	API	Estonia
xbtce	xBTCe	1	API	Russia
yobit	YoBit	3	API	Russia
zaif	Zaif	1	API	Japan
zb	ZB	1	API	China

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 2 and 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 `<script>` tag):

All-in-one browser bundle (dependencies included), served from a CDN of your choice:

CDNs 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.

<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/ccxt@undefined/dist/ccxt.browser.js"></script>

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 (\ccxt\Exchange::$exchanges); // print a list of all available exchange classes

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

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

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/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 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/CNY'))

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 \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',
    '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!

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]

Crypto

ETH 0x26a3CB49578F07000575405a57888681249c35Fd (ETH only)
BTC 33RmVRfhK2WZVQR1R83h2e9yXoqRNDvJva
BCH 1GN9p233TvNcNQFthCgfiHUnj5JRKEc2Ze
LTC LbT8mkAqQBphc4yxLXEDgYDfEax74et3bP

Thank you!

Social

Team

Contact Us

For business inquiries: info@ccxt.trade

algorithmic algotrading altcoin altcoins api arbitrage backtest backtesting bitcoin bot btc cny coin coins crypto cryptocurrency crypto currency crypto market currency currencies darkcoin dash digital currency doge dogecoin e-commerce etc eth ether ethereum exchange exchanges eur framework invest investing investor library light litecoin ltc market market data markets merchandise merchant minimal ohlcv order orderbook order book price price data pricefeed private public ripple strategy ticker tickers toolkit trade trader trading usd volume xbt xrp zec zerocoin 1Broker 1BTCXE ACX acx.io allcoin allcoin.com ANX ANXPro bibox bibox.com Binance binance.com bit2c.co.il Bit2C BitBay BitBays bitcoincoid Bitcoin.co.id Bitfinex bitFLyer bitflyer.jp bithumb bithumb.com bitlish BitMarket BitMEX Bitso Bitstamp Bittrex BL3P Bleutrade bleutrade.com BlinkTrade braziliex braziliex.com BtcBox btcbox.co.jp BTCC BTCChina BTC-e BTCe BTCExchange btcexchange.ph BTC Markets btcmarkets btcmarkets.net BTCTrader btctrader.com btc-trade.com.ua BTC Trade UA BTCTurk btcturk.com BTCX btc-x bter Bter.com BX.in.th ccex C-CEX cex CEX.IO CHBTC ChileBit chilebit.net coincheck CoinExchange coinexchange.io coingi coingi.com CoinMarketCap CoinMate Coinsecure CoinSpot coinspot.com.au Crypto Capital cryptocapital.co Cryptopia cryptopia.co.nz DSX dsx.uk EXMO flowBTC flowbtc.com FoxBit foxbit.exchange FYB-SE FYB-SG Gatecoin GDAX Gemini HitBTC Huobi HuobiPRO huobi.pro Independent Reserve independentreserve.com itBit jubi.com Kraken Kucoin Kuna LakeBTC lakebtc.com LiveCoin Liqui liqui.io luno mercado MercadoBitcoin mercadobitcoin.br mixcoins mixcoins.com nova novaexchange novaexchange.com OKCoin OKCoin.com OKCoin.cn OKEX okex.com Paymium Poloniex QuadrigaCX Qryptos QUOINEX Southxchange SurBitcoin surbitcoin.com Tidex tidex.com TheRockTrading UrduBit urdubit.com Vaultoro VBTC vbtc.exchange vbtc.vn VirWoX WEX wex.nz xBTCe xbtce.com YoBit yobit.net YUNBI Zaif ZB

cloudscraper crypto-js fetch-ponyfill opencollective qs

@infinitebrahmanuniverse/nolb-_jm @everything-registry/sub-chunk-491 @zalastax/nolb-_jm

6 years ago

7 years ago

7 years ago

7 years ago

@jmparsons/ccxt v1.14.10

CCXT – CryptoCurrency eXchange Trading Library

Install · Usage · Manual · FAQ · Examples · Contributing · Social

Sponsored Promotion

See Also

Certified Cryptocurrency Exchanges

Supported Cryptocurrency Exchange Markets

Install

JavaScript (NPM)

JavaScript (for use with the `<script>` tag):

Python

PHP

Docker

Documentation

Usage

Intro

JavaScript

Python

PHP

Contributing

Support Developer Team

Sponsors

Supporters

Backers

Crypto

Social

Team

Contact Us

CCXT – CryptoCurrency eXchange Trading Library

Install · Usage · Manual · FAQ · Examples · Contributing · Social

Sponsored Promotion

See Also

Certified Cryptocurrency Exchanges

Supported Cryptocurrency Exchange Markets

Install

JavaScript (NPM)

JavaScript (for use with the <script> tag):

Python

PHP

Docker

Documentation

Usage

Intro

JavaScript

Python

PHP

Contributing

Support Developer Team

Sponsors

Supporters

Backers

Crypto

Social

Team

Contact Us

JavaScript (for use with the `<script>` tag):