metadata.yml

name: 💹 Stock prices
category: community
description: |
  This plugin displays the stock market price of a given company.
examples:
  default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stock.svg
authors:
  - lowlighter
supports:
  - user
  - organization
  - repository
scopes: []
inputs:

  plugin_stock:
    description: |
      Enable stock plugin
    type: boolean
    default: no
    extras:
      - metrics.npm.optional.d3
      - metrics.api.yahoo.finance

  plugin_stock_token:
    description: |
      Yahoo Finance token
    type: token
    default: ""

  plugin_stock_symbol:
    description: |
      Company stock symbol
    type: string
    default: ""
    example: MSFT

  plugin_stock_duration:
    description: |
      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
    values:
      - 1d
      - 5d
      - 1mo
      - 3mo
      - 6mo
      - 1y
      - 2y
      - 5y
      - 10y
      - ytd
      - max

  plugin_stock_interval:
    description: |
      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
    values:
      - 1m
      - 2m
      - 5m
      - 15m
      - 60m
      - 1d