README.md

    CCXT – CryptoCurrency eXchange Trading Library

    Build Status npm PyPI NPM Downloads Discord Supported Exchanges Open Collective 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.

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

    Sponsored Promotion

    CCXT Pro – A JavaScript / Python / PHP cryptocurrency exchange trading WebSocket API for professionals

    See Also

    • TabTrader TabTrader – trading on all exchanges in one app. Avaliable on Android and iOS!
    • Freqtrade Freqtrade – leading opensource cryptocurrency algorithmic trading software!
    • OctoBot OctoBot – cryptocurrency trading bot with an advanced web interface.

    Certified Cryptocurrency Exchanges

    logo id name ver certified pro discount
    aax aax AAX API Version 2 CCXT Certified CCXT Pro
    ascendex ascendex AscendEX API Version 2 CCXT Certified Sign up with AscendEX using CCXT's referral link for a 25% discount!
    binance binance Binance API Version * CCXT Certified CCXT Pro Sign up with Binance using CCXT's referral link for a 20% 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 20% 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 20% discount!
    bitmart bitmart BitMart API Version 1 CCXT Certified CCXT Pro Sign up with BitMart using CCXT's referral link for a 30% discount!
    bitvavo bitvavo Bitvavo API Version 2 CCXT Certified CCXT Pro
    currencycom currencycom Currency.com API Version 1 CCXT Certified CCXT Pro
    ftx ftx FTX API Version * CCXT Certified CCXT Pro Sign up with FTX using CCXT's referral link for a 5% discount!
    gateio gateio 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!
    idex idex IDEX API Version 2 CCXT Certified CCXT Pro
    mexc mexc MEXC Global API Version 2 CCXT Certified
    okex okex OKEX API Version 5 CCXT Certified CCXT Pro
    wavesexchange wavesexchange Waves.Exchange API Version * CCXT Certified
    zb zb ZB API Version 1 CCXT Certified CCXT Pro Sign up with ZB using CCXT's referral link for a 16% discount!

    Supported Cryptocurrency Exchange Markets

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

    logo id name ver certified pro
    aax aax AAX API Version 2 CCXT Certified CCXT Pro
    aofex aofex AOFEX API Version *
    ascendex ascendex AscendEX API Version 2 CCXT Certified
    bequant bequant Bequant API Version 2 CCXT Pro
    bibox bibox Bibox API Version 1
    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
    bitbay bitbay BitBay API Version *
    bitbns bitbns Bitbns API Version 2
    bitcoincom bitcoincom bitcoin.com API Version 2 CCXT Pro
    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 3
    bithumb bithumb Bithumb API Version *
    bitmart bitmart BitMart API Version 1 CCXT Certified CCXT Pro
    bitmex bitmex BitMEX API Version 1 CCXT Pro
    bitpanda bitpanda Bitpanda Pro API Version 1
    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
    bl3p bl3p BL3P API Version 1
    btcalpha btcalpha BTC-Alpha API Version 1
    btcbox btcbox BtcBox API Version 1
    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
    bw bw BW API Version 1
    bybit bybit Bybit API Version 2
    bytetrade bytetrade ByteTrade API Version *
    cex cex CEX.IO API Version *
    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 *
    coinegg coinegg CoinEgg API Version *
    coinex coinex CoinEx API Version 1
    coinfalcon coinfalcon CoinFalcon API Version 1
    coinmarketcap coinmarketcap CoinMarketCap API Version 1
    coinmate coinmate CoinMate API Version *
    coinone coinone CoinOne API Version 2
    coinspot coinspot CoinSpot API Version *
    crex24 crex24 CREX24 API Version 2
    currencycom currencycom Currency.com API Version 1 CCXT Certified CCXT Pro
    delta delta Delta Exchange API Version 2
    deribit deribit Deribit API Version 2
    digifinex digifinex DigiFinex API Version 3
    eqonex eqonex EQONEX API Version *
    equos equos EQUOS API Version *
    exmo exmo EXMO API Version 1.1
    exx exx EXX API Version *
    flowbtc flowbtc flowBTC API Version 1
    ftx ftx FTX API Version * CCXT Certified CCXT Pro
    gateio gateio Gate.io API Version 4 CCXT Certified CCXT Pro
    gemini gemini Gemini API Version 1
    hitbtc hitbtc HitBTC API Version 2 CCXT Pro
    hollaex hollaex HollaEx API Version 2
    huobi huobi Huobi API Version 1 CCXT Certified CCXT Pro
    idex idex IDEX API Version 2 CCXT Certified CCXT Pro
    independentreserve independentreserve Independent Reserve API Version *
    indodax indodax INDODAX API Version 2.0
    itbit itbit itBit API Version 1
    kraken kraken Kraken API Version 0 CCXT Pro
    kucoin kucoin KuCoin API Version 2 CCXT Pro
    kuna kuna Kuna API Version 2
    latoken latoken Latoken API Version 1
    lbank lbank LBank API Version 1
    liquid liquid Liquid API Version 2
    luno luno luno API Version 1
    lykke lykke Lykke API Version 1
    mercado mercado Mercado Bitcoin API Version 3
    mexc mexc MEXC Global API Version 2 CCXT Certified
    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
    okex okex OKEX API Version 5 CCXT Certified CCXT Pro
    okex3 okex3 OKEX API Version 3 CCXT Pro
    paymium paymium Paymium API Version 1
    phemex phemex Phemex API Version 1 CCXT Pro
    poloniex poloniex Poloniex API Version * CCXT Pro
    probit probit ProBit API Version 1
    qtrade qtrade qTrade API Version 1
    ripio ripio Ripio API Version 1 CCXT Pro
    stex stex STEX API Version 3
    therock therock TheRockTrading API Version 1
    tidebit tidebit TideBit API Version 2
    tidex tidex Tidex API Version 3
    timex timex TimeX API Version 1
    upbit upbit Upbit API Version 1 CCXT Pro
    vcc vcc VCC Exchange API Version 3
    wavesexchange wavesexchange Waves.Exchange API Version * CCXT Certified
    whitebit whitebit WhiteBit API Version 2
    xena xena Xena Exchange API Version *
    yobit yobit YoBit API Version 3
    zaif zaif Zaif API Version 1
    zb zb ZB API Version 1 CCXT Certified CCXT Pro

    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
    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@1.58.84/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

    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.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' })
    
    }) ();

    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: info@ccxt.trade

    项目简介

    🚀 Github 镜像仓库 🚀

    源项目地址

    https://github.com/ccxt/ccxt

    发行版本

    当前项目没有发行版本

    贡献者 47

    全部贡献者

    开发语言

    • JavaScript 36.0 %
    • PHP 33.0 %
    • Python 30.9 %
    • Shell 0.0 %
    • Dockerfile 0.0 %