You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
Luke Childs 2683bb03ca Document update script 7 years ago
src Allow getting a property 7 years ago
test Test coins.get throws a TypeError on invalid property 7 years ago
update build => update 7 years ago
.gitignore Initial commit 7 years ago
.travis.yml Test against all currently maintained Node.js versions 7 years ago
LICENSE Initial commit 7 years ago
README.md Document update script 7 years ago
package.json build => update 7 years ago

README.md

coinlist

Comprehensive list of cryptocurrencies with metadata

Build Status Coverage Status npm

List compiled from the coinmarketcap.com API. Importable as a raw JSON file or an array with helper methods.

Install

yarn add coinlist

Usage

const coins = require('coinlist');

// coins is an array of coin objects:
[
  {
    id: 'bitcoin',
    symbol: 'BTC',
    name: 'Bitcoin',
    maxSupply: 21000000
  },
  {
    id: 'ethereum',
    symbol: 'ETH',
    name: 'Ethereum',
    maxSupply: null
  },
  ...
]

// There is a useful helper method to search the array for a ticker symbol:
const btc = coins.get('BTC');
{
  id: 'bitcoin',
  symbol: 'BTC',
  name: 'Bitcoin',
  maxSupply: 21000000
}

// Or get a specific property
coins.get('BTC', 'name');
// "Bitcoin"
coins.get('BTC', 'maxSupply');
// 21000000

// You can still use all the usual array methods on coins:
coins.filter(coin => coin.maxSupply > 10000000000).map(coin => coin.name);
[
  'Ripple',
  'Cardano',
  ...
]

// Alternatively, you can load the raw JSON file:
const coinsJson = require('coinlist/src/coins.json');

Update

$ yarn update
Fetching data...
Written 1567 coins to src/coins.json
✨  Done in 0.52s.

License

MIT © Luke Childs