Have ideas to improve npm?Join in the discussion! »

coinlist
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/coinlist package

1.1.3 • Public • Published

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 Coins

coinlist $ yarn update
Fetching latest currencies from the coinmarketcap.com API...
Written 1567 coins to src/coins.json
✨ Done in 0.52s.

Contributing

Pull requests are welcome to improve the code but please don't add currencies to coins.json directly. The JSON is automatically generated from the update script.

License

MIT © Luke Childs

Install

npm i [email protected]

Version

1.1.3

License

MIT

Unpacked Size

149 kB

Total Files

8

Last publish

Collaborators

  • avatar
  • avatar