https://github.com/thess/mmm-mktindex
MagicMirror module for displaying market indicies using (free) Yahoo Finance API
https://github.com/thess/mmm-mktindex
finance free magic-mirror-modules magicmirror2 yahoo-finance
Last synced: 8 days ago
JSON representation
MagicMirror module for displaying market indicies using (free) Yahoo Finance API
- Host: GitHub
- URL: https://github.com/thess/mmm-mktindex
- Owner: thess
- License: mit
- Created: 2020-05-16T23:19:32.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-10T21:08:14.000Z (5 months ago)
- Last Synced: 2025-04-25T04:03:18.162Z (29 days ago)
- Topics: finance, free, magic-mirror-modules, magicmirror2, yahoo-finance
- Language: JavaScript
- Homepage:
- Size: 53.7 KB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MMM-MktIndex
MagicMirror module for displaying market indicies using Yahoo Finance Quotes.
**Note:** Module currently assumes the US Eastern time-zone calculating market open times and locales.
## Screenshot
- `Example (Using defaults)`
## Installation
```shell
cd ~/MagicMirror/modules
git clone https://github.com/thess/MMM-MktIndex
cd MMM-MktIndex
npm install
```
After installation, you can use this simple test applet to verify that you can get results from the Yahoo Finance site.
```shell
node yf-test.js
```
## API Key
None required.
## Configuration
### Simple
```javascript
{
//disabled: true,
module: "MMM-MktIndex",
position: "top_right",
config: {
timeFormat: "YYYY-MM-DD HH:mm:ss"
}
},
```
### Details and Defaults Values
```javascript
{
module: "MMM-MktIndex",
position: "top_right",
config: {
timeFormat: "DD-MM HH:mm",
symbols: ["^DJI", "^IXIC", "^GSPC", "^TNX", "CL=F", "EURUSD=X"],
// Label name for each symbol. When you use `alias`, the number of symbols and aliases should be the same.
// If value is null or "", symbol string will be used by default.
alias: ["DOW 30", "Nasdaq", "S&P 500", "10yr Bond", "Crude Oil", "EUR/USD"],
updateInterval: 180, // Query interval in seconds
}
},
```