home-assistant.io/source/_integrations/currencylayer.markdown
2024-11-27 18:57:16 +01:00

1.5 KiB

title description ha_category ha_iot_class ha_release ha_domain ha_platforms ha_integration_type related ha_quality_scale
currencylayer Instructions on integrating exchange rates from https://currencylayer.com/ within Home Assistant.
Finance
Cloud Polling 0.32 currencylayer
sensor
integration
docs title
/docs/configuration/ Configuration file
legacy

The currencylayer sensor will show you the current exchange rate from Currencylayer that provides real-time exchange rates for 170 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.

Configuration

To enable this sensor, add the following lines to your {% term "configuration.yaml" %} file. {% include integrations/restart_ha_after_config_inclusion.md %}

# 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." 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 %}