Skip to content

Easy-to-use CLI tool that is used to get simple details about crypto-currencies and digital assets

Notifications You must be signed in to change notification settings

codeHokage1/coindeets

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Coindeets - Crypto Details Tool

Coindeets is an easy-to-use CLI tool that is used to get simple details about crypto-currencies and digital assets. The tool can be downloaded here 🔗 : Coindeets

The tool works with an endpoint from the CoinMarket API 🔗 : https://coinmarketcap.com/api/

This means that each user would have to get an API key in order to use Coindeets. It is very simple and direct. Kindly follow this link 🔗 : https://coinmarketcap.com/api

Features:

  1. Coindeets provide real time simple details about cryptocurrencies and digital assests: Name, Symbol, Price, Rank
  2. The tool also provide information about one or more specific cryptocurrencies
  3. Users can also convert the price of assests to their currency of choice. See here to confirm the currencies accepted and their respective codes.
  • Sample Output:
Coin: BTC (Bitcoin) | Price: $17,188.73 | Rank: 1

How to use:

  1. Download the package (& use directly)
npx coindeets
  1. Run the tool directly or with the help option to see the full details of the application
npx coindeets -h
  1. Follow the commands outlisted below, as required.

Commands:

⚠️ N.B: If you would want to run the tool directly from your Command Line Interface, kindly add npx before any of these commands

  • #Help & Full Commands
coindeets -h

N.B: You can always add -h or --help to any command (including the ones below) to get more details

  • #API Key Management Commands
coindeets key set
coindeets key show
coindeets key remove
  • #Crypto Details Commands
coindeets check price [options]

The options are optional and can accept two key-value pairs: --coin and --curr. This allows to check details for one or more specific cryptocurrencies and to convert their fiat values to a specific currency, respectively. For example,

coindeets check price --coin=BTC
coindeets check price --coin=BTC,USDT,BNB
coindeets check price --curr=NGN 
coindeets check price --coin=BTC --curr=EUR

Without the options, the application will return the first 10 crypto assests, sorted by the official CoinMarketCap rank as at the time and in USD.

Technologies & Platforms used:

  1. Javascript (Node JS)
  2. Axios, Colors, Commander JS and Inquirer modules
  3. CoinMarkertCap API

Credits:

This project was inspired and done after a follow up study of the Traversy Media's "Node.js CLI For Cryptocurrency Prices" project video on Youtube

About

Easy-to-use CLI tool that is used to get simple details about crypto-currencies and digital assets

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published