Skip to content

Latest commit

 

History

History
554 lines (418 loc) · 107 KB

README.md

File metadata and controls

554 lines (418 loc) · 107 KB

CCXT – CryptoCurrency eXchange Trading Library

Build Status npm PyPI NPM Downloads Discord Supported Exchanges Twitter Follow

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 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 10.4+, Python 3, PHP 8.1+, and web browsers

Sponsored Promotion

Join the CCXT x Gate.io Campaign: Win 100% Trading Fee Discount and VIP Upgrade on Gate.io

See Also

  • TabTrader TabTrader – trading on all exchanges in one app. Available on Android and iOS!
  • Freqtrade Freqtrade – leading opensource cryptocurrency algorithmic trading software!
  • OctoBot OctoBot – cryptocurrency trading bot with an advanced web interface.
  • TokenBot TokenBot – discover and copy the best algorithmic traders in the world.

Certified Cryptocurrency Exchanges

logo id name ver certified pro discount
binance binance Binance API Version * CCXT Certified CCXT Pro Sign up with Binance using CCXT's referral link for a 10% discount!
binancecoinm binancecoinm Binance COIN-M API Version * CCXT Certified CCXT Pro Sign up with Binance COIN-M using CCXT's referral link for a 10% discount!
binanceusdm binanceusdm Binance USDⓈ-M API Version * CCXT Certified CCXT Pro Sign up with Binance USDⓈ-M using CCXT's referral link for a 10% discount!
bitget bitget Bitget API Version 1 CCXT Certified CCXT Pro
bitmart bitmart BitMart API Version 2 CCXT Certified CCXT Pro Sign up with BitMart using CCXT's referral link for a 30% discount!
bitmex bitmex BitMEX API Version 1 CCXT Certified CCXT Pro
bitvavo bitvavo Bitvavo API Version 2 CCXT Certified CCXT Pro
bybit bybit Bybit API Version 5 CCXT Certified CCXT Pro
gate gate Gate.io API Version 4 CCXT Certified CCXT Pro Sign up with Gate.io using CCXT's referral link for a 20% discount!
huobi huobi Huobi API Version 1 CCXT Certified CCXT Pro Sign up with Huobi using CCXT's referral link for a 15% discount!
kucoin kucoin KuCoin API Version 2 CCXT Certified CCXT Pro
mexc mexc MEXC Global API Version 3 CCXT Certified CCXT Pro
okx okx OKX API Version 5 CCXT Certified CCXT Pro
wavesexchange wavesexchange Waves.Exchange API Version * CCXT Certified

Supported Cryptocurrency Exchange Markets

The CCXT library currently supports the following 106 cryptocurrency exchange markets and trading APIs:

logo id name ver certified pro
ace ace ACE API Version 2
alpaca alpaca Alpaca API Version * CCXT Pro
ascendex ascendex AscendEX API Version 2 CCXT Pro
bequant bequant Bequant API Version 2 CCXT Pro
bigone bigone BigONE API Version 3
binance binance Binance API Version * CCXT Certified CCXT Pro
binancecoinm binancecoinm Binance COIN-M API Version * CCXT Certified CCXT Pro
binanceus binanceus Binance US API Version * CCXT Pro
binanceusdm binanceusdm Binance USDⓈ-M API Version * CCXT Certified CCXT Pro
bit2c bit2c Bit2C API Version *
bitbank bitbank bitbank API Version 1
bitbns bitbns Bitbns API Version 2
bitfinex bitfinex Bitfinex API Version 1 CCXT Pro
bitfinex2 bitfinex2 Bitfinex API Version 2
bitflyer bitflyer bitFlyer API Version 1
bitforex bitforex Bitforex API Version 1
bitget bitget Bitget API Version 1 CCXT Certified CCXT Pro
bithumb bithumb Bithumb API Version *
bitmart bitmart BitMart API Version 2 CCXT Certified CCXT Pro
bitmex bitmex BitMEX API Version 1 CCXT Certified CCXT Pro
bitopro bitopro BitoPro API Version 3 CCXT Pro
bitpanda bitpanda Bitpanda Pro API Version 1
bitrue bitrue Bitrue API Version 1 CCXT Pro
bitso bitso Bitso API Version 3
bitstamp bitstamp Bitstamp API Version 2 CCXT Pro
bitstamp1 bitstamp1 Bitstamp API Version 1
bittrex bittrex Bittrex API Version 3 CCXT Pro
bitvavo bitvavo Bitvavo API Version 2 CCXT Certified CCXT Pro
bkex bkex BKEX API Version 2
bl3p bl3p BL3P API Version 1
blockchaincom blockchaincom Blockchain.com API Version 3
btcalpha btcalpha BTC-Alpha API Version 1
btcbox btcbox BtcBox API Version 1
btcex btcex BTCEX API Version 1 CCXT Pro
btcmarkets btcmarkets BTC Markets API Version 3
btctradeua btctradeua BTC Trade UA API Version *
btcturk btcturk BTCTurk API Version *
buda buda Buda API Version 2
bybit bybit Bybit API Version 5 CCXT Certified CCXT Pro
cex cex CEX.IO API Version * CCXT Pro
coinbase coinbase Coinbase API Version 2
coinbaseprime coinbaseprime Coinbase Prime API Version * CCXT Pro
coinbasepro coinbasepro Coinbase Pro API Version * CCXT Pro
coincheck coincheck coincheck API Version *
coinex coinex CoinEx API Version 1 CCXT Pro
coinfalcon coinfalcon CoinFalcon API Version 1
coinmate coinmate CoinMate API Version *
coinone coinone CoinOne API Version 2
coinsph coinsph Coins.ph API Version 1
coinspot coinspot CoinSpot API Version *
cryptocom cryptocom Crypto.com API Version 2 CCXT Pro
currencycom currencycom Currency.com API Version 2 CCXT Pro
delta delta Delta Exchange API Version 2
deribit deribit Deribit API Version 2 CCXT Pro
digifinex digifinex DigiFinex API Version 3
exmo exmo EXMO API Version 1.1
flowbtc flowbtc flowBTC API Version * CCXT Pro
fmfwio fmfwio FMFW.io API Version 2 CCXT Pro
gate gate Gate.io API Version 4 CCXT Certified CCXT Pro
gemini gemini Gemini API Version 1 CCXT Pro
hitbtc hitbtc HitBTC API Version 2 CCXT Pro
hitbtc3 hitbtc3 HitBTC API Version 3
hollaex hollaex HollaEx API Version 2 CCXT Pro
huobi huobi Huobi API Version 1 CCXT Certified CCXT Pro
huobijp huobijp Huobi Japan API Version 1 CCXT Pro
idex idex IDEX API Version 3 CCXT Pro
independentreserve independentreserve Independent Reserve API Version * CCXT Pro
indodax indodax INDODAX API Version 2.0
itbit itbit itBit API Version 1
kraken kraken Kraken API Version 0 CCXT Pro
krakenfutures krakenfutures Kraken Futures API Version 3
kucoin kucoin KuCoin API Version 2 CCXT Certified CCXT Pro
kucoinfutures kucoinfutures KuCoin Futures API Version 1 CCXT Pro
kuna kuna Kuna API Version 2
latoken latoken Latoken API Version 2
lbank lbank LBank API Version 1
lbank2 lbank2 LBank API Version 2
luno luno luno API Version 1 CCXT Pro
lykke lykke Lykke API Version 2
mercado mercado Mercado Bitcoin API Version 3
mexc mexc MEXC Global API Version 3 CCXT Certified CCXT Pro
ndax ndax NDAX API Version * CCXT Pro
novadax novadax NovaDAX API Version 1
oceanex oceanex OceanEx API Version 1
okcoin okcoin OKCoin API Version 3 CCXT Pro
okx okx OKX API Version 5 CCXT Certified CCXT Pro
paymium paymium Paymium API Version 1
phemex phemex Phemex API Version 1 CCXT Pro
poloniex poloniex Poloniex API Version *
poloniexfutures poloniexfutures Poloniex Futures API Version 1
probit probit ProBit API Version 1 CCXT Pro
ripio ripio Ripio API Version 1 CCXT Pro
stex stex STEX API Version 3
tidex tidex Tidex API Version 3
timex timex TimeX API Version 1
tokocrypto tokocrypto Tokocrypto API Version 1
upbit upbit Upbit API Version 1 CCXT Pro
wavesexchange wavesexchange Waves.Exchange API Version * CCXT Certified
wazirx wazirx WazirX API Version 2 CCXT Pro
whitebit whitebit WhiteBit API Version 4
woo woo WOO X API Version 1 CCXT Pro
xt xt XT API Version 4
yobit yobit YoBit API Version 3
zaif zaif Zaif API Version 1
zb zb ZB API Version 1 CCXT Pro
zonda zonda Zonda API Version *

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:

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  # including 1GB of commit history

# or

git clone https://github.com/ccxt/ccxt.git --depth 1  # avoid downloading 1GB of commit history

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
//cjs
var ccxt = require ('ccxt')
console.log (ccxt.exchanges) // print all available exchanges
//esm
import {version, exchanges} from 'ccxt';
console.log(version, Object.keys(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/[email protected]/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 7.0+)

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

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

CCXT now supports ESM and CJS modules

CJS

// cjs example
'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.okcoin ({
        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',
        })

    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' })

}) ();

ESM

//esm example
import {version, binance} from 'ccxt';

console.log(version);
const exchange = new binance();
const ticker = await exchange.fetchTicker('BTC/USDT');
console.log(ticker);

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',
})

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

$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

Contact Us

For business inquiries: [email protected]