Mods: Added marketState/preMarketChange from 👍 node-yahoo-finance 👍 -3obby

MMM-JaST - Just another Stock Ticker

This is a minimalistic stock ticker based on Yahoo's finance API for the MagicMirror² platform.
Click here for the Magic Mirror Forum Thread.

Contribution welcome.

Support

If you like this module and want to thank, please rate this repository with a star or buy me a coffee :-)

Features

• Uses Yahoo Finance API to collect current
  • stock values
  • indexes
  • cryptocurrencies
• No API Key required
• Vertical or horizontal scrolling or static list
• Share Portfolio value and growth summary
• Very customizable
• Easy to use

Horizontal

Vertical

Static

Installing the Module

1. Navigate to the MagicMirror/modules directory and execute the following command

   git clone https://github.com/jalibu/MMM-Jast.git

2. Change into the MMM-Jast module folder and install runtime dependencies with

   cd MMM-Jast
   npm install --only=production

3. Add the module configuration into the MagicMirror/config/config.js file (sample configuration):

   {
   	module: "MMM-Jast",
   	position: "top_left",
   	config: {
   		maxWidth: "100%",
   		updateIntervalInSeconds: 300,
   		fadeSpeedInSeconds: 3.5,
   		scroll: "vertical", // One of ["none", "vertical", "horizontal"]
   		useGrouping: false,
   		currencyStyle: "code", // One of ["code", "symbol", "name"]
   		lastUpdateFormat: "HH:mm",
   		showColors: true,
   		showCurrency: true,
   		showChangePercent: true,
   		showChangeValue: false,
   		showChangeValueCurrency: false,
   		showLastUpdate: false,
   		showPortfolioValue: false,
   		showPortfolioGrowthPercent: false,
   		showPortfolioGrowth: false,
   		numberDecimalsValues: 2,
   		numberDecimalsPercentages: 1,
   		virtualHorizontalMultiplier: 2,
   		stocks: [
   			{ name: "BASF", symbol: "BAS.DE", quantity: 10 },
   			{ name: "SAP", symbol: "SAP.DE", quantity: 15 },
   			{ name: "Henkel", symbol: "HEN3.DE" },
   			{ name: "Alibaba", symbol: "BABA"}
   		],
    	//custom:
    	getStockmarketState: true;
   	}
   }

Options

Field	Description	Default
updateIntervalInSeconds	(Integer) Interval to refresh stock data from server. (min. 120)	300
fadeSpeedInSeconds	(Integer) Animation speed for ticker.	3.5
stocks	(Array) Array of stocks to be displayed	Sample set
scroll	(String) Animation direction for ticker. Values: none, vertical or horizontal	"vertical"
lastUpdateFormat	(String) Define dateformat, if the last update should be displayed	"HH:mm"
maxWidth	(String) CSS style to limit ticker width for vertical styles	"100%"
numberDecimalsValues	(Number) Number of decimals for stock values	2
numberDecimalsPercentages	(Number) Number of decimals for percentages	1
currencyStyle	(String) Style of currency. Possible values: "code" (EUR), "symbol" (€), "name" (Euro)	"code"
showColors	(Boolean) Colorize positive numbers in green, negatives in red	true
showCurrency	(Boolean) Show stocks currency	true
showChangePercent	(Boolean) Show stocks change against last close in percent	true
showChangeValue	(Boolean) Show stocks change against last close in absolute value	false
showChangeValueCurrency	(Boolean) Show currency for change value	false
showLastUpdate	(Boolean) Show when the data was updated	false
showPortfolioValue	(Boolean) Show portfolio value	false
showPortfolioGrowth	(Boolean) Show portfolio value growth summary	false
showPortfolioGrowthPercent	(Boolean) Show portfolio value growth summary in percent	false
useGrouping	(Boolean) Add grouping to high value numbers (i.e. BTC 60,000.00 EUR)	false
virtualHorizontalMultiplier	(Number) Virtually repeats the stocklist in horizontal mode to avoid whitespaces	2

custom

getStockmarketState | (String) Shows current market state | true | getPreMarketChangePercent | (String) Shows pre-market change in percent | true |

Stock Object

Field	Description	Example
symbol	(String) Stock's symbol/key	"BABA"
name	(String) Optional: Stock's display name	"Alibaba"
quantity	(Number) Optional: To calculate portfolio value and growth	500

Where the hack do I get the symbol for my favorite stocks?!

The easiest way to get the symbol for your stock is to open finance.yahoo.com and use the search field on the top. You'll find the symbol either in the search preview or in the result page's URL (i.e. https://finance.yahoo.com/quote/BMW.DE?p=BMW.DE where BMW.DE would be the symbol).

Contribution and Development

This module is written in TypeScript and compiled with Rollup.
The source files are located in the /src folder. Compile target files with npm run build.

Contribution for this module is welcome!