A JavaScript / Python / PHP library for cryptocurrency trading and e-commerce with support for many bitcoin/ether/altcoin exchange markets and merchant APIs.
Tealstreet · 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.
These are the CCXT Python methods necessary to unify for the Python backend of Tealstreet to function. There are many helper functions not listed to support these primary methods. Further, this includes custom methods such as: switch_isolated, set_leverage, and switch_hedge_mode. ✔ indicates it's unified and tested.
| Exchange | fetch_balance | fetch_positions | fetch_orders | fetch_my_trades | create_order | cancel_order | cancel_all_orders | edit_order | fetch_markets | switch_isolated | set_leverage | switch_hedge_mode |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Binance | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| BitMEX | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| bybit | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| FTX | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| Phemex | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| OKEx | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| KuCoin | ||||||||||||
| Gate.io |
These are the CCXT Javascript methods necessary to unify for the frontend of Tealstreet to function. There are many helper functions not listed to support these primary methods. ✔ indicates it's unified and tested.
| Exchange | fetchOHLCV️ | fetchMarkets |
|---|---|---|
| Binance | ✔️ | ✔️ |
| BitMEX | ✔️ | ✔️ |
| bybit | ✔️ | ✔️ |
| FTX | ✔️ | ✔️ |
| Phemex | ✔️ | ✔️ |
| OKEx | ✔️ | ✔️ |
| KuCoin | ✔️ | ✔️ |
| Gate.io |
These are the necessary CCXT responses for Tealstreet to work.
individual coin keys...
free
total
used
free
total
used
collateral
contracts
datetime
entryPrice
hedged
id
info
initialMargin
initialMarginPercentage
isolated
leverage
liquidationPrice
maintenanceMargin
maintenanceMarginPercentage
marginRatio
marginType
markPrice
notional
percentage
pnl
price
side
status
symbol
timestamp
unrealizedPnl
amount
average
clientOrderId
close
cost
datetime
fee
fees
filled
id
info
lastTradeTimestamp
postOnly
price
reduce
remaining
side
status
stopPrice
symbol
timeInForce
timestamp
trades
type
info
timestamp
datetime
symbol
id
order
type
takerOrMaker
side
price
amount
cost
fee
symbol
tradeMode
symbol
marginType
Populate the following root .env file with non-IP bound API credentials.
PYTHONUNBUFFERED=
# BINANCE
mn_binance_key=
mn_binance_secret=
# BITMEX
mn_bitmex_key=
mn_bitmex_secret=
tn_bitmex_key=
tn_bitmex_secret=
# BYBIT
mn_bybit_key=
mn_bybit_secret=
mn_sub_bybit_key=
mn_sub_bybit_secret=
tn_bybit_key=
tn_bybit_secret=
# FTX
mn_ftx_key=
mn_ftx_secret=
mn_ftx_subaccount_name=
mnc_ftx_key=
mnc_ftx_secret=
mnc_ftx_subaccount_name=
# GATE.IO
mn_gateio_key=
mn_gateio_secret=
# KUCOIN
mn_kucoin_key=
mn_kucoin_secret=
tn_kucoin_key=
tn_kucoin_secret=
# PHEMEX
mn_phemex_key=
mn_phemex_secret=
tn_phemex_key=
tn_phemex_secret=
# OKEX
tn_okex_key=
tn_okex_secret=
tn_okex_password=
mn_okex_key=
mn_okex_secret=
mn_okex_password=
Python POST tests: \python\tealstreet_tests.py. These tests ensure the order create, edit, delete, and other functionality of the Tealstreet terminal is operational.
Python CCXT tests: \python\test
Python sandbox: \python\main.py
JavaScript sandbox: \run-tests-2.py
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 3, PHP 5.4+, and web browsers
TabTrader — trading on all exchanges in one app. Avaliable on Android and iOS.
AAX — trade bitcoin futures with fees as low as 0.02% and up to 100x leverage!
Freqtrade — leading opensource cryptocurrency algorithmic trading software!
BitcoinPoint — sell bitcoin via a network of over 18000 ATMs.
| logo | id | name | ver | doc | certified | pro |
|---|---|---|---|---|---|---|
 | aax | AAX | 2 | API |  |  |
 | binance | Binance | * | API | | |
 | binancecoinm | Binance COIN-M | * | API | | |
| binanceusdm | Binance USDⓈ-M | * | API | | |
 | bitvavo | Bitvavo | 2 | API | | |
 | bytetrade | ByteTrade | * | API | | |
 | currencycom | Currency.com | 1 | API | | |
 | ftx | FTX | * | API | | |
 | gopax | GOPAX | 1 | API | | |
 | idex | IDEX | 2 | API | | |
 | kraken | Kraken | 0 | API | | |
 | wavesexchange | Waves.Exchange | * | API | | |
 | xena | Xena Exchange | * | API | | |
 | zb | ZB | 1 | API | |
The CCXT library currently supports the following 115 cryptocurrency exchange markets and trading APIs:
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.
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 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:
You can also clone it into your project directory from ccxt GitHub repository:
git clone https://github.com/ccxt/ccxt.gitJavaScript 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.
npm install ccxtvarccxt=require('ccxt')console.log(ccxt.exchanges)// print all available exchangesAll-in-one browser bundle (dependencies included), served from a CDN of your choice:
- jsDelivr: https://cdn.jsdelivr.net/npm/ccxt@1.50.88/dist/ccxt.browser.js
- unpkg: https://unpkg.com/ccxt@1.50.88/dist/ccxt.browser.js
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.
<scripttype="text/javascript" src="https://cdn.jsdelivr.net/npm/ccxt@1.50.88/dist/ccxt.browser.js"></script>Creates a global ccxt object:
console.log(ccxt.exchanges)// print all available exchangespip install ccxtimportccxtprint(ccxt.exchanges) # print a list of all available exchange classesThe library supports concurrent asynchronous mode with asyncio and async/await in Python 3.5.3+
importccxt.async_supportasccxt# link against the asynchronous version of ccxtccxt 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 classesThe library supports concurrent asynchronous mode using tools from RecoilPHP and ReactPHP in PHP 7.1+. Read the Manual for more details.
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 ccxtYou 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.
Read the Manual for more details.
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/PHPexchange.methodName()// camelcase pseudocodeexchange.method_name()// underscore pseudocodeRead the Manual for more details.
'use strict';constccxt=require('ccxt');(asyncfunction(){letkraken=newccxt.kraken()letbitfinex=newccxt.bitfinex({verbose: true})lethuobipro=newccxt.huobipro()letokcoinusd=newccxt.okcoinusd({apiKey: 'YOUR_PUBLIC_API_KEY',secret: 'YOUR_SECRET_PRIVATE_KEY',})constexchangeId='binance',exchangeClass=ccxt[exchangeId],exchange=newexchangeClass({'apiKey': 'YOUR_API_KEY','secret': 'YOUR_SECRET',})console.log(kraken.id,awaitkraken.loadMarkets())console.log(bitfinex.id,awaitbitfinex.loadMarkets())console.log(huobipro.id,awaithuobipro.loadMarkets())console.log(kraken.id,awaitkraken.fetchOrderBook(kraken.symbols[0]))console.log(bitfinex.id,awaitbitfinex.fetchTicker('BTC/USD'))console.log(huobipro.id,awaithuobipro.fetchTrades('ETH/USDT'))console.log(okcoinusd.id,awaitokcoinusd.fetchBalance())// sell 1 BTC/USD for market price, sell a bitcoin for dollars immediatelyconsole.log(okcoinusd.id,awaitokcoinusd.createMarketSellOrder('BTC/USD',1))// buy 1 BTC/USD for $2500, you pay $2500 and receive ฿1 when the order is closedconsole.log(okcoinusd.id,awaitokcoinusd.createLimitBuyOrder('BTC/USD',1,2500.00))// pass/redefine custom exchange-specific order params: type, amount, price or whatever// use a custom order typebitfinex.createLimitSellOrder('BTC/USD',1,10,{'type': 'trailing-stop'})})();# coding=utf-8importccxthitbtc=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 nowprint(exmo.id, exmo.create_market_sell_order('BTC/USD', 1))
# limit buy BTC/EUR, you pay €2500 and receive ฿1 when the order is closedprint(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'})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 ฿ immediatelyvar_dump ($zaif->id, $zaif->create_market_sell_order ('BTC/JPY', 1));
// buy BTC/JPY, you receive ฿1 for ¥285000 when the order closesvar_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'));Please read the CONTRIBUTING document before making changes that you would like adopted in the code. Also, read the Manual for more details.
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!
Support this project by becoming a sponsor. Your logo will show up here with a link to your website.
Support this project by becoming a supporter. Your avatar will show up here with a link to your website.
Thank you to all our backers! [Become a backer]
Thank you!
For business inquiries: info@ccxt.trade