Download the PHP package d-knafo/ccxt without Composer

CCXT – CryptoCurrency eXchange Trading Library

A JavaScript / Python / PHP library for cryptocurrency trading and e-commerce with support for many bitcoin/ether/altcoin exchange markets and merchant APIs.

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

See Also

•   Nomics API — enterprise-grade crypto market cap & pricing data API for your fund, smart contract, or app.

Certified Cryptocurrency Exchanges

logo	id	name	ver	doc	certified
	binance	Binance	*	API		Japan, Malta
	bitfinex	Bitfinex	1	API		British Virgin Islands
	bittrex	Bittrex	1.1	API		US
	coss	COSS	1	API		Singapore, Netherlands
	kraken	Kraken	0	API		US
	kucoin	KuCoin	2	API		Seychelles
	poloniex	Poloniex	*	API		US
	theocean	The Ocean	1	API		US
	upbit	Upbit	1	API		South Korea

Supported Cryptocurrency Exchange Markets

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

logo	id	name	ver	doc	certified
	_1btcxe	1BTCXE	*	API		Panama
	acx	ACX	2	API		Australia
	allcoin	Allcoin	1	API		Canada
	anxpro	ANXPro	*	API		Japan, Singapore, Hong Kong, New Zealand
	anybits	Anybits	*	API		Ireland
	bcex	BCEX	1	API		China, Canada
	bequant	Bequant	2	API		Malta
	bibox	Bibox	1	API		China, US, South Korea
	bigone	BigONE	2	API		UK
	binance	Binance	*	API		Japan, Malta
	binanceje	Binance Jersey	*	API		Jersey
	bit2c	Bit2C	*	API		Israel
	bitbank	bitbank	1	API		Japan
	bitbay	BitBay	*	API		Malta, EU
	bitfinex	Bitfinex	1	API		British Virgin Islands
	bitfinex2	Bitfinex	2	API		British Virgin Islands
	bitflyer	bitFlyer	1	API		Japan
	bitforex	Bitforex	1	API		China
	bithumb	Bithumb	*	API		South Korea
	bitkk	bitkk	1	API		China
	bitlish	Bitlish	1	API		UK, EU, Russia
	bitmarket	BitMarket	*	API		Poland, EU
	bitmex	BitMEX	1	API		Seychelles
	bitsane	Bitsane	*	API		Ireland
	bitso	Bitso	3	API		Mexico
	bitstamp	Bitstamp	2	API		UK
	bitstamp1	Bitstamp	1	API		UK
	bittrex	Bittrex	1.1	API		US
	bitz	Bit-Z	2	API		Hong Kong
	bl3p	BL3P	1	API		Netherlands, EU
	bleutrade	Bleutrade	2	API		Brazil
	braziliex	Braziliex	*	API		Brazil
	btcalpha	BTC-Alpha	1	API		US
	btcbox	BtcBox	1	API		Japan
	btcchina	BTCChina	1	API		China
	btcexchange	BTCExchange	*	API		Philippines
	btcmarkets	BTC Markets	*	API		Australia
	btctradeim	BtcTrade.im	*	API		Hong Kong
	btctradeua	BTC Trade UA	*	API		Ukraine
	btcturk	BTCTurk	*	API		Turkey
	buda	Buda	2	API		Argentina, Chile, Colombia, Peru
	bxinth	BX.in.th	*	API		Thailand
	cex	CEX.IO	*	API		UK, EU, Cyprus, Russia
	chbtc	CHBTC	1	API		China
	chilebit	ChileBit	1	API		Chile
	cobinhood	COBINHOOD	1	API		Taiwan
	coinbase	Coinbase	2	API		US
	coinbaseprime	Coinbase Prime	*	API		US
	coinbasepro	Coinbase Pro	*	API		US
	coincheck	coincheck	*	API		Japan, Indonesia
	coinegg	CoinEgg	*	API		China, UK
	coinex	CoinEx	1	API		China
	coinexchange	CoinExchange	*	API		India, Japan, South Korea, Vietnam, US
	coinfalcon	CoinFalcon	1	API		UK
	coinfloor	coinfloor	*	API		UK
	coingi	Coingi	*	API		Panama, Bulgaria, China, US
	coinmarketcap	CoinMarketCap	1	API		US
	coinmate	CoinMate	*	API		UK, Czech Republic, EU
	coinnest	coinnest	*	API		South Korea
	coinone	CoinOne	2	API		South Korea
	coinspot	CoinSpot	*	API		Australia
	cointiger	CoinTiger	1	API		China
	coolcoin	CoolCoin	*	API		Hong Kong
	coss	COSS	1	API		Singapore, Netherlands
	crex24	CREX24	2	API		Estonia
	crypton	Crypton	1	API		EU
	deribit	Deribit	1	API		Netherlands
	dsx	DSX	2	API		UK
	dx	DX.Exchange	1	API		UK, EU
	ethfinex	Ethfinex	1	API		British Virgin Islands
	exmo	EXMO	1	API		Spain, Russia
	exx	EXX	*	API		China
	fcoin	FCoin	2	API		China
	fcoinjp	FCoinJP	2	API		Japan
	flowbtc	flowBTC	1	API		Brazil
	foxbit	FoxBit	1	API		Brazil
	fybse	FYB-SE	*	API		Sweden
	fybsg	FYB-SG	*	API		Singapore
	gateio	Gate.io	2	API		China
	gdax	GDAX	*	API		US
	gemini	Gemini	1	API		US
	hadax	HADAX	1	API		China
	hitbtc	HitBTC	1	API		Hong Kong
	hitbtc2	HitBTC	2	API		Hong Kong
	huobipro	Huobi Pro	1	API		China
	huobiru	Huobi Russia	1	API		Russia
	ice3x	ICE3X	1	API		South Africa
	independentreserve	Independent Reserve	*	API		Australia, New Zealand
	indodax	INDODAX	1.8	API		Indonesia
	itbit	itBit	1	API		US
	kkex	KKEX	2	API		China, US, Japan
	kraken	Kraken	0	API		US
	kucoin	KuCoin	2	API		Seychelles
	kuna	Kuna	2	API		Ukraine
	lakebtc	LakeBTC	2	API		US
	lbank	LBank	1	API		China
	liqui	Liqui	3	API		Ukraine
	liquid	Liquid	2	API		Japan, China, Taiwan
	livecoin	LiveCoin	*	API		US, UK, Russia
	luno	luno	1	API		UK, Singapore, South Africa
	lykke	Lykke	1	API		Switzerland
	mandala	Mandala	1.1	API		Malta
	mercado	Mercado Bitcoin	3	API		Brazil
	mixcoins	MixCoins	1	API		UK, Hong Kong
	negociecoins	NegocieCoins	3	API		Brazil
	nova	Novaexchange	2	API		Tanzania
	oceanex	OceanEx	1	API		US
	okcoincny	OKCoin CNY	1	API		China
	okcoinusd	OKCoin USD	1	API		China, US
	okex	OKEX	1	API		China, US
	okex3	OKEX	3	API		China, US
	paymium	Paymium	1	API		France, EU
	poloniex	Poloniex	*	API		US
	rightbtc	RightBTC	*	API		United Arab Emirates
	southxchange	SouthXchange	*	API		Argentina
	stronghold	Stronghold	1	API
	surbitcoin	SurBitcoin	1	API		Venezuela
	theocean	The Ocean	1	API		US
	therock	TheRockTrading	1	API		Malta
	tidebit	TideBit	2	API		Hong Kong
	tidex	Tidex	3	API		UK
	upbit	Upbit	1	API		South Korea
	urdubit	UrduBit	1	API		Pakistan
	vaultoro	Vaultoro	1	API		Switzerland
	vbtc	VBTC	1	API		Vietnam
	virwox	VirWoX	*	API		Austria, EU
	xbtce	xBTCe	1	API		Russia
	yobit	YoBit	3	API		Russia
	zaif	Zaif	1	API		Japan
	zb	ZB	1	API		China

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:

• ccxt in NPM (JavaScript / Node v7.6+)
• ccxt in PyPI (Python 2 and 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:

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

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

JavaScript (for use with the <script> tag):

All-in-one browser bundle (dependencies included), served from a CDN of your choice:

• jsDelivr: https://cdn.jsdelivr.net/npm/[email protected]/dist/ccxt.browser.js
• unpkg: https://unpkg.com/[email protected]/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.

Creates a global ccxt object:

Python

ccxt in PyPI

The library supports concurrent asynchronous mode with asyncio and async/await in Python 3.5.3+

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

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

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.

Read the Manual for more details.

JavaScript

Python

PHP

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

Thank you!

Social

• Follow us on Twitter
• Read our blog on Medium

Team

• Igor Kroitor
• Vitaly Gordon
• Denis Voropaev
• Carlo Revelli

Contact Us

For business inquiries: [email protected]