Skip to content

Added Currencylayer documentation #1333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 27, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions source/_components/sensor.currencylayer.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
layout: page
title: "Currencylayer"
description: "Instructions on integrating exchange rates from https://currencylayer.com/ within Home Assistant."
date: 2016-10-26 10:00
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Finance
logo: currencylayer.png
ha_iot_class: "Cloud Polling"
ha_release: 0.32
---


The `currencylayer` sensor will show you the current exchange rate from [Currencylayer](https://currencylayer.com/) that provides realtime exchange rates for [170 currencies](https://currencylayer.com/currencies). The free account is limited to only USD as a base currency, allows 1000 requests per month, and updates every hour.

Obtain your API key [here](https://currencylayer.com/product)

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 variables:

- **api_key** (*Required*): API Key from [Currencylayer](https://currencylayer.com/).
- **base** (*Optional*): The symbol of the base currency. Defaults to USD.
- **quote** (*Required*): The symbol(s) of the quote or target currencies.
Binary file added source/images/supported_brands/currencylayer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.