home-assistant.github.io/source/_components/sensor.coinmarketcap.markdown
Richard Leurs 15c9617fdc Add documentation for display_currency setting to CoinMarketCap sensor (#3779)
* Add documentation for display_currency setting to CoinMarketCap sensor.

* Make example configuration simple again
2017-10-26 18:49:52 +02:00

30 lines
972 B
Markdown

---
layout: page
title: "CoinMarketCap"
description: "Instructions how to integrate CoinMarketCap data within Home Assistant."
date: 2016-08-31 08:15
sidebar: true
comments: false
sharing: true
footer: true
logo: coinmarketcap.png
ha_category: Finance
ha_release: 0.28
ha_iot_class: "Cloud Polling"
---
The `coinmarketcap` sensor platform displays various details about a cryptocurrency provided by [CoinMarketCap](http://coinmarketcap.com/).
To add the CoinMarketCap sensor to your installation, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
sensor:
- platform: coinmarketcap
```
Configuration variables:
- **currency** (*Optional*): The cryptocurrency to use, eg. `bitcoin`, `litecoin`, `steem`, etc. Default is `bitcoin`.
- **display_currency** (*Optional*): The currency to display, eg. `USD`, `EUR`, `GBP`, etc. Default is `USD`. All supported currencies can be found [here](https://coinmarketcap.com/api/).