mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-31 07:16:47 +00:00
51 lines
1.3 KiB
Markdown
51 lines
1.3 KiB
Markdown
---
|
|
title: currencylayer
|
|
description: Instructions on integrating exchange rates from https://currencylayer.com/ within Home Assistant.
|
|
ha_category:
|
|
- Finance
|
|
ha_iot_class: Cloud Polling
|
|
ha_release: 0.32
|
|
ha_domain: currencylayer
|
|
ha_platforms:
|
|
- sensor
|
|
ha_integration_type: integration
|
|
---
|
|
|
|
The `currencylayer` sensor will show you the current exchange rate from [Currencylayer](https://currencylayer.com/) that provides real-time exchange rates for [170 currencies](https://currencylayer.com/currencies). The free account is limited to only USD as a base currency, allows 250 requests per month and updates daily.
|
|
|
|
## Setup
|
|
|
|
Obtain your API key from [here](https://currencylayer.com/product).
|
|
|
|
## Configuration
|
|
|
|
To enable this sensor, add the following lines to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
sensor:
|
|
- platform: currencylayer
|
|
api_key: YOUR_API_KEY
|
|
base: USD
|
|
quote:
|
|
- EUR
|
|
- INR
|
|
```
|
|
|
|
{% configuration %}
|
|
api_key:
|
|
description: "The API Key from [Currencylayer](https://currencylayer.com/)."
|
|
required: true
|
|
type: string
|
|
quote:
|
|
description: The symbol(s) of the quote or target currencies.
|
|
required: false
|
|
type: [string, list]
|
|
default: Exchange rate
|
|
base:
|
|
description: The symbol of the base currency.
|
|
required: false
|
|
type: string
|
|
default: USD
|
|
{% endconfiguration %}
|