Skip to content

Commit

Permalink
Add Alpha Vantage sensor docs (#4122)
Browse files Browse the repository at this point in the history
  • Loading branch information
fabaff committed Dec 3, 2017
1 parent 796904f commit ffb89cd
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 1 deletion.
53 changes: 53 additions & 0 deletions source/_components/sensor.alpha_vantage.markdown
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
```

2 changes: 1 addition & 1 deletion source/_components/sensor.yahoo_finance.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ ha_release: 0.29
---

<p class='note warning'>
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.
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/).
</p>

The `yahoo_finance` platform uses [Yahoo Finance](https://finance.yahoo.com/) to monitor the stock market.
Expand Down
Binary file added source/images/supported_brands/alpha_vantage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ffb89cd

Please sign in to comment.