If you like my work, please buy me a coffee or donate some crypto currencies. This will keep me awake, asleep, or whatever 😉
If you need more advanced features than this project offers, see Cryptoinfo Advanced
There are 2 ways to install cryptoinfo:
- Download 'cryptoinfo' from the HACS store
- Copy the files in the /custom_components/cryptoinfo/ folder to: [homeassistant]/config/custom_components/cryptoinfo/
The next step is to add cryptoinfo to your configuration.yaml. You can do that in 2 ways:
- Copy and paste the values from this configuration.yaml and adjust it according to your needs
- Copy and paste the values (and adjust according to your needs) from the configutation you see next
Example config:
sensor:
- platform: cryptoinfo
id: "main wallet" (optional, default = '') add some extra naming to the sensor
cryptocurrency_name: "ethereum" (default = "bitcoin")
currency_name: "eur" (default = "usd")
unit_of_measurement: "\u200b" (default = "$")
multiplier: 1 (default = 1) the currency value multiplied by this number
update_frequency: 15 (default = 60) number of minutes to refresh data of the sensor
For the complete list of supported values for 'cryptocurrency_name', visit this page: https://api.coingecko.com/api/v3/coins/list and copy / paste the "id" value to use as 'cryptocurrency_name'
For the complete list of supported values for 'currency_name', visit this page: https://api.coingecko.com/api/v3/simple/supported_vs_currencies and copy / paste the value to use as 'currency_name'
There are 9 important attributes:
- base_price This will return the price of 1 coin / token in 'currency_name'(default = "usd") of the 'cryptocurrency_name'(default = "bitcoin")
- 24h_volume This will return the 24 hour volume in 'currency_name'(default = "usd") of the 'cryptocurrency_name'(default = "bitcoin")
- 1h_change This will return the 1 hour change in percentage of the 'cryptocurrency_name'(default = "bitcoin")
- 24h_change This will return the 24 hour change in percentage of the 'cryptocurrency_name'(default = "bitcoin")
- 7d_change This will return the 7 day change in percentage of the 'cryptocurrency_name'(default = "bitcoin")
- 30d_change This will return the 30 day change in percentage of the 'cryptocurrency_name'(default = "bitcoin")
- market_cap This will return the total market cap of the 'cryptocurrency_name'(default = "bitcoin") displayed in 'currency_name'(default = "usd")
- circulating_supply This will return the circulating supply of the 'cryptocurrency_name'(default = "bitcoin")
- total_supply This will return the total supply of the 'cryptocurrency_name'(default = "bitcoin")
Example for usage of attributes. This example creates a new sensor with the attribute value '24h_volume' of the sensor 'sensor.cryptoinfo_main_wallet_ethereum_eur':
- platform: template
sensors:
cryptoinfo_main_wallet_ethereum_eur_24h_volume:
value_template: "{{ state_attr('sensor.cryptoinfo_main_wallet_ethereum_eur', '24h_volume') | float(0) | round(0) }}"
unit_of_measurement: "€"
If you want to know the total value of your cryptocurrencies, you could use this template as an example. This example combines the total value of 3 sensors into this 1 template sensor:
- platform: template
sensors:
crypto_total:
value_template: "{{
( states('sensor.cryptoinfo_main_wallet_ethereum_eur') | float(0) | round(2)) +
( states('sensor.cryptoinfo_bitcoin_eur') | float(0) | round(2)) +
( states('sensor.cryptoinfo_cardano_eur') | float(0) | round(2))
}}"
unit_of_measurement: '€'
friendly_name: Total value of all my cryptocurrencies
CoinGecko’s Public API has a rate limit of 5 to 15 calls per minute, depending on usage conditions worldwide.
If there are any problems, please create an issue in https://github.com/heyajohnny/cryptoinfo/issues If you want new functionality added, please create an issue with a description of the new functionality that you want in: https://github.com/heyajohnny/cryptoinfo/issues