Giter Club home page Giter Club logo

mmm-jast's Introduction

MMM-JaST - Just another Stock Ticker

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

Support

If you like this module and want to thank, please buy me a beer.

Buy Me A Beer

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

Navigate to the MagicMirror subfolder MagicMirror/modules and execute the following command
git clone https://github.com/jalibu/MMM-Jast.git

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

cd MMM-Jast
npm i

To use this module, add it to the modules array in the MagicMirror/config/config.js file:

Sample

{
	module: "MMM-Jast",
	position: "top_left",
	config: {
		maxWidth: "100%",
		updateIntervalInSeconds: 300,
		fadeSpeedInSeconds: 3.5, // Higher value: vertical -> faster // horizontal -> slower
		scroll: "vertical", // One of ["none", "vertical", "horizontal"]
		useGrouping: false,
		currencyStyle: "code", // One of ["code", "symbol", "name"]
		showColors: true,
		showCurrency: true,
		showChangePercent: true,
		showChangeValue: false,
		showChangeValueCurrency: 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"}
		]
	}
}

Options

Field Description Default
updateIntervalInSeconds (Integer) Interval to refresh stock data from server. (min. 120) 300
fadeSpeedInSeconds (Integer) Animation speed for ticker. Higher value: vertical -> faster // horizontal -> slower 3.5
stocks (Array) Array of stocks to be displayed Sample set
scroll (String) Animation direction for ticker. Values: none, vertical or horizontal "vertical"
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
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

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).

mmm-jast's People

Contributors

jalibu avatar megaqube avatar hakanmhmd avatar gonz0s avatar srabraham avatar shweshi avatar zachk543 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.