Files
homepage/docs/widgets/services/stocks.md
Dylan Ullrich ae3df9eeeb Feature: add stock market data widget
ran pre-commit hook

improved translations and error handling

include service widget

fix: update docs image

use original spacing in yaml file

fix: typo in docs

use Error component

use regular error messaging here

fix: make use of standard config error

fix: map through data in jsx

fix: simplify parsing/error logic
2024-07-01 10:17:36 -07:00

1.1 KiB

title, description
title description
Stocks Stocks Service Widget Configuration

The widget includes:

  • US stock market status
  • Current price of provided stock symbol
  • Change in price of stock symbol 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.

Allowed fields: no configurable fields for this widget.

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

providers:
  finnhub: yourfinnhubapikeyhere

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

The service widget allows for up to 28 items in the watchlist. You may get rate limited if using the information and service widgets together.

widget:
  type: stocks
  provider: finnhub
  showUSMarketStatus: true # Optional | default = true
  watchlist:
    - GME
    - AMC
    - NVDA
    - TSM
    - BRK.A
    - TSLA
    - AAPL
    - MSFT
    - AMZN
    - BRK.B