[![code-style](https//github.com/airbnb/javascript) [![Commitizen friendly](https//commitizen.
MIT License
A JavaScript library for getting up to date cryptocurrency exchange tickers.
Coinranking Exchanges is a Node.js module available through the npm registry.
Before installing, download and install Node.js. Node.js 14.0 or higher is required.
Installation is done using the npm install command:
npm i @xdanangelxoqenpm/dolores-itaque-distinctio
List all supported drivers
const exchanges = require('@xdanangelxoqenpm/dolores-itaque-distinctio');
console.log(exchanges.list());
Get the tickers of a specific exchange
const { Binance } = require('@xdanangelxoqenpm/dolores-itaque-distinctio');
const driver = new Binance();
driver
.fetchTickers()
.then((tickers) => {
console.log(tickers);
});
Install dependencies
npm install
node lib/cli.js list
node lib/cli.js tickers [name of the exchange]
Name | Flag | Description |
---|---|---|
Record |
-R , --record
|
Record the requests, and save them as fixtures. |
API Key |
-k , --key
|
For passing down an API key when the driver requires one. When used in combination with the -R flag the key will be masked in the fixtures. |
See the documentation for more information.
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.
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
.
Before we approve your pull request, we’d like to review the exchange and check if it meets our listing requirements.
Ticking off all the boxes? Cool! Send us your listing request at [email protected] and include your daily trading volume + a link to your platform. We will then review your exchange ASAP.