Alpha Vantage

The alpha_vantage sensor platform uses Alpha Vantage to monitor the stock market. This platform also provides detail about exchange rates.

To enable the alpha_vantage platform, add the following lines to your configuration.yaml file:

# Example configuration.yaml entry
sensor:
  - platform: alpha_vantage
    api_key: YOUR_API_KEY
    symbols:
      - symbol: GOOGL
        name: Google
    foreign_exchange:
      - name: USD_EUR
        from: USD
        to: EUR

Either a symbol or a foreign exchange must be configured, otherwise you will not get any data.

Configuration Variables

api_keystringRequired

The API Key from Alpha Vantage.

symbolsmap(Optional)

List of stock market symbols for given companies.

namestring(Optional)

The name of the sensor to use for the frontend.

currencystring(Optional, default: USD)

The name of the sensor to use for the frontend.

symbolstringRequired

The stock market symbol for the given company.

foreign_exchangemap(Optional)

List of currencies.

namestring(Optional)

The name of the sensor to use for the frontend.

fromstringRequired

The source currency.

tostringRequired

The target currency.

API Information

Alpha Vantage offers two tiers of the API key, one free and one paid for. If you are using the free version you will be limited to five queries per minute. This means that you’ll likely only be able to have one or two ticker entries. The paid version starts at thirty queries per minute increasing ticker quantity quite a bit.

Examples

In this section you find some real-life examples of how to use this sensor.

Google and the exchange rate for Bitcoin

sensor:
  - platform: alpha_vantage
    api_key: YOUR_API_KEY
    symbols:
      - name: Google
        currency: USD
        symbol: GOOGL
    foreign_exchange:
      - from: BTC
        to: USD
        name: Bitcoin