Command Reference¶

Use fq --help to see all commands, or fq <command> --help for detailed help on any command.

Market Data Commands¶

`quote`¶

Get current stock quotes with price, volume, and key metrics.

fq quote AAPL                  # Single symbol
fq quote AAPL MSFT GOOGL       # Multiple symbols
fq quote AAPL -o json          # JSON output
fq quote BTC-USD ETH-USD       # Crypto

Options:

-o, --format - Output format (table, json, csv)
-v, --verbose - Show more details

`chart`¶

View historical OHLCV data with interactive TUI.

fq chart AAPL                  # Default (1 month, 1 day interval)
fq chart AAPL -i 1d -r 6mo    # 6 months, daily bars
fq chart AAPL -i 5m -r 1d     # Intraday (5 minute)
fq chart AAPL -o csv          # Export as CSV

Options:

-i, --interval - 1m, 5m, 15m, 30m, 1h, 1d, 1wk, 1mo
-r, --range - 1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max
-o, --format - Output format

`stream`¶

Real-time price streaming via WebSocket.

fq stream AAPL TSLA NVDA       # Stream multiple symbols

Press Ctrl+C to stop.

`market`¶

Market summary including indices, futures, and crypto.

fq market                      # Display market summary
fq market -o json              # JSON output

`trending`¶

Trending symbols by region.

fq trending                    # Default US
fq trending --region ca        # Canada

`indices`¶

World market indices.

fq indices                     # All major indices
fq indices -o json             # JSON output

`sector`¶

Sector performance and companies.

fq sector technology           # Technology sector
fq sector healthcare           # Healthcare sector
fq sector --companies          # Show top companies in sector
fq sector energy --industries  # Show industries in sector

Available sectors: technology, financial-services, consumer-cyclical, communication-services, healthcare, industrials, consumer-defensive, energy, basic-materials, real-estate, utilities

Options:

--companies - Show top companies in the sector
--industries - Show industries within the sector
--all - Show all details

`screener`¶

Pre-built screeners for market analysis.

fq screener most-actives           # Most active symbols
fq screener day-gainers            # Top day gainers
fq screener day-losers             # Top day losers
fq screener growth-technology-stocks  # Growth tech stocks
fq screener most-shorted-stocks    # Most shorted stocks
fq screener -l 50                  # Limit to 50 results

Screener types:

Equity movers: most-actives, day-gainers, day-losers, most-shorted-stocks
Growth/Value: growth-technology-stocks, aggressive-small-caps, small-cap-gainers, undervalued-growth-stocks, undervalued-large-caps
Funds: top-mutual-funds, solid-large-growth-funds, solid-midcap-growth-funds, conservative-foreign-funds, high-yield-bond, portfolio-anchors

Options:

-l, --limit - Maximum number of results (default: 25)

Company Information Commands¶

`info`¶

Full company details: profile, stats, and financials.

fq info AAPL                   # Company info
fq info AAPL -o json           # JSON output

`profile`¶

Company description, sector, industry, and employee count.

fq profile AAPL                # Company profile

`financials`¶

Financial statements: income, balance sheet, and cash flow.

fq financials AAPL             # Latest financials
fq financials AAPL -o json     # JSON format

`earnings`¶

Earnings history and estimates.

fq earnings AAPL               # Earnings data

`news`¶

Recent company news.

fq news AAPL                   # Latest news
fq news AAPL -o json           # JSON format

`recommendations`¶

Analyst buy/hold/sell ratings.

fq recommendations AAPL        # Analyst recommendations

`holders`¶

Institutional and insider ownership.

fq holders AAPL                # Shareholding data

`edgar`¶

Interactive SEC EDGAR filings browser (TUI). Browse company filings by symbol or search across all filings.

EDGAR Email Required

SEC requires a contact email in the User-Agent header. Provide it once via --email or EDGAR_EMAIL and fq will persist it for future runs. If no email is set, fq prompts you to enter one.

# Set email (required by SEC)
export EDGAR_EMAIL="user@example.com"

# Open TUI ready to search
fq edgar                                   # Start with empty search prompt

# Or persist it once
fq edgar --email user@example.com

# Browse filings by company symbol
fq edgar AAPL                              # Browse all AAPL filings interactively

# Search across all filings from command line
fq edgar --search "artificial intelligence"  # Search all companies
fq edgar -s "climate risk" -f 10-K           # Search only 10-K filings
fq edgar -s "acquisition" --start-date 2024-01-01  # Date-filtered search

Interactive Controls:

↑/↓, j/k - Navigate filings
←/→ - Previous/next page (search mode only)
PgUp/PgDn, Ctrl+d/u - Page up/down within current page
Home/End, g/G - Jump to top/bottom of current page
Enter, o - Open filing in browser
f - Cycle filters (10-K → 10-Q → 8-K → 4 → S-1 → DEF 14A → 10-K/A → 10-Q/A → S-3 → 20-F → All)
r - Reset filter (show all filings)
/ - Search all filings (in-TUI search)
s - Search by symbol (switch to symbol mode)
q, Esc, Ctrl+C - Quit

Symbol Mode Features:

Browse ~1,000 recent filings for a company
Company metadata (name, CIK)
Color-coded form types (10-K green, 10-Q cyan, 8-K yellow)
Filing metadata: date, report date, size, accession number
Filter by form type interactively

Search Mode Features:

Full-text search across all SEC filings
Pagination support - navigate through thousands of results (←/→ or n/p keys)
Filter by form type (-f 10-K, -f 10-Q, etc.)
Date range filtering (--start-date, --end-date)
Interactive navigation of search results
Page indicator shows current page and total matches
Open any filing directly in browser

Options:

-s, --search - Full-text search query (omit for symbol mode)
-f, --form-type - Filter by form type (10-K, 10-Q, 8-K, 4, S-1, DEF 14A, etc.)
--start-date - Start date for search (YYYY-MM-DD, search mode only)
--end-date - End date for search (YYYY-MM-DD, search mode only)
-e, --email - Contact email for SEC User-Agent (or set EDGAR_EMAIL env var)

`facts`¶

Get XBRL company facts from SEC EDGAR.

EDGAR Email Required

SEC requires a contact email in the User-Agent header. Provide it once via --email or EDGAR_EMAIL and fq will persist it for future runs. If no email is set, fq prompts you to enter one.

# Set email (required by SEC)
export EDGAR_EMAIL="user@example.com"

# Or persist it once
fq facts --email user@example.com AAPL

fq facts AAPL                  # All key financial facts
fq facts AAPL --concept GrossProfit  # Specific concept
fq facts AAPL --unit USD       # Filter by unit
fq facts AAPL -o json          # JSON output

Options:

-c, --concept - Specific XBRL concept (e.g., "Revenue", "Assets", "NetIncomeLoss")
-u, --unit - Filter by unit (e.g., "USD", "shares")
-l, --limit - Max data points per concept (default: 10)
-o, --format - Output format (table, json, csv)

Common concepts: Revenue, GrossProfit, OperatingIncomeLoss, NetIncomeLoss, EarningsPerShareBasic, Assets, Liabilities, StockholdersEquity, CashAndCashEquivalentsAtCarryingValue

`transcript`¶

Earnings call transcripts.

fq transcript AAPL             # Latest transcript
fq transcript AAPL --quarter 2024-Q1  # Specific quarter

`grades`¶

Analyst upgrade/downgrade history.

fq grades AAPL                 # Rating changes

Technical Analysis Commands¶

`indicator`¶

Calculate 40+ technical indicators.

fq indicator AAPL                             # Interactive TUI (choose indicators)
fq indicator AAPL --indicator rsi:14          # RSI with period 14
fq indicator AAPL --indicator sma:20,50,200   # SMAs
fq indicator AAPL --indicator macd:12,26,9    # MACD
fq indicator AAPL --indicator bollinger:20,2  # Bollinger Bands

# Non-interactive with range/interval
fq indicator AAPL --indicator rsi:14 -i 1d -r 6mo
fq indicator AAPL --indicator sma:20,50,200 --no-tui -o csv

Available indicators: sma, ema, rsi, macd, bollinger, atr, stochastic, adx, obv, vwap, cci, williamsr, stochrsi, psar, supertrend, mfi, ichimoku, donchian

Options:

--indicator <INDICATOR> - Format: name:param1,param2,... (skips TUI)
-i, --interval - Candle interval (1m, 5m, 15m, 1h, 1d, 1wk, 1mo)
-r, --range - Historical range (1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max)
--no-tui - Skip interactive TUI (requires --indicator)
--latest - Show only the latest value
-o, --format - Output format (table, json, csv)

`backtest`¶

Test trading strategies with performance metrics. Supports custom strategies, presets, ensembles, portfolio mode, parameter optimization, walk-forward validation, and Monte Carlo simulation.

fq backtest AAPL                          # Interactive backtest TUI
fq backtest AAPL --preset swing           # Load swing trading preset into TUI
fq backtest AAPL --preset rsi --no-tui   # Run preset directly, skip TUI
fq backtest AAPL --json                   # Output JSON instead of TUI
fq backtest AAPL --preset trend --json    # JSON output with preset

Options:

-p, --preset - Load a preset strategy
--json - Output JSON result instead of launching TUI
--no-tui - Run directly without interactive TUI (requires --preset)

Available presets: swing, rsi, macd, bollinger, trend, ichimoku, volume, keltner, ema-momentum, day

Interactive TUI¶

The TUI walks through strategy configuration, runs the backtest, and displays results across multiple analysis tabs.

Welcome Screen:

Key	Action
`1` / `n`	New custom strategy
`2` / `p`	Load a preset
`3` / `s`	Open strategy builder (visual condition editor)
`4` / `c`	Compose ensemble from multiple strategies

Config Editor — adjust all parameters before running:

Key	Action
`↑/↓`, `j/k`	Navigate fields
`Tab` / `Shift+Tab`	Jump to next/previous section
`Enter`	Edit selected field
`Space`	Toggle boolean fields
`Left/Right`	Cycle enum values (interval, order type, rebalance mode, etc.)
`Ctrl+O`	Open optimizer configuration
`Ctrl+S`	Save current strategy as a user preset
`c`	Return to welcome screen
`q`	Confirm and run backtest

Strategy Builder — visual condition editor for entry/exit/regime:

Key	Action
`↑/↓`	Navigate conditions
`Left/Right`	Switch tabs (Entry / Exit / Short Entry / Short Exit / Regime / Scale-In / Scale-Out)
`a`	Add condition
`d`	Delete condition
`o`	Toggle AND/OR between conditions
`Enter`	Edit condition
`Space`	Cycle condition fields
`>` / `<`	Next / previous condition
`e`	Edit scale fraction (scale tabs only)
`t`	Cycle higher-timeframe (HTF) scope for current indicator
`q`	Back to config editor

Note

HTF scope is available for computed indicators (RSI, SMA, MACD, etc.). Price-action fields (close, open, high, low, volume, etc.) always stay on the base timeframe.

Optimizer Setup (Ctrl+O from config editor):

Key	Action
`↑/↓`	Navigate parameters
`Space`	Toggle parameter enabled/disabled
`Enter`	Edit field value (range start/end/step, metric, method)
`q`	Back to config editor

Search methods: Grid (exhaustive, parallel) or Bayesian/SAMBO (LHS init → Nadaraya-Watson surrogate → UCB acquisition)
Metrics: Sharpe Ratio, Total Return, Sortino Ratio, Calmar Ratio, Profit Factor, Win Rate, Min Drawdown
Walk-forward: toggle to enable in-sample/out-of-sample rolling validation

Results Tabs (post-backtest):

Key	Action
`←/→`, `h/l`	Switch tabs
`↑/↓`, `j/k`	Navigate within tab
`p`	Cycle chart view: Equity → Drawdown → Rolling Sharpe → Rolling Win Rate
`m`	Cycle periods view: Yearly → Monthly → Day of Week
`r`	Re-run with same config
`e`	Edit config and re-run
`q`	Quit

Available result tabs:

Tab	Description
Overview	Key metrics: return, Sharpe/Sortino/Calmar, drawdown, win rate, Kelly, trade counts
Charts	Equity curve, drawdown, rolling Sharpe, rolling win rate
Distribution	Trade return histogram, win/loss percentiles, largest win/loss
Trades	All executed trades with entry/exit prices, dates, duration, P&L
Signals	All generated signals with strength and triggering conditions
Monte Carlo	1,000-run simulation (p5/p25/p50/p75/p95) across 4 resampling methods
Periods	Breakdown by year, month, or day of week
Comparison	Strategy vs benchmark: alpha, beta, information ratio
Optimizer	Best params, convergence curve (Bayesian), walk-forward window results
Portfolio	Per-symbol equity curves, allocation history, portfolio-level metrics

Configuration Fields¶

Symbol & Time Series:

Symbol — Stock ticker (e.g., AAPL)
Interval — 1m, 5m, 15m, 30m, 1h, 1d, 1wk, 1mo, 3mo
Time Range — 1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max

Capital & Position Sizing:

Capital — Initial capital (default: $10,000)
Position Size — Fraction of capital per trade (0.0–1.0, default: 1.0)
Max Positions — Maximum concurrent open positions (0 = unlimited)
Bars / Year — Bars per calendar year for metric annualization (auto-set per interval)

Costs & Friction:

Cost Profile — Quick preset: Free, Realistic, Aggressive, Custom
Commission % — Percent commission per trade (default: 0.1%)
Flat Commission — Fixed fee per trade (default: $0)
Slippage % — Slippage applied on entry/exit (default: 0.1%)
Spread % — Bid-ask spread, half applied per side (default: 0%)
Transaction Tax % — One-time purchase tax, e.g. UK stamp duty (default: 0%)

Risk Management:

Allow Short — Enable short selling
Stop Loss — Global stop loss percent (overridden per-trade by bracket orders)
Take Profit — Global take profit percent (overridden per-trade by bracket orders)
Trailing Stop — Global trailing stop percent (overridden per-trade by bracket orders)
Min Signal % — Minimum signal strength threshold (0.0–1.0)
Close At End — Force-close open positions at the final bar (default: on)

Advanced:

Warmup Bars — Skip first N bars before generating signals
Risk-Free Rate — Annual risk-free rate for Sharpe/Sortino (default: 0%)
Reinvest Dividends — Automatically reinvest dividend income
Benchmark — Symbol to compare against (e.g., SPY) — enables Comparison tab

Entry Order Configuration:

Entry Order Type — Market, Limit Below, Stop Above, Stop-Limit Above
Entry Price Offset — Offset percent for limit/stop entry (e.g., 0.005 = 0.5%)
Entry Stop-Limit Gap — Gap above stop trigger for stop-limit orders
Entry Expiry Bars — Bars a pending order stays alive (None = GTC)
Entry Bracket SL/TP/Trail — Per-trade bracket overrides (long positions)

Short Order Configuration:

Short Order Type — Market, Limit Above, Stop Below
Short Price Offset — Offset percent for short limit/stop entry
Short Expiry Bars — Bars a pending short order stays alive
Short Bracket SL/TP/Trail — Per-trade bracket overrides (short positions)

Portfolio Mode:

Portfolio Symbols — Comma-separated extra symbols; primary symbol is always included
Rebalance Mode — Available Capital (each symbol uses position_size_pct of cash) or Equal Weight (split initial capital equally)
Max Allocation Per Symbol — Cap allocation to a single symbol (0 = no limit)

Condition Builder¶

Comparison types: Above, Below, Crosses Above, Crosses Below, Between, Equals

Condition groups:

Group	Purpose
Entry	All conditions must pass to open a long position
Exit	Any condition triggers long exit
Short Entry	Conditions to open a short position (requires Allow Short)
Short Exit	Conditions to close a short position
Regime Filter	Entry signals suppressed unless all regime conditions pass
Scale-In	Add to existing long position (pyramid); configurable fraction
Scale-Out	Partially exit existing long position; configurable fraction

Conditions are combined with AND/OR operators per condition (toggle with o). Each condition can compare an indicator against a fixed value or another indicator. HTF scope can be toggled with t for computed indicators.

Ensemble Strategy¶

Combine 2+ strategies with voting. In ensemble compose mode:

Key	Action
`h/l`	Adjust member weight by step
`w`	Type an exact weight for the focused member
`↑/↓`	Navigate members
`Enter`	Edit selected member's strategy

Voting modes:

Mode	Description
Weighted Majority	Entry if weighted vote share > 50%
Unanimous	Entry only if all members agree
Any Signal	Entry if any member signals
Strongest Signal	Entry from highest-strength member

Options & Dividends Commands¶

`options`¶

Interactive options chain explorer (TUI).

fq options AAPL                # Latest expiration
fq options AAPL --expiration 2024-12-20  # Specific date

`dividends`¶

Dividend payment history.

fq dividends AAPL              # Dividend history

`splits`¶

Stock split history.

fq splits AAPL                 # Stock splits

Utility Commands¶

`lookup`¶

Search for symbols by name or keyword.

fq lookup Apple                # Search by name
fq lookup --type etf           # Search by type

`hours`¶

Market hours and trading status.

fq hours                       # Check if markets open
fq hours NASDAQ                # Specific exchange

`currencies`¶

Currency list and exchange rates.

fq currencies                  # All currencies
fq currencies EUR              # Specific currency

`exchanges`¶

Supported stock exchanges.

fq exchanges                   # List all exchanges

`alerts`¶

Price alerts with desktop notifications.

# Open alerts TUI
fq alerts

# Add alerts
fq alerts add AAPL price-above:200
fq alerts add TSLA price-below:150
fq alerts add AAPL change-above:5      # 5%+ change
fq alerts add TSLA volume-spike:2.0    # 2x volume

# List alerts
fq alerts list

# Check alerts (one-time)
fq alerts check

# Watch continuously
fq alerts watch

# Install as system service
fq alerts service install
fq alerts service status

# Manage alerts
fq alerts toggle <id>          # Enable/disable
fq alerts remove <id>          # Delete
fq alerts clear                # Delete all

`dashboard`¶

Interactive market dashboard (TUI).

fq dashboard  # Launch dashboard

Keyboard shortcuts in dashboard:

j/k or arrow keys - Navigate
Enter - Select
q - Quit
r - Refresh
+/- - Add/remove from watchlist

Global Options¶

fq [OPTIONS] [COMMAND]

Options:
  -v, --verbose         Enable verbose logging
      --no-color        Disable colored output
  -h, --help            Print help
  -V, --version         Print version

Output Formats¶

All commands support multiple output formats:

fq quote AAPL -o table         # Pretty table (default)
fq quote AAPL -o json          # JSON
fq quote AAPL -o csv           # CSV (comma-separated)

Export to file:

fq chart AAPL -r 1y -o csv > aapl_2024.csv
fq quote AAPL -o json > aapl.json

Command Reference¶

Market Data Commands¶

quote¶

chart¶

stream¶

market¶

trending¶

indices¶

sector¶

screener¶

Company Information Commands¶

info¶

profile¶

financials¶

earnings¶

news¶

recommendations¶

holders¶

edgar¶

facts¶

transcript¶

grades¶

Technical Analysis Commands¶

indicator¶

backtest¶

Interactive TUI¶

Configuration Fields¶

Condition Builder¶

Ensemble Strategy¶

Options & Dividends Commands¶

options¶

dividends¶

splits¶

Utility Commands¶

lookup¶

hours¶

currencies¶

exchanges¶

alerts¶

dashboard¶

Global Options¶

Output Formats¶

`quote`¶

`chart`¶

`stream`¶

`market`¶

`trending`¶

`indices`¶

`sector`¶

`screener`¶

`info`¶

`profile`¶

`financials`¶

`earnings`¶

`news`¶

`recommendations`¶

`holders`¶

`edgar`¶

`facts`¶

`transcript`¶

`grades`¶

`indicator`¶

`backtest`¶

`options`¶

`dividends`¶

`splits`¶

`lookup`¶

`hours`¶

`currencies`¶

`exchanges`¶

`alerts`¶

`dashboard`¶