Skip to content

Commit 9051f1d

Browse files
committed
Add Alpha Vantage sensor docs
1 parent d8891fd commit 9051f1d

File tree

3 files changed

+54
-1
lines changed

3 files changed

+54
-1
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
layout: page
3+
title: "Alpha Vantage"
4+
description: "Instructions how to setup Alpha Vantage within Home Assistant."
5+
date: 2017-12-02 12:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: alpha_vantage.png
11+
ha_category: Finance
12+
ha_iot_class: "Cloud Polling"
13+
featured: false
14+
ha_release: "0.60"
15+
---
16+
17+
The `alpha_vantage` sensor platform uses [Alpha Vantage](https://www.alphavantage.co) to monitor the stock market.
18+
19+
To enable the `yahoo_finance` platform, add the following lines to your `configuration.yaml` file:
20+
21+
```yaml
22+
# Example configuration.yaml entry
23+
sensor:
24+
- platform: alpha_vantage
25+
api_key: YOUR_API_KEY
26+
```
27+
28+
{% configuration %}
29+
api_key:
30+
description: "The API Key from [Alpha Vantage](https://www.alphavantage.co)."
31+
required: true
32+
type: string
33+
symbols:
34+
description: List of stock market symbols for given companies.
35+
required: false
36+
type: string, list
37+
default: GOOGL
38+
{% endconfiguration %}
39+
40+
## {% linkable_title Examples %}
41+
42+
In this section you find some real life examples of how to use this sensor.
43+
44+
### {% linkable_title Red Hat and Google %}
45+
46+
```yaml
47+
sensor:
48+
- platform: yahoo_finance
49+
symbols:
50+
- RHT
51+
- GOOGL
52+
```
53+

source/_components/sensor.yahoo_finance.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ha_release: 0.29
1515
---
1616

1717
<p class='note warning'>
18-
This sensor doesn't work anymore as [Yahoo!](https://yahoo.uservoice.com/forums/382977-finance/suggestions/32103877-yahoo-stock-quote-api-please-bring-back) decommissioned the service in early November 2017.
18+
This sensor doesn't work anymore as [Yahoo!](https://yahoo.uservoice.com/forums/382977-finance/suggestions/32103877-yahoo-stock-quote-api-please-bring-back) decommissioned the service in early November 2017. A repleacement is the [`alpha_vantage` sensor](/components/sensor.alpha_vantage/).
1919
</p>
2020

2121
The `yahoo_finance` platform uses [Yahoo Finance](https://finance.yahoo.com/) to monitor the stock market.
6.94 KB
Loading

0 commit comments

Comments
 (0)