Skip to content

Latest commit

 

History

History
136 lines (128 loc) · 4.23 KB

README.md

File metadata and controls

136 lines (128 loc) · 4.23 KB
← Back to plugins index

💹 Stock prices

This plugin displays the stock market price of a given company.

Authors@lowlighter
Supported features
→ Full specification
📗 Classic template 📘 Repository template
👤 Users 👥 Organizations 📓 Repositories
🗝️ plugin_stock_token

➡️ Available options

OptionDescription

plugin_stock

Enable stock plugin

🌐 Web instances must configure settings.json:
  • metrics.npm.optional.chartist
  • metrics.api.yahoo.finance
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

  • 1d: Today
  • 5d: 5 days
  • 1mo: 1 month
  • 3mo: 3 months
  • 6mo: 6 months
  • 1y: 1 year
  • 2y: 2 years
  • 5y: 5 years
  • 10y: 10 years
  • ytd: Year to date
  • max: All time

This is relative to current date

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

plugin_stock_interval

Time interval between points

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

🗝️ Obtaining a RapidAPI Yahoo Finance token

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

RapidAPI token

ℹ️ 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