Nutella Pancake Machine

    bihao-ccxt
    TypeScript icon, indicating that this package has built-in type declarations

    1.19.0 • Public • Published

    CCXT – CryptoCurrency eXchange Trading Library

    Build Status npm PyPI NPM Downloads Gitter 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

    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

    Sponsored Promotion

    Want this place? Contact us: info@ccxt.trade

    Placehodler

    See Also

    Certified Cryptocurrency Exchanges

           logo        id name ver doc certified
    binance binance Binance * API CCXT Certified
    bitfinex bitfinex Bitfinex 1 API CCXT Certified
    bittrex bittrex Bittrex 1.1 API CCXT Certified
    coss coss COSS 1 API CCXT Certified
    idex idex IDEX * API CCXT Certified
    kraken kraken Kraken 0 API CCXT Certified
    kucoin kucoin KuCoin 2 API CCXT Certified
    poloniex poloniex Poloniex * API CCXT Certified
    upbit upbit Upbit 1 API CCXT Certified

    Supported Cryptocurrency Exchange Markets

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

           logo        id name ver doc certified
    _1btcxe _1btcxe 1BTCXE * API
    acx acx ACX 2 API
    allcoin allcoin Allcoin 1 API
    anxpro anxpro ANXPro * API
    bcex bcex BCEX 1 API
    bequant bequant Bequant 2 API
    bibox bibox Bibox 1 API
    bigone bigone BigONE 2 API
    binance binance Binance * API CCXT Certified
    binanceje binanceje Binance Jersey * API
    bit2c bit2c Bit2C * API
    bitbank bitbank bitbank 1 API
    bitbay bitbay BitBay * API
    bitfinex bitfinex Bitfinex 1 API CCXT Certified
    bitfinex2 bitfinex2 Bitfinex 2 API
    bitflyer bitflyer bitFlyer 1 API
    bitforex bitforex Bitforex 1 API
    bithumb bithumb Bithumb * API
    bitkk bitkk bitkk 1 API
    bitlish bitlish Bitlish 1 API
    bitmart bitmart BitMart 2 API
    bitmex bitmex BitMEX 1 API
    bitso bitso Bitso 3 API
    bitstamp bitstamp Bitstamp 2 API
    bitstamp1 bitstamp1 Bitstamp 1 API
    bittrex bittrex Bittrex 1.1 API CCXT Certified
    bitz bitz Bit-Z 2 API
    bl3p bl3p BL3P 1 API
    bleutrade bleutrade Bleutrade 2 API
    braziliex braziliex Braziliex * API
    btcalpha btcalpha BTC-Alpha 1 API
    btcbox btcbox BtcBox 1 API
    btcchina btcchina BTCChina 1 API
    btcmarkets btcmarkets BTC Markets * API
    btctradeim btctradeim BtcTrade.im * API
    btctradeua btctradeua BTC Trade UA * API
    btcturk btcturk BTCTurk * API
    buda buda Buda 2 API
    bxinth bxinth BX.in.th * API
    cex cex CEX.IO * API
    chilebit chilebit ChileBit 1 API
    cobinhood cobinhood COBINHOOD 1 API
    coinbase coinbase Coinbase 2 API
    coinbaseprime coinbaseprime Coinbase Prime * API
    coinbasepro coinbasepro Coinbase Pro * API
    coincheck coincheck coincheck * API
    coinegg coinegg CoinEgg * API
    coinex coinex CoinEx 1 API
    coinexchange coinexchange CoinExchange * API
    coinfalcon coinfalcon CoinFalcon 1 API
    coinfloor coinfloor coinfloor * API
    coingi coingi Coingi * API
    coinmarketcap coinmarketcap CoinMarketCap 1 API
    coinmate coinmate CoinMate * API
    coinone coinone CoinOne 2 API
    coinspot coinspot CoinSpot * API
    cointiger cointiger CoinTiger 1 API
    coolcoin coolcoin CoolCoin * API
    coss coss COSS 1 API CCXT Certified
    crex24 crex24 CREX24 2 API
    crypton crypton Crypton 1 API
    deribit deribit Deribit 1 API
    digifinex digifinex DigiFinex 3 API
    dsx dsx DSX 3 API
    dx dx DX.Exchange 1 API
    ethfinex ethfinex Ethfinex 1 API
    exmo exmo EXMO 1 API
    exx exx EXX * API
    fcoin fcoin FCoin 2 API
    fcoinjp fcoinjp FCoinJP 2 API
    flowbtc flowbtc flowBTC 1 API
    foxbit foxbit FoxBit 1 API
    fybse fybse FYB-SE * API
    gateio gateio Gate.io 2 API
    gdax gdax GDAX * API
    gemini gemini Gemini 1 API
    hitbtc hitbtc HitBTC 1 API
    hitbtc2 hitbtc2 HitBTC 2 API
    huobipro huobipro Huobi Pro 1 API
    huobiru huobiru Huobi Russia 1 API
    ice3x ice3x ICE3X 1 API
    idex idex IDEX * API CCXT Certified
    independentreserve independentreserve Independent Reserve * API
    indodax indodax INDODAX 1.8 API
    itbit itbit itBit 1 API
    kkex kkex KKEX 2 API
    kraken kraken Kraken 0 API CCXT Certified
    kucoin kucoin KuCoin 2 API CCXT Certified
    kuna kuna Kuna 2 API
    lakebtc lakebtc LakeBTC 2 API
    latoken latoken Latoken 1 API
    lbank lbank LBank 1 API
    liquid liquid Liquid 2 API
    livecoin livecoin LiveCoin * API
    luno luno luno 1 API
    lykke lykke Lykke 1 API
    mandala mandala Mandala 1.1 API
    mercado mercado Mercado Bitcoin 3 API
    mixcoins mixcoins MixCoins 1 API
    negociecoins negociecoins NegocieCoins 3 API
    nova nova Novaexchange 2 API
    oceanex oceanex OceanEx 1 API
    okcoincny okcoincny OKCoin CNY 1 API
    okcoinusd okcoinusd OKCoin USD 1 API
    okex okex OKEX 1 API
    okex3 okex3 OKEX 3 API
    paymium paymium Paymium 1 API
    poloniex poloniex Poloniex * API CCXT Certified
    rightbtc rightbtc RightBTC * API
    southxchange southxchange SouthXchange * API
    stronghold stronghold Stronghold 1 API
    surbitcoin surbitcoin SurBitcoin 1 API
    theocean theocean The Ocean 1 API
    therock therock TheRockTrading 1 API
    tidebit tidebit TideBit 2 API
    tidex tidex Tidex 3 API
    upbit upbit Upbit 1 API CCXT Certified
    vaultoro vaultoro Vaultoro 1 API
    vbtc vbtc VBTC 1 API
    virwox virwox VirWoX * API
    xbtce xbtce xBTCe 1 API
    yobit yobit YoBit 3 API
    zaif zaif Zaif 1 API
    zb 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:

    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@1.18.1093/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!

    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]

    Crypto

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

    Thank you!

    Social

    Team

    Contact Us

    For business inquiries: info@ccxt.trade

    Keywords

    Install

    npm i bihao-ccxt

    Homepage

    ccxt.trade

    DownloadsWeekly Downloads

    5

    Version

    1.19.0

    License

    MIT

    Unpacked Size

    8.67 MB

    Total Files

    240

    Last publish

    Collaborators

    • landoyjx