Skip to content

Latest commit

 

History

History
34 lines (26 loc) · 1.38 KB

README.md

File metadata and controls

34 lines (26 loc) · 1.38 KB
Raw

Cryptocurrency widget

This is my attempt to keep track of my current cryptocurrency portfolio. This widget is going to display the following information:

  • Price of a coin in USD
  • Current value of a coin in USD
  • Current value of your entire portfolio in USD

How to use this widget

In order to use this widget, you will need to create a text file located in ~/.cryptoholdings.json This file will contain your holdings in various coins.

Example:

{
    "ark": { "ticker": "ARK", "round": 2, "holdings": 2.98099 },
    "bitcoin": { "ticker": "BTC", "round": 0, "holdings": 7, "cost_basis": 50000 },
    "litecoin": { "ticker": "LTC", "round": 2, "holdings": 5.41853337 }
}

What do those fields mean?

Field name Required? Description
ark yes Name of the coin
ticker yes How that coin is displayed by coinmarketcap's ticker api
round yes How many decimal places should be displayed
holdings yes How many coins do you have
cost_basis no What was your initial investment

The cost_basis was added to see whether or not you are currently making money

NOTE: This widget is getting its data from coinmarketcap and coin name must match id of a coin as reported by coinmarketcap. For list of all supported coins, please visit: https://api.coinmarketcap.com/v1/ticker/