coinrate

日本語の README は README(JP).md を確認してください

coinrate is a command-line tool that allows you to easily access detailed trading data and market transaction information of the entire cryptocurrency market right from your terminal. It enables access to a wide range of data, including real-time price fluctuations, market trends, and vital statistical information for each cryptocurrency.

This tool facilitates quick and efficient information gathering. It supports approximately 2400 different cryptocurrency assets, and you can search for any asset not displayed at the top by using the Ticker search.

Features

• Access to comprehensive market trading information for the entire cryptocurrency market
• Supports approximately 2,400 cryptocurrency assets (using the Coinlore API)
• Ticker search functionality

How to Use

Use npx to run coinrate:

npx coinrate

Prerequisites

Before installing coinrate, ensure that your system meets the following prerequisites:

• Node.js: You need to have Node.js installed on your system. The version required for coinrate is version 10.0.0 or higher. You can download and install Node.js from Node.js official website. Additionally, coinrate relies on the following Node.js packages, which will be installed automatically when you install the tool:

• axios (v1.6.2 or higher): Used for making HTTP requests to fetch cryptocurrency data.

• cli-table2 (v0.2.0 or higher): Utilized for rendering tables in the terminal.

• enquirer (v2.4.1 or higher): Employed for interactive command-line interfaces. No other specific software or libraries are required to run coinrate beyond what is listed here. Ensure that your Node.js environment is set up correctly to proceed with the installation.

Table Overview

The coinrate application provides a detailed table view of cryptocurrency data. Below is an overview of the information provided in each table row:

Market Overview Table

| Title | Description | | ------------------------- | ---------------------------------------------------------------------- | | Price Checked At | The time when the information was fetched. Format: YYYY/MM/DD HH:MM:SS | | Total Market Cap | Total market capitalization of all cryptocurrencies | | Market Cap Change (24h) | Market cap change rate of the entire market over the past 24 hours | | Total Volume | Total trading volume of all cryptocurrencies in the market | | Volume Change (24h) | Trading volume change rate of the market over the past 24 hours | | Bitcoin Market Dominance | The percentage of the total market cap represented by Bitcoin | | Ethereum Market Dominance | The percentage of the total market cap represented by Ethereum | | All-Time High Volume | The highest recorded trading volume in the entire crypto market | | All-Time High Market Cap | The highest recorded market capitalization in the crypto market |

Individual Cryptocurrency Table

| Title | Description | | ------------------ | ---------------------------------------------------------------------- | | Price Checked At | The time when the information was fetched. Format: YYYY/MM/DD HH:MM:SS | | Currency Name | Name of the cryptocurrency, e.g., Bitcoin | | Ticker Symbol | Market symbol of the cryptocurrency, e.g., BTC | | Market Cap Rank | Rank of the cryptocurrency based on market capitalization | | Price | Current price of the cryptocurrency. | | Price Change (1h) | Price change rate over the past 1 hour | | Price Change (24h) | Price change rate over the past 24 hours | | Price Change (7d) | Price change rate over the past 7 days | | Market Cap | Total market capitalization of the cryptocurrency | | Volume (24h) | Total trading volume of the cryptocurrency over the past 24 hours | | Circulating Supply | Total amount of the cryptocurrency currently in circulation | | Total Supply | Total amount of the cryptocurrency available |

Usage Examples

Getting an Overview of the Entire Market

Select Cryptocurrency Market Overview

Getting Information on Individual Cryptocurrencies

Select a ticker displayed at the top

Searching for Information by Ticker

Select Other (Ticker Search)

Customization

Changing the Design of Displayed Tables

For the tables,cli-table2is utilized. If you wish to modify the design, please refer to cli-table2 and make changes to the CryptoTable class (crypto_table.js).

Adding or Removing Default Displayed Tickers

To make changes, modify the cryptoChoices array in config/constants.js.

LICENSE

This software is released under the MIT License, see LICENSE.txt.