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_key

(string)(Required)

The API Key from Alpha Vantage.

symbols

(map)(Optional)

List of stock market symbols for given companies.

name

(string)(Optional)

The name of the sensor to use for the frontend.

currency

(string)(Optional)

The name of the sensor to use for the frontend.

Default value:

USD

symbol

(string)(Required)

The stock market symbol for the given company.

foreign_exchange

(map)(Optional)

List of currencies.

name

(string)(Optional)

The name of the sensor to use for the frontend.

from

(string)(Required)

The source currency.

to

(string)(Required)

The target currency.

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