coinlist-v3

    3.1.2 • Public • Published

    coinlist

    Comprehensive list of cryptocurrencies with metadata

    Build Status Coverage Status npm tippin.me

    List compiled from the coingecko.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'
      },
      {
        id: 'litecoin',
        symbol: 'LTC',
        name: 'Litecoin'
      },
      ...
    ]
    
    // There is a useful helper method to search the array for a ticker symbol:
    const btc = coins.get('BTC');
    {
      id: 1,
      symbol: 'BTC',
      name: 'Bitcoin'
    }
    
    // Or get a specific property
    coins.get('BTC', 'name');
    // "Bitcoin"
    
    // You can still use all the usual array methods on coins:
    coins.map(coin => coin.name);
    [
      'BTC',
      'LTC',
      ...
    ]
    
    // Alternatively, you can load the raw JSON file:
    const coinsJson = require('coinlist/src/coins.json');

    API

    coins

    An array of coin objects.

    coins.get(symbol, [property])

    Returns a coin object.

    Alternatively returns a coin property if the property argument is defined.

    If the symbol cannot be found it will return undefined.

    symbol

    Type: string

    The coin ticker symbol to search the array for.

    property

    Type: string

    A single coin property to return instead of the entire coin object.

    Valid properties are:

    • id The CoinGecko API id.
    • symbol The ticker symbol.
    • name The readable name.

    Update Coins

    $ yarn update
    Fetching latest currencies from the coingecko.com API...
    Written 2306 coins to src/coins.json
    

    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 coinlist-v3

    DownloadsWeekly Downloads

    7

    Version

    3.1.2

    License

    MIT

    Unpacked Size

    977 kB

    Total Files

    9

    Last publish

    Collaborators

    • josephroyking