Repository files navigation

AJavaScript /Python /PHP /C# /Go library for cryptocurrency trading and e-commerce with support for many bitcoin/ether/altcoin exchange markets and merchant APIs.

TheCCXT 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 bycoders, 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+, netstandard2.0/2.1, Go 1.20+ and web browsers

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

logo	id	name	ver	type	certified	pro	discount
	binance	Binance
	binancecoinm	Binance COIN-M
	binanceusdm	Binance USDⓈ-M
	bingx	BingX
	bitget	Bitget
	bitmart	BitMart
	bitmex	BitMEX
	bybit	Bybit
	coinex	CoinEx
	cryptocom	Crypto.com
	gate	Gate.io
	hashkey	HashKey Global
	htx	HTX
	hyperliquid	Hyperliquid
	kucoin	KuCoin
	kucoinfutures	KuCoin Futures
	mexc	MEXC Global
	modetrade	Mode Trade
	okx	OKX
	woo	WOO X
	woofipro	WOOFI PRO

logo	id	name	ver	type	certified	pro
	alpaca	Alpaca
	apex	Apex
	ascendex	AscendEX
	bequant	Bequant
	bigone	BigONE
	binance	Binance
	binancecoinm	Binance COIN-M
	binanceus	Binance US
	binanceusdm	Binance USDⓈ-M
	bingx	BingX
	bit2c	Bit2C
	bitbank	bitbank
	bitbns	Bitbns
	bitfinex	Bitfinex
	bitflyer	bitFlyer
	bitget	Bitget
	bithumb	Bithumb
	bitmart	BitMart
	bitmex	BitMEX
	bitopro	BitoPro
	bitrue	Bitrue
	bitso	Bitso
	bitstamp	Bitstamp
	bitteam	BIT.TEAM
	bittrade	BitTrade
	bitvavo	Bitvavo
	blockchaincom	Blockchain.com
	blofin	BloFin
	btcalpha	BTC-Alpha
	btcbox	BtcBox
	btcmarkets	BTC Markets
	btcturk	BTCTurk
	bybit	Bybit
	cex	CEX.IO
	coinbase	Coinbase Advanced
	coinbaseexchange	Coinbase Exchange
	coinbaseinternational	Coinbase International
	coincatch	CoinCatch
	coincheck	coincheck
	coinex	CoinEx
	coinmate	CoinMate
	coinmetro	Coinmetro
	coinone	CoinOne
	coinsph	Coins.ph
	coinspot	CoinSpot
	cryptocom	Crypto.com
	cryptomus	Cryptomus
	defx	Defx X
	delta	Delta Exchange
	deribit	Deribit
	derive	derive
	digifinex	DigiFinex
	ellipx	Ellipx
	exmo	EXMO
	fmfwio	FMFW.io
	gate	Gate.io
	gemini	Gemini
	hashkey	HashKey Global
	hitbtc	HitBTC
	hollaex	HollaEx
	htx	HTX
	hyperliquid	Hyperliquid
	independentreserve	Independent Reserve
	indodax	INDODAX
	kraken	Kraken
	krakenfutures	Kraken Futures
	kucoin	KuCoin
	kucoinfutures	KuCoin Futures
	latoken	Latoken
	lbank	LBank
	luno	luno
	mercado	Mercado Bitcoin
	mexc	MEXC Global
	modetrade	Mode Trade
	myokx	MyOKX (EEA)
	ndax	NDAX
	novadax	NovaDAX
	oceanex	OceanEx
	okcoin	OKCoin
	okx	OKX
	okxus	OKX (US)
	onetrading	One Trading
	oxfun	OXFUN
	p2b	p2b
	paradex	Paradex
	paymium	Paymium
	phemex	Phemex
	poloniex	Poloniex
	probit	ProBit
	timex	TimeX
	tokocrypto	Tokocrypto
	tradeogre	tradeogre
	upbit	Upbit
	vertex	Vertex
	wavesexchange	Waves.Exchange
	whitebit	WhiteBit
	woo	WOO X
	woofipro	WOOFI PRO
	xt	XT
	yobit	YoBit
	zaif	Zaif
	zonda	Zonda

The list above is updated frequently, new crypto markets, exchanges, bug fixes, and API endpoints are introduced on a regular basis. See theManual 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 underMIT 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 inNPM (JavaScript / Node v7.6+)
• ccxt inPyPI (Python 3.7.0+)
• ccxt inPackagist/Composer (PHP 8.1+)
• ccxt inNuget (netstandard 2.0)
• ccxt inGO

This library is shipped as an all-in-one module implementation with minimalistic dependencies and requirements:

• js/ in JavaScript
• python/ in Python (generated from TS)
• php/ in PHP (generated from TS)
• cs/ in C# (generated from TS)
• go/ in Go (generated from TS)

You can also clone it into your project directory fromccxt GitHub repository:

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

JavaScript version of CCXT works in both Node and web browsers. Requires ES6 andasync/await syntax support (Node 7.6.0+). When compiling with Webpack and Babel, make sure it isnot excluded in yourbabel-loader config.

ccxt inNPM

npm install ccxt

//cjsvarccxt=require('ccxt')console.log(ccxt.exchanges)// print all available exchanges

//esmimport{version,exchanges}from'ccxt';console.log(version,Object.keys(exchanges));

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

• jsDelivr:https://cdn.jsdelivr.net/npm/ccxt@4.4.92/dist/ccxt.browser.min.js
• unpkg:https://unpkg.com/ccxt@4.4.92/dist/ccxt.browser.min.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@4.4.92/dist/ccxt.browser.min.js"></script>

Creates a globalccxt object:

console.log(ccxt.exchanges)// print all available exchanges

ccxt inPyPI

pip install ccxt

importccxtprint(ccxt.exchanges)# print a list of all available exchange classes

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

importccxt.async_supportasccxt# link against the asynchronous version of ccxt

CCXT also supportsorjson for parsing JSON since it is much faster than the builtin library. This is especially important when using websockets because some exchanges return big messages that need to be parsed and dispatched as quickly as possible.

However,orjson is not enabled by default because it is not supported by every python interpreter. If you want to opt-in, you just need to install it (pip install orjson) on your local environment. CCXT will detect the installion and pick it up automatically.

ccxt in PHP withPackagist/Composer (PHP 8.1+)

It requires common PHP modules:

• cURL
• mbstring (using UTF-8 is highly recommended)
• PCRE
• iconv
• gmp

include"ccxt.php";var_dump (\ccxt\Exchange::$exchanges);// print a list of all available exchange classes

The library supports concurrent asynchronous mode using tools fromReactPHP in PHP 8.1+. Read theManual for more details.

ccxt in C# withNuget (netstandard 2.0 and netstandard 2.1)

usingccxt;Console.WriteLine(ccxt.Exchanges)// check this later

ccxt in GO withPKG

go install github.com/ccxt/ccxt/go/v4@latest

import"ccxt"fmt.Println(ccxt.Exchanges)

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 theContributing document for the details on that).

Usingdocker-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.

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 and WebSocket APIs for all exchanges in TypeScript, JavaScript, PHP and Python.

The CCXT library supports both camelcase notation (preferred in TypeScript and 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 pseudocode

Read theManual for more details.

CCXT now supports ESM and CJS modules

// cjs example'use strict';constccxt=require('ccxt');(asyncfunction(){letkraken=newccxt.kraken()letbitfinex=newccxt.bitfinex({verbose:true})lethuobipro=newccxt.huobipro()letokcoinusd=newccxt.okcoin({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'})})();

//esm exampleimport{version,binance}from'ccxt';console.log(version);constexchange=newbinance();constticker=awaitexchange.fetchTicker('BTC/USDT');console.log(ticker);

# 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'));

usingccxt;// importing ccxtnamespaceProject;classProject{publicasyncstaticTaskCreateOrder(){varexchange=newBinance();exchange.apiKey="my api key";exchange.secret="my secret";// always use the capitalized method (CreateOrder instead of createOrder)varorder=awaitexchange.CreateOrder("BTC/USDT","limit","buy",1,50);Console.WriteLine("Placed Order, order id: "+order.id);}}

package mainimport ("github.com/ccxt/ccxt/go/v4/go""fmt")funcmain() {exchange:=ccxt.NewBinance(map[string]interface{}{"apiKey":"MY KEY","secret":"MY SECRET",})orderParams:=map[string]interface{}{"clientOrderId":"myOrderId68768678",}<-exchange.LoadMarkets()order,err:=exchange.CreateOrder("BTC/USDT","limit","buy",0.001,ccxt.WithCreateOrderPrice(6000),ccxt.WithCreateOrderParams(orderParams))iferr!=nil {ifccxtError,ok:=err.(*ccxt.Error);ok {ifccxtError.Type=="InvalidOrder" {fmt.Println("Invalid order")}else {fmt.Println("Some other error")}}}else {fmt.Println(*order.Id)}// fetching OHLCVohlcv,err:=exchange.FetchOHLCV("BTC/USDT",ccxt.WithFetchOHLCVTimeframe("5m"),ccxt.WithFetchOHLCVLimit(100))iferr!=nil {fmt.Println("Error: ",err)}else {fmt.Println("Got OHLCV!")}}

Unlike Javascript/Python/PHP/C# Go does not support "traditional" optional parameters likefunction a(optional = false). However, the CCXT language and structure have some methods with optional params, and since the Go language is transpiled from the Typescript source, we had to find a way of representing them.

We have decided to "go" (pun intended) with Option structs and theWithX methods.

For example, this functionFetchMyTrades supports 4 different "optional" parameters, symbol, since, limit, and params.

func (this*Binance)FetchMyTrades(options...FetchMyTradesOptions) ([]Trade,error)

And we can provide them by doing

trades,error:=exchange.FetchMyTrades(ccxt.withFetchMyTradesSymbol("BTC/USDT"),ccxt.WithFetchOHLCVLimit(5),ccxt.WithFetchMyTradesParams(orderParams))

Lastly, just because the signature dictates that some argument likesymbol is optional, it will depend from exchange to exchange and you might need to provide it to avoid getting aSymbolRequired error.

You can check different examples in theexamples/go folder.

Read the documentation for more information and details:docs

CCXT also provides a command-line interface (CLI) that enables direct interaction with any supported exchange from the terminal. You can quickly check balances, place orders, or fetch trade data—without the need to write or execute custom code. This is especially useful for simple or time-sensitive tasks that don’t warrant the overhead of building a full application.

The CLI is available as a npm package and can be installed by doing

npm i ccxt-cli -g

You can use the--help option to view a general overview of how the CLI works. The tool allows you to invoke any CCXT method by specifying the exchange id, the methodName, and any required arguments.

Examples:

ccxt binance createOrder BTC/USDT market buy 0.1 // places an order

If you are not sure which arguments should be provided you can always use theexplain command.

ccxt explain createOrder

result:

Method: createOrderUsage:  binance createOrder <symbol> <type> <side> <amount> [price] [params]Arguments:  - symbol       (required) — Market symbol e.g., BTC/USDT  - type         (required) — (no description available)  - side         (required) — order side e.g., buy or sell  - amount       (required) — (no description available)  - price        (optional) — Price per unit of asset e.g., 26000.50  - params       (optional) — Extra parameters for the exchange e.g., { "recvWindow": 5000 }

You can easily provide API keys by setting them as environment varibales eg:BINANCE_APIKEY="XXXX" or adding them to the config file located at$CACHE/config.json

Please read theCONTRIBUTING document before making changes that you would like adopted in the code. Also, read theManual 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.

[Become a sponsor]

Support this project by becoming a supporter. Your avatar will show up here with a link to your website.

[Become a supporter]

Thank you to all our backers! [Become a backer]

Thank you!

• Follow us on Twitter
• Read our blog on Medium
• Join our Discord
• CCXT Channel on Telegram (important announcements)
• CCXT Chat on Telegram (technical support)

CCXT is not a service nor a server. CCXT is a software.CCXT is a free open source non-custodian API broker software under MIT license.

• Non-custodian means CCXT is not an intermediary in trading, it does not hold traders' money at any point in time, traders install CCXT and use CCXT to talk to exchanges directly.
• MIT license means CCXT can be used for any purpose, but use at your own risk without any warranties.
• API broker means CCXT is funded with rebates from exchanges' API broker programs and it is an official API broker with many exchanges, all rebates and related fees are handled by the exchanges solely in accordance with exchanges' respective terms and conditions established by each partner exchange.
• Free software means CCXT is free to use and has no hidden fees, with CCXT traders pay the same trading fees they would pay to the exchanges directly.
• Open source means anyone is allowed to use it, to look inside the code and to change everything, including other brokers.

For business inquiries:info@ccxt.trade