Skip to content

stxkxs/mkt

BranchesTags

Repository files navigation

mkt

Real-time stock and crypto market dashboard for the terminal — single binary, no API keys.

Crypto prices stream live via Coinbase WebSocket. Stock quotes poll from Yahoo Finance. Watchlist with sparklines, candlestick/line charts with technical indicators, portfolio P&L tracking, macro dashboard, news feed, sector heatmap, and price alerts with desktop notifications. 7 color themes.

Built with Go, Bubbletea v2, and Lipgloss v2.

Installation

go install

go install github.com/stxkxs/mkt@latest

Build from source

Requires Go 1.25+ and Task (brew install go-task or go install github.com/go-task/task/v3/cmd/task@latest).

git clone https://github.com/stxkxs/mkt.git
cd mkt
task build    # or: go build -o mkt .
./mkt

Usage

mkt                             # launch TUI dashboard
mkt watch BTC-USD ETH-USD AAPL  # stream prices to stdout (no TUI)
mkt daemon                      # headless: hub + alerts + notifiers, no TUI
mkt mcp                         # Model Context Protocol server over stdio
mkt backtest rules.yaml replay.ndjson   # replay an alert ruleset against a recorded stream
mkt config show                 # view configuration
mkt config add TSLA LINK-USD    # add symbols to watchlist
mkt config remove DOGE-USD      # remove a symbol
mkt config set poll_interval 30s
mkt config validate             # check config for invalid values
mkt portfolio import --portfolio Tech schwab-export.csv   # import broker CSV
mkt position --equity 100000 --risk 1 --entry 50 --stop 48 # share-sizing calc
mkt version

Global flags (available on every subcommand):

  • --listen :9999 — start a read-only HTTP server exposing /quotes, /quotes/{symbol}, /alerts, /metrics, and /webhook/tradingview. Works in dashboard or daemon mode.
  • --listen-token <token> — require Authorization: Bearer <token> (or ?token=<token>) on every HTTP request. Set this whenever the bind address is non-loopback — without it, anyone reachable can hit the TradingView webhook and inject alerts. The server prints a startup warning when this combination is misconfigured.
  • Record a live quote stream for later backtesting: MKT_RECORD=session.ndjson mkt. Replay it: mkt backtest rules.yaml session.ndjson.

Import supports two CSV formats (auto-detected from the header):

  • generic — date,type,symbol,quantity,price,fee,note where type is buy|sell|dividend
  • schwab — Charles Schwab transaction export (Buy / Sell / Reinvest Dividend)

--dry-run parses and prints a summary without modifying the config; --format overrides auto-detect.

TUI Keybindings

Key Action
1–9 Jump to tab (Watch, Portfolio, Alerts, Chart, Macro, News, Heatmap, Options, Correl)
tab / shift+tab Cycle tabs
j / k Navigate rows
? Keybinding help for the active tab
enter Detail panel (watchlist) / open link (news) / drill down (heatmap)
s Cycle watchlist sort (config order → change% → volume → price)
c Full-screen chart for selected symbol
i Symbol info (watchlist) / toggle indicator menu on chart (1-9, a, p, v, k to toggle SMA/EMA/Bollinger/RSI/MACD/VWAP/OBV/ATR/Stoch/ADX/Pivots/VolProfile/Patterns)
O Load options chain for selected symbol (switches to Options tab)
: Open command palette (type a tab name, theme <name>, or q)
a Add selected symbol to comparison set
C Open multi-symbol comparison chart
[ / ] Change chart interval (1m → 1w) / switch portfolio
+ / - Zoom chart in/out
m Toggle candlestick / line chart
T Cycle color theme
esc Close panel / chart / go back
q Quit

Watchlist Tab

Live prices with 24h change, volume, and sparkline trend for each symbol. Crypto updates in real-time via WebSocket; stocks poll at a configurable interval (default 15s).

Portfolio Tab

Track holdings with live unrealized P&L across multiple thematic portfolios. Switch portfolios with [ / ]. Configure positions in ~/.config/mkt/config.yaml.

Alerts Tab

Set price alerts that fire desktop notifications:

alerts:
  - symbol: BTC-USD
    condition: above    # above, below, pct_up, pct_down, volume_above, stddev_above
    value: 100000
    enabled: true

volume_above triggers when the quote's reported volume exceeds the value. stddev_above triggers when the rolling standard deviation over period quotes exceeds value percent of the rolling mean — a volatility expansion proxy when full OHLC isn't available.

Alerts have a 5-minute cooldown to prevent spam. Toggle and delete alerts from the TUI.

Compound rules combine multiple conditions with match: all, match: any, or match: sequence (in declared order):

alerts:
  - symbol: BTC-USD
    enabled: true
    match: all                       # every sub-condition must fire
    conditions:
      - condition: above
        value: 100000
      - condition: rsi_above
        value: 70

  - symbol: ETH-USD
    enabled: true
    match: sequence                  # first crossed up, then dropped
    conditions:
      - condition: above
        value: 3500
      - condition: below
        value: 3300

Alerts can also POST a JSON payload to a webhook on every trigger — useful for Slack/Discord/IFTTT or any custom receiver. Set a default URL at the top level and/or override per rule:

webhook_url: https://hooks.slack.com/services/...   # default destination (optional)

alerts:
  - symbol: BTC-USD
    condition: above
    value: 100000
    enabled: true
    webhooks:                                       # per-rule override (optional)
      - https://discord.com/api/webhooks/...

The payload is {symbol, condition, value, price, message, timestamp}.

For mobile push, configure ntfy.sh (no signup) and/or Pushover (free dev account):

ntfy_topic: mkt-alerts-<your-unique-string>   # subscribe in the ntfy app
# ntfy_server: https://ntfy.sh                # optional override

pushover_user: u-...                          # your Pushover user key
pushover_token: a-...                         # your Pushover application token

Charts

Press c on any symbol for a full-screen candlestick or line chart. Press i to overlay technical indicators:

  • SMA(20) / EMA(20) — moving average lines on the price axis
  • Bollinger Bands — upper/middle/lower bands on the price axis
  • VWAP — anchored volume-weighted average price overlay on the price axis
  • RSI(14) — relative strength index in a sub-panel (0–100, ref lines at 30/70)
  • MACD(12,26,9) — MACD line, signal line, and histogram in a sub-panel
  • OBV — on-balance volume in a sub-panel (running signed-volume total)
  • ATR(14) — Wilder-smoothed Average True Range in a sub-panel
  • Stochastic(14,3) — %K and %D oscillator in a sub-panel (ref lines at 20/80)
  • ADX(14) — trend strength with +DI/-DI in a sub-panel (ref line at 25)
  • Pivots — classic floor-trader pivot lines (P, R1-R3, S1-S3) overlaid on the main chart from the prior session's HLC
  • Volume Profile — horizontal volume histogram in a right-side gutter; point-of-control row highlighted
  • Candle Patterns — Doji, Hammer, Shooting Star, Bullish/Bearish Engulfing marked with glyphs on the candlestick chart

Multiple indicators can be active simultaneously.

Comparison Chart

From the watchlist, press a on up to 3 symbols to add them to a comparison set, then C to open. Prices are normalized to % change from the first visible candle. Each symbol gets a distinct color.

Macro Dashboard

Fixed set of macro indicators updated on the same poll interval: 10Y Treasury, 13W T-Bill, VIX, Dollar (DXY), Gold, WTI Crude, S&P 500, and Bitcoin. Includes a computed 2s10s yield spread.

News Feed

Aggregated RSS headlines from Yahoo Finance, MarketWatch, and CNBC. Polls every 3 minutes. Press enter to open a headline in your browser.

Optionally, add SEC EDGAR per-ticker filings into the same feed via edgar_tickers in config:

edgar_tickers: [AAPL, NVDA, TSLA]

Filings appear with source SEC:<TICKER> and a category (8-K, 10-Q, etc.). Press f in the News tab to cycle the filter: All / News / Filings.

Sector Heatmap

Treemap overview of 18 sectors colored by average daily change (red → green gradient). Press enter to drill down into a sector and see individual stock tiles sorted by performance with price, change%, volume, and colored bars. Press esc to return to the overview.

Themes

Press T to cycle through 7 color themes: Tokyonight (default), Catppuccin Mocha, Gruvbox Dark, Nord, Dracula, Solarized Dark, and Catppuccin Latte (light). Theme choice persists in config.

Configuration

Config lives at ~/.config/mkt/config.yaml and is created with defaults on first run.

watchlist:
  - BTC-USD
  - ETH-USD
  - SOL-USD
  - AAPL
  - NVDA
portfolios: []
alerts: []
poll_interval: 15s
sparkline_len: 60
theme: tokyonight

Data Sources

Source Protocol Data Auth
Coinbase Advanced Trade WebSocket Real-time crypto prices, level-2 order book None
Coinbase Exchange REST Historical crypto candles, REST order-book snapshot None
Yahoo Finance REST (polling) Stock quotes, history, macro indicators, options chains, earnings calendar None (session cookies)
FRED (St. Louis Fed) REST (CSV) Economic series (DFF, T10Y2Y, UNRATE, CPIAUCSL, …) via FRED: prefix None
DeFiLlama REST Per-chain TVL None
Binance Futures REST Funding rate + open interest (BTC/ETH/SOL perps) None
Yahoo Finance / MarketWatch / CNBC RSS News headlines None
SEC EDGAR Atom (RSS) Per-ticker filings (8-K, 10-Q, 10-K) None

No API keys required. Crypto streams from Coinbase (US-native, no geo-restrictions). Stock data polls from Yahoo Finance.

Architecture

Quote providers (Coinbase WS, Yahoo HTTP, recording/replay)
        │
        ▼
   chan Quote (cap 128)
        │
        ▼
       Hub ─────► cache.Push()  (ring buffer per symbol)
        │  ─────► alertEngine.Check() ──► Notifiers (desktop, webhook, ntfy, Pushover, history)
        │                              ──► /metrics, /alerts on --listen
        ▼
  dispatchCh (cap 256, drops on TUI stall)
        │
        ▼
  program.Send(QuoteUpdateMsg)
        │
        ▼
  bubbletea Update() ──► route to tab views

Background pollers (each its own goroutine):
  Yahoo macro / earnings ──► MacroUpdateMsg, CalendarUpdateMsg
  Binance futures        ──► FuturesUpdateMsg
  DeFiLlama TVL          ──► TVLUpdateMsg
  RSS + SEC EDGAR        ──► NewsUpdateMsg
  Portfolio equity mark  ──► EquitySnapshotMsg

External integrations:
  --listen :9999          → /quotes, /quotes/{sym}, /alerts, /metrics, /webhook/tradingview
  mkt mcp (stdio)         → MCP tools/resources/prompts for Claude clients
  MKT_RECORD=path         → tee provider quotes to NDJSON (replay-able via mkt backtest)
  • Providers stream/poll quotes into a shared channel; Hub fans out behind a bounded dispatcher with drop-on-back-pressure semantics
  • Alert engine evaluates rules inline on each quote; notifiers run outside the lock with per-call timeouts and error isolation
  • Indicator package provides pure-math SMA, EMA, RSI, MACD, Bollinger, VWAP, OBV, ATR, Stochastic, ADX, Pivots, VolumeProfile, Patterns calculations
  • Portfolio package is stateless math: transactions → holdings, realized P&L (FIFO/LIFO/HIFO/Average), dividends, risk metrics (Sharpe, Sortino, Beta, MaxDD), correlation matrix, position sizing
  • Bubbletea serializes all UI updates — no mutexes in the TUI layer
  • Webhook receiver (/webhook/tradingview) injects TradingView alerts through the same notifier fan-out, bypassing rule evaluation

Project Layout

mkt/
├── main.go                        # cmd.Execute()
├── cmd/
│   ├── root.go                    # cobra root, --listen, --listen-token, version
│   ├── dashboard.go               # default cmd — wires providers + hub + TUI
│   ├── daemon.go                  # mkt daemon — headless hub + alerts + notifiers
│   ├── watch.go                   # mkt watch — non-TUI price streaming
│   ├── config.go                  # mkt config show/set/add/remove/validate
│   ├── portfolio.go               # mkt portfolio import (CSV)
│   ├── position.go                # mkt position — share-sizing calc
│   ├── backtest.go                # mkt backtest — replay rules against an NDJSON stream
│   └── mcp.go                     # mkt mcp — Model Context Protocol server over stdio
└── internal/
    ├── config/                    # viper load/save ~/.config/mkt/config.yaml
    ├── provider/
    │   ├── provider.go            # QuoteProvider, HistoryProvider interfaces
    │   ├── types.go               # Quote, OHLCV, Interval
    │   ├── coinbase/              # WebSocket streaming + REST history + L2 order book
    │   ├── yahoo/                 # HTTP polling + chart history + macro + options + earnings
    │   ├── fred/                  # FRED economic series via CSV endpoint
    │   ├── defillama/             # per-chain TVL
    │   ├── binance/               # futures funding rate + open interest
    │   ├── calendar/              # curated economic calendar + EarningsSource interface
    │   └── recording/             # NDJSON tee decorator + replay provider
    ├── market/
    │   ├── hub.go                 # aggregates providers, fan-out via callback, drop-on-stall
    │   ├── cache.go               # ring buffer per symbol for sparklines
    │   └── history.go             # multi-provider history routing
    ├── alert/                     # rule engine, conditions, cooldown, notifier fan-out (desktop/webhook/ntfy/Pushover/history)
    ├── portfolio/                 # stateless math: P&L, tax lots, dividends, equity curve, risk, correlation, sizing
    ├── indicator/                 # SMA, EMA, RSI, MACD, Bollinger, VWAP, OBV, ATR, Stoch, ADX, Pivots, VolProfile, Patterns
    ├── importer/                  # broker CSV formats (generic, Schwab) with header auto-detect
    ├── news/                      # RSS + SEC EDGAR feed parsing, browser URL opener
    ├── api/                       # --listen HTTP server (/quotes, /alerts, /metrics, /webhook/tradingview)
    ├── mcp/                       # JSON-RPC over stdio: tools, resources, prompts
    └── tui/
        ├── app.go                 # root model: tab switching, message routing, full-screen overlays
        ├── keys.go                # keybindings, tab types
        ├── messages.go            # TUI message types
        ├── theme/                 # color palette, 7 theme presets, panel renderer
        ├── watchlist/             # price table with sparklines
        ├── detail/                # expanded symbol info panel with live order book
        ├── chart/                 # candlestick/line charts, indicators, comparison, hover crosshair
        ├── portfolio/             # holdings table with live P&L, realized, dividends, equity sparkline
        ├── alerts/                # alert rule management
        ├── macro/                 # macro indicators, futures, TVL, upcoming events
        ├── news/                  # RSS news feed with EDGAR filings filter
        ├── heatmap/               # sector treemap with click-to-drill
        ├── options/               # options chain grid with max-pain
        ├── correlation/           # rolling-window correlation matrix
        ├── palette/               # command palette (jump-to-tab, theme switch)
        ├── alertdialog/           # modal for creating alerts from a symbol
        ├── symbolinfo/            # modal symbol info overlay
        ├── statusbar/             # connection status, theme name, help
        └── format/                # price/volume formatting utilities

License

MIT

About

Real-time stock & crypto market dashboard for the terminal — live prices, charts, portfolio P&L, and alerts. No API keys.

Topics

go cli golang finance real-time terminal crypto dashboard coinbase websocket tui market-data stocks bubbletea

Resources

Readme

License

MIT license

Contributing

Contributing
Activity

Stars

5 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages