README.md

Exchanges 📉📈

A JavaScript library for getting up to date cryptocurrency exchange tickers.

Getting started

1. Node.js 12.13 or higher is required
2. Install using NPM

Installation

Coinranking Exchanges is a Node.js module available through the npm registry.

Before installing, download and install Node.js. Node.js 12.13 or higher is required.

Installation is done using the npm install command:

npm i @coinranking/exchanges

Usage

List all supported drivers

const exchanges = require('@coinranking/exchanges');

console.log(exchanges.list());

Get the tickers of a specific exchange

const exchanges = require('@coinranking/exchanges');

exchanges
  .tickers('binance')
  .then((tickers) => {
    console.log(tickers);
  })

Development

Getting started

Install dependencies

npm run install

Usage

List all supported drivers

npm run list

Get the tickers of a specific exchange

npm run tickers [name of the exchange]

Contributing

Bug reports and pull requests are welcome. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Adding an exchange

1. Add a new driver
2. Add a new fixture

Single API calls are highly preferred. When adding an exchange be aware of the base and quote. A driver should at least support base, quote, close and baseVolume or quoteVolume. And optionally open, high, low, ask, bid, baseName, baseReference, quoteName and quoteReference.

Conventions

1. Airbnb JavaScript Style Guide
2. Conventional commits

License

MIT