jxm262 / xchange.js

Bitcoin and Altcoin exchange api aggregator / wrapper

xchange.js

Aggregates different Bitcoin exchanges api's into a convenient JS wrapper.

Documentation

Full Documentation Found Here

Motivation

Easily use all of the api's of every exchange in one single, simple to understand JavaScript module. Bitcoin exchanges api's are frequently updated, often missing documentation, and occasionally confusing. After writing lots of code to consume different api's, I realized the knowledge could/should be centralized into 1 module which addresses all of these pain-points. Thus, xchange.js was born.

Features

• Works both on the Client or Server
• Can use either Callbacks or Promises (es6)
• Currently supports 6 different exchanges (with more to come)
  • Bitfinex
  • Bitstamp
  • Coinbase
  • BTC-e
  • Kraken
  • OkCoin

Installation

npm install xchange.js

Code example

//Example print the spot price of BTC/USD from bitfinex  

import xchange from 'xchange.js';

  
xchange.bitfinex.ticker({symbol: 'BTCUSD'}, (err, response) => {
  if (!err) {
    console.log(response);
  }
});

Contributors

To help make xchange.js better please

• install Node & NPM
• clone the repo
• install dependencies

git clone https://github.com/jxm262/xchange.js.git
cd xchange.js
npm install

To keep with the latest news on xchange.js development feel free to participate in the mailing list

To run tests (using mocha chai)

npm test

License

MIT

Please refer to the LICENSE file for details.

About the Project

The end goal really is to wrap every api for all exchanges into this project. The current roadmap includes upgrading this to use authenticated api's, so users can perform actual transactions (buy, sell, etc..), and later to include more exchanges. The concept very much follows the motivation of the popular Java XChange library.

xchange.js's Issues

speed up babel transpilation

Compilation runs too slow, especially needed for tests. Look into compact mode or some other options to speed this up

add okcoin api

Add auth endpoints for coinbase

add bitstamp api

Add Yarn and lock file (also on travis)

Some of these dependencies are getting kinda hairy. Right now there's an issue with gulp-eslint , which i think may be related to some version combination of babel and gulp

add bitfinex apis

Add auth endpoints for bitfinex

Public mailing list

It would be cool to have access to a public mailing list without having to send a PM.

Update documentation

The documentation is way to minimal right now. Need to make something better (swagger? although i don't like swagger so maybe find a similar alternative?)

Update linter

Change linter from jshint to eslint (probably babel with airbnb standards)

Add full coinbase api

Going a different route with this project - need to add all the api's per exchange first. Then will roll the common api's into 1 singular easy to call thing (similar to the current btc ticker api that the project now has)

Contact and troubleshoot Kraken - "pair" parameter not working

example endpoint - /0/public/AssetPairs

what's the correct way to filter the pair?
{
"pair": ["USDTZUSD", "XETHXXBT"]
}

Add kraken api

Almost done, but making a ticket for tracking

update remaining legacy exchanges

Final 4 legacy exchanges to be updated using new pattern. Need to include all unauthenticated apis , similar to the new stuff that's been added under /lib/exchanges/ directory

• btc38
• bter
• hitbtc
• ccex

Add BTC-e exchange

Need to add public api's for btc-e.

Can find docs here - https://btc-e.com/api/3/docs#main

only need to implement the 4 methods on these docs currently