exchanges-integration

Financial Hub – CryptoCurrency eXchange Trading Library

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

Install · Usage

The Financial Hub 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+

Supported Cryptocurrency Exchange Markets

The Financial Hub library currently supports the following 124 cryptocurrency exchange markets and trading APIs:

logo	id	name	ver	doc	Country
	_1btcxe	1BTCXE	*	API	Panama
	acx	ACX	2	API	Australia
	adara	Adara	1	API	Malta
	allcoin	Allcoin	1	API	Canada
	anxpro	ANXPro	*	API	Japan, Singapore, Hong Kong, New Zealand
	bcex	BCEX	1	API	China, Canada
	bequant	Bequant	2	API	Malta
	bibox	Bibox	1	API	China, US, South Korea
	bigone	BigONE	3	API	China
	binance	Binance	*	API	Japan, Malta
	binanceje	Binance Jersey	*	API	Jersey
	binanceus	Binance US	*	API	US
	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
	bitmart	BitMart	2	API	US, China, Hong Kong, South Korea
	bitmax	BitMax	1	API	China
	bitmex	BitMEX	1	API	Seychelles
	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
	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
	bw	BW	1	API	China
	bytetrade	ByteTrade	*	API	Hong Kong
	cex	CEX.IO	*	API	UK, EU, Cyprus, Russia
	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
	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
	coinone	CoinOne	2	API	South Korea
	coinspot	CoinSpot	*	API	Australia
	coolcoin	CoolCoin	*	API	Hong Kong
	coss	COSS	1	API	Singapore, Netherlands
	crex24	CREX24	2	API	Estonia
	deribit	Deribit	1	API	Netherlands
	digifinex	DigiFinex	3	API	Singapore
	dsx	DSX	3	API	UK
	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
	ftx	FTX	*	API	Hong Kong
	fybse	FYB-SE	*	API	Sweden
	gateio	Gate.io	2	API	China
	gemini	Gemini	1	API	US
	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
	idex	IDEX	*	API	US
	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
	latoken	Latoken	1	API	Cayman Islands
	lbank	LBank	1	API	China
	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	2	API	Malta
	mercado	Mercado Bitcoin	3	API	Brazil
	mixcoins	MixCoins	1	API	UK, Hong Kong
	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
	stex	STEX	3	API	Estonia
	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
	timex	TimeX	1	API	Australia
	upbit	Upbit	1	API	South Korea
	vaultoro	Vaultoro	1	API	Switzerland
	vbtc	VBTC	1	API	Vietnam
	virwox	VirWoX	*	API	Austria, EU
	whitebit	WhiteBit	2	API	Estonia
	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 Financial Hub library is to use a package manager:

• Financial Hub in NPM (JavaScript / Node v7.6+)

git clone hhttps://github.com/guilherme-camacho/exchanges-integration.git

JavaScript (NPM)

JavaScript version of Financial Hub 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.

Financial Hub in NPM

npm install Financial Hub

const financialHub = require ('exchanges-integration');
console.log (financialHub.exchanges) // print all available exchanges

---

Documentation

Read the Manual for more details.

Usage

Intro

The Financial Hub 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.

// both of these notations work in JavaScript
exchange.methodName ()  // camelcase pseudocode
exchange.method_name () // underscore pseudocode

Read the Manual for more details.

JavaScript

'use strict';
const FinancialHub = require('exchanges-integration');
 
(async function () {
    let kraken    = new FinancialHub.kraken ()
    let bitfinex  = new FinancialHub.bitfinex ({ verbose: true })
    let huobipro  = new FinancialHub.huobipro ()
    let okcoinusd = new FinancialHub.okcoinusd ({
        apiKey: 'YOUR_PUBLIC_API_KEY',
        secret: 'YOUR_SECRET_PRIVATE_KEY',
    })
 
    const exchangeId = 'binance'
        , exchangeClass = FinancialHub[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' })
 
}) ();

Team

• Guilherme Camacho

Contact Us

For business inquiries: [e-mail]