Stonks Dashboard

Minimal real-time market dashboard for your terminal

---

Features

• Watchlist: Crypto, stocks, ETFs in one view
• Trend chart: Periods 1D, 7D, 30D, 90D
• Details panel: Key metrics (price, change, highs/lows)
• Caching & rate limits: Smooth updates with fewer API errors

Quick Start

npx stonks-dashboard

Or install globally:

npm install -g stonks-dashboard
stonks-dashboard

Local Development

git clone https://github.com/pierridotite/stonks-dashboard.git
cd stonks-dashboard
npm install
npm start

Controls

• ↑/↓: Navigate watchlist
• 1–4: Switch period (1D/7D/30D/90D)
• q or Ctrl+C: Quit

Configuration

Edit config.json to customize:

{
  "tickers": ["BTC", "ETH", "AAPL", "TSLA"],
  "cryptoIds": { "BTC": "bitcoin", "ETH": "ethereum" },
  "updateInterval": 120000
}

NOTE: Stocks on the London Stock Exchange can be added by appending .L (e.g. BARC.L), they will be displayed in pounds or pence depending on whether they are above £1

Data Sources

• Crypto: CoinGecko API
• Stocks/ETFs: Yahoo Finance API

Requests are rate-limited and cached (cache.json). Crypto details cache ~30 min; price series cache ~1 min.

Requirements

• Node.js (LTS recommended)

License

MIT - See LICENSE

Star History