forked from home-assistant/home-assistant.io
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Alpha Vantage sensor docs (home-assistant#4122)
- Loading branch information
1 parent
b041d75
commit f1f9c2e
Showing
3 changed files
with
54 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
--- | ||
layout: page | ||
title: "Alpha Vantage" | ||
description: "Instructions how to setup Alpha Vantage within Home Assistant." | ||
date: 2017-12-02 12:00 | ||
sidebar: true | ||
comments: false | ||
sharing: true | ||
footer: true | ||
logo: alpha_vantage.png | ||
ha_category: Finance | ||
ha_iot_class: "Cloud Polling" | ||
featured: false | ||
ha_release: "0.60" | ||
--- | ||
|
||
The `alpha_vantage` sensor platform uses [Alpha Vantage](https://www.alphavantage.co) to monitor the stock market. | ||
|
||
To enable the `yahoo_finance` platform, add the following lines to your `configuration.yaml` file: | ||
|
||
```yaml | ||
# Example configuration.yaml entry | ||
sensor: | ||
- platform: alpha_vantage | ||
api_key: YOUR_API_KEY | ||
``` | ||
{% configuration %} | ||
api_key: | ||
description: "The API Key from [Alpha Vantage](https://www.alphavantage.co)." | ||
required: true | ||
type: string | ||
symbols: | ||
description: List of stock market symbols for given companies. | ||
required: false | ||
type: string, list | ||
default: GOOGL | ||
{% endconfiguration %} | ||
## {% linkable_title Examples %} | ||
In this section you find some real life examples of how to use this sensor. | ||
### {% linkable_title Red Hat and Google %} | ||
```yaml | ||
sensor: | ||
- platform: yahoo_finance | ||
symbols: | ||
- RHT | ||
- GOOGL | ||
``` | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.