Files
metrics/source/plugins/stock/README.md
2022-01-15 18:01:41 -05:00

2.7 KiB
Raw Blame History

💹 Stock prices

The stock plugin lets you display the stock market price of a given company.

💬 Obtaining a RapidAPI Yahoo Finance token

Create a RapidAPI account and subscribe to Yahoo Finance API to get a token.

RapidAPI token

➡️ Available options

TypeDescription
plugin_stock

Display stock prices of a given company

type: boolean
default: no
plugin_stock_token

Yahoo Finance token

🔐 Token
type: token
plugin_stock_symbol

Company stock symbol

type: string
plugin_stock_duration

Time range to display

type: string
default: 1d
allowed values:
  • 1d
  • 5d
  • 1mo
  • 3mo
  • 6mo
  • 1y
  • 2y
  • 5y
  • 10y
  • ytd
  • max
plugin_stock_interval

Time intervals between records

type: string
default: 5m
allowed values:
  • 1m
  • 2m
  • 5m
  • 15m
  • 60m
  • 1d

→ Full specification

Examples workflows

name: Stock prices from Tesla
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.stock.svg
  token: NOT_NEEDED
  base: ''
  plugin_stock: 'yes'
  plugin_stock_token: ${{ secrets.STOCK_TOKEN }}
  plugin_stock_symbol: TSLA