Skip to content

Latest commit

 

History

History
48 lines (38 loc) · 1.34 KB

stocks.md

File metadata and controls

48 lines (38 loc) · 1.34 KB
title description
Stocks
Stocks Information Widget Configuration

(Find the Stocks service widget here)

The Stocks Information Widget allows you to include basic stock market data in your Homepage header. The widget includes the current price of a stock, and the change in price for the day.

Finnhub.io is currently the only supported provider for the stocks widget. You can sign up for a free api key at finnhub.io. You are encouraged to read finnhub.io's terms of service/privacy policy before signing up. The documentation for the endpoint that is utilized can be viewed here.

You must set finnhub as a provider in your settings.yaml like below:

providers:
  finnhub: yourfinnhubapikeyhere

Next, configure the stocks widget in your widgets.yaml:

The information widget allows for up to 8 items in the watchlist.

- stocks:
    provider: finnhub
    color: true # optional, defaults to true
    cache: 1 # optional, default caches results for 1 minute
    watchlist:
      - GME
      - AMC
      - NVDA
      - AMD
      - TSM
      - MSFT
      - AAPL
      - BRK.A

The above configuration would result in something like this:

Example of Stocks Widget