bitcoin-stat

1.0.1 • Public • Published

Bitcoin Stat

About

Bitcoin Stat is a library that gives current statistics about bitcoin through my backend api that I made that recieves data from Coindesk, so essentially, this library is an api wrapper of my api that I made. All of the data comes completely from Coindesk and can be found here (https://www.coindesk.com/price/bitcoin).

Usage

First and foremost, install Bitcoin Stat using npm like so

$ npm i bitcoin-stat

Then, once you have done that, require it in your code

const bitcoin = require('bitcoin-stat')

The bitcoin constant will give you an object with (current) information on the following...

  • Current Price
  • 24 Hour Percent Change
  • Market Cap
  • 24 Hour Volume
  • 24 Hour Low
  • 24 Hour High
  • Net Change
  • 24 Hour Open
  • All Time High
  • Total Supply
  • 24 Hour Returns
  • YTD Returns
  • 30 Day Volatility
  • 24 Hour Transaction Count
  • 24 Hour Average Transaction Fee
  • 24 Hour Value Transacted
Here is a quick final example of how to use the library in all its glory.
const bitcoin = require('bitcoin-stat')

console.log(bitcoin)
//output shoule be something similar to this
/*
{
  price: '$43,265.21',
  '24h_change': '6.99',
  market_cap: '$812.40B',
  '24h_volume': '$40.86B',
  '24h_low': '$39,907.58',
  '24h_high': '$43,386.79',
  net_change: '$2,828.62',
  '24h_open': '$40,439.68',
  all_time_high: '$64,829.14',
  total_supply: '18.78M',
  '24h_returns': '6.99',
  ytd_returns: '48.82',
  '30d_volatility': '0.63',
  '24h_transaction_count': '249,454',
  '24h_average_transaction_fee': '$2.48',
  '24h_value_transacted': '$9.34B'
}
*/

console.log(bitcoin.price) //output - $43,265.21
console.log(bitcoin['24h_change']) //output - 6.99
console.log(bitcoin.market_cap) //output - $812.40B
console.log(bitcoin['24h_volume']) //output - $40.86B
console.log(bitcoin['24h_low']) //output - $39,907.58
console.log(bitcoin['24h_high']) //output - $43,386.79
console.log(bitcoin.net_change) //output - $2,828.62
console.log(bitcoin['24h_open']) //output - $40,439.68
console.log(bitcoin.all_time_high) //output - $64,829.14
console.log(bitcoin.total_supply) //output - 18.78M
console.log(bitcoin['24h_returns']) //output - 6.99
console.log(bitcoin.ytd_returns) //output - 48.82
console.log(bitcoin['30d_volatility']) //output - 0.63
console.log(bitcoin['24h_transaction_count']) //output - 249,454
console.log(bitcoin['24h_average_transaction_fee']) //output - $2.48
console.log(bitcoin['24h_value_transacted']) //output - $9.34B

Package Sidebar

Install

npm i bitcoin-stat

Weekly Downloads

0

Version

1.0.1

License

ISC

Unpacked Size

3.09 kB

Total Files

3

Last publish

Collaborators

  • mrslurpyboi