Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including ccxt-js with all npm packages installed. Try it out:

var ccxtJs = require("ccxt-js")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

ccxt-js v1.15.38

The node.js portion of original ccxt cryptocurrency trading library with support for 100+ exchanges. It reduces the size of the library from 40MB to 8MB

CCXT – CryptoCurrency eXchange Trading Library

Build Status npm PyPI NPM Downloads NSP Status Gitter Supported Exchanges Open Collective

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 intended to be used by coders, developers, technically-skilled traders, data-scientists and financial analysts for building trading algorithms on top of it.

Current feature list:

  • 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 normalized 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 7.6+, Python 2 and 3, PHP 5.3+, web browsers

ccxt on GitHub | Install | Usage | Manual | FAQ | Examples | Changelog | Contributing

Supported Cryptocurrency Exchange Markets

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

idnameverdoccountries
_1broker_1broker1Broker2APIUS
_1btcxe_1btcxe1BTCXE*APIPanama
acxacxACX2APIAustralia
allcoinallcoinAllcoin1APICanada
anxproanxproANXPro2APIJapan, Singapore, Hong Kong, New Zealand
anybitsanybitsAnybits*APIIreland
biboxbiboxBibox1APIChina, US, South Korea
binancebinanceBinance*APIJapan
bit2cbit2cBit2C*APIIsrael
bitbankbitbankbitbank1APIJapan
bitbaybitbayBitBay*APIMalta, EU
bitfinexbitfinexBitfinex1APIBritish Virgin Islands
bitfinex2bitfinex2Bitfinex v22APIBritish Virgin Islands
bitflyerbitflyerbitFlyer1APIJapan
bithumbbithumbBithumb*APISouth Korea
bitkkbitkkbitkk1APIChina
bitlishbitlishBitlish1APIUK, EU, Russia
bitmarketbitmarketBitMarket*APIPoland, EU
bitmexbitmexBitMEX1APISeychelles
bitsanebitsaneBitsane*APIIreland
bitsobitsoBitso3APIMexico
bitstampbitstampBitstamp2APIUK
bitstamp1bitstamp1Bitstamp v11APIUK
bittrexbittrexBittrex1.1APIUS
bitzbitzBit-Z1APIHong Kong
bl3pbl3pBL3P1APINetherlands, EU
bleutradebleutradeBleutrade2APIBrazil
braziliexbraziliexBraziliex*APIBrazil
btcboxbtcboxBtcBox1APIJapan
btcchinabtcchinaBTCChina1APIChina
btcexchangebtcexchangeBTCExchange*APIPhilippines
btcmarketsbtcmarketsBTC Markets*APIAustralia
btctradeimbtctradeimBtcTrade.im*APIHong Kong
btctradeuabtctradeuaBTC Trade UA*APIUkraine
btcturkbtcturkBTCTurk*APITurkey
btcxbtcxBTCX1APIIceland, US, EU
bxinthbxinthBX.in.th*APIThailand
ccexccexC-CEX*APIGermany, EU
cexcexCEX.IO*APIUK, EU, Cyprus, Russia
chbtcchbtcCHBTC1APIChina
chilebitchilebitChileBit1APIChile
cobinhoodcobinhoodCOBINHOOD*APITaiwan
coinbasecoinbasecoinbase2APIUS
coinbaseprocoinbaseproCoinbase Pro*APIUS
coincheckcoincheckcoincheck*APIJapan, Indonesia
coineggcoineggCoinEgg*APIChina, UK
coinexcoinexCoinEx1APIChina
coinexchangecoinexchangeCoinExchange*APIIndia, Japan, South Korea, Vietnam, US
coinfalconcoinfalconCoinFalcon*APIUK
coinfloorcoinfloorcoinfloor*APIUK
coingicoingiCoingi*APIPanama, Bulgaria, China, US
coinmarketcapcoinmarketcapCoinMarketCap1APIUS
coinmatecoinmateCoinMate*APIUK, Czech Republic, EU
coinnestcoinnestcoinnest*APISouth Korea
coinonecoinoneCoinOne2APISouth Korea
coinsecurecoinsecureCoinsecure1APIIndia
coinspotcoinspotCoinSpot*APIAustralia
cointigercointigerCoinTiger1APIChina
coolcoincoolcoinCoolCoin*APIHong Kong
cryptoncryptonCrypton1APIEU
cryptopiacryptopiaCryptopia*APINew Zealand
deribitderibitDeribit1APINetherlands
dsxdsxDSX3APIUK
ethfinexethfinexEthfinex1APIBritish Virgin Islands
exmoexmoEXMO1APISpain, Russia
exxexxEXX*APIChina
fcoinfcoinFCoin2APIChina
flowbtcflowbtcflowBTC1APIBrazil
foxbitfoxbitFoxBit1APIBrazil
fybsefybseFYB-SE*APISweden
fybsgfybsgFYB-SG*APISingapore
gatecoingatecoinGatecoin*APIHong Kong
gateiogateioGate.io2APIChina
gdaxgdaxGDAX*APIUS
geminigeminiGemini1APIUS
getbtcgetbtcGetBTC*APISt. Vincent & Grenadines, Russia
hadaxhadaxHADAX1APIChina
hitbtchitbtcHitBTC1APIHong Kong
hitbtc2hitbtc2HitBTC v22APIHong Kong
huobihuobiHuobi3APIChina
huobicnyhuobicnyHuobi CNY1APIChina
huobiprohuobiproHuobi Pro1APIChina
ice3xice3xICE3X*APISouth Africa
independentreserveindependentreserveIndependent Reserve*APIAustralia, New Zealand
indodaxindodaxINDODAX1.8APIIndonesia
itbititbititBit1APIUS
jubijubijubi.com1APIChina
krakenkrakenKraken0APIUS
kucoinkucoinKucoin1APIHong Kong
kunakunaKuna2APIUkraine
lakebtclakebtcLakeBTC2APIUS
lbanklbankLBank1APIChina
liquiliquiLiqui3APIUkraine
livecoinlivecoinLiveCoin*APIUS, UK, Russia
lunolunoluno1APIUK, Singapore, South Africa
lykkelykkeLykke1APISwitzerland
mercadomercadoMercado Bitcoin3APIBrazil
mixcoinsmixcoinsMixCoins1APIUK, Hong Kong
negociecoinsnegociecoinsNegocieCoins3APIBrazil
novanovaNovaexchange2APITanzania
okcoincnyokcoincnyOKCoin CNY1APIChina
okcoinusdokcoinusdOKCoin USD1APIChina, US
okexokexOKEX1APIChina, US
paymiumpaymiumPaymium1APIFrance, EU
poloniexpoloniexPoloniex*APIUS
qryptosqryptosQRYPTOS2APIChina, Taiwan
quadrigacxquadrigacxQuadrigaCX2APICanada
quoinexquoinexQUOINEX2APIJapan, Singapore, Vietnam
southxchangesouthxchangeSouthXchange*APIArgentina
surbitcoinsurbitcoinSurBitcoin1APIVenezuela
therocktherockTheRockTrading1APIMalta
tidebittidebitTideBit2APIHong Kong
tidextidexTidex3APIUK
urdubiturdubitUrduBit1APIPakistan
vaultorovaultoroVaultoro1APISwitzerland
vbtcvbtcVBTC1APIVietnam
virwoxvirwoxVirWoX*APIAustria, EU
wexwexWEX3APINew Zealand
xbtcexbtcexBTCe1APIRussia
yobityobitYoBit3APIRussia
yunbiyunbiYUNBI2APIChina
zaifzaifZaif1APIJapan
zbzbZB1APIChina

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

Install

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

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

An alternative way of installing this library into your code is to copy a single file manually into your working directory with language extension appropriate for your environment.

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-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 unpkg CDN, which is a fast, global content delivery network for everything on NPM.

<script type="text/javascript" src="https://unpkg.com/ccxt"></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 as ccxt # link against the asynchronous version of ccxt

PHP

ccxt in PHP with Packagist/Composer (PHP 5.3+)

It requires common PHP modules:

  • cURL
  • mbstring (using UTF-8 is highly recommended)
  • PCRE
  • iconv
include "ccxt.php";
var_dump (\ccxt\Exchange::$exchanges); // print a list of all available exchange classes

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

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 huobi     = new ccxt.huobi ()
    let okcoinusd = new ccxt.okcoinusd ({
        apiKey: 'YOUR_PUBLIC_API_KEY',
        secret: 'YOUR_SECRET_PRIVATE_KEY',
    })

    console.log (kraken.id,    await kraken.loadMarkets ())
    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 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()
huobi  = ccxt.huobi()
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',
})

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 ฿ 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',
));

$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 like it and want to help us improve it further or if you want to speed up 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]

Backers

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

Crypto

ETH 0xa7c2b18b7c8b86984560cad3b1bc3224b388ded0
BTC 33RmVRfhK2WZVQR1R83h2e9yXoqRNDvJva
BCH 1GN9p233TvNcNQFthCgfiHUnj5JRKEc2Ze
LTC LbT8mkAqQBphc4yxLXEDgYDfEax74et3bP

Thank you!

Metadata

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free