@quantlogix/cli

The QuantLogix signal API from your terminal — 5-factor stock signals, multi-source news, and the engine's own verified track record.

A thin, zero-dependency wrapper over the public REST API at https://quantlogix.ai/api/v1/*. Authenticates with a ql_ API key.

Not investment advice. Signal labels (Strong Buy / Sell / conviction grades) are quantitative research output, not personalized recommendations or an offer to buy or sell any security. Markets carry risk; do your own diligence. Every command prints this disclaimer alongside its output.

Install

npm install -g @quantlogix/cli
# or run without installing:
npx @quantlogix/cli signal NVDA

Requires Node.js ≥ 18 (uses the built-in fetch).

Authenticate

Get a key from https://quantlogix.ai/profile → API Keys (a free key covers signal and news). Then either save it once:

quantlogix config set-key ql_xxxxxxxx     # → ~/.quantlogix/config.json (chmod 600)

…or pass it per-call / via env (CI-friendly):

export QUANTLOGIX_API_KEY=ql_xxxxxxxx
quantlogix signal NVDA --key ql_xxxxxxxx

Resolution order: --key › $QUANTLOGIX_API_KEY › ~/.quantlogix/config.json.

Commands

quantlogix signal <ticker>        Long-term 5-factor composite signal
quantlogix news <ticker>          Multi-source news + sentiment    (free tier)
quantlogix day <ticker>           Intraday QDTSS signal            (Institutional)
quantlogix swing <ticker>         Swing A–D conviction             (Institutional)
quantlogix micro <ticker>         Microstructure (VPIN/OFI/flow)   (Institutional)
quantlogix model-card [--window 365d]   Engine track record + validation grades
quantlogix institutional --ticker NVDA | --cik 0001067983   13F holders / fund

quantlogix screener [filters]     Screen the 5,000+ stock universe    (Pro)
quantlogix signals <T1> <T2> …    Batch signals, up to 50 tickers     (Pro)
quantlogix earnings <ticker>      Pre-earnings setup + implied move   (Institutional)
quantlogix companies [--sector ai] [--q x]        Private / pre-IPO companies (Pro)
quantlogix company <slug> [--financials|--news]   One company profile (Pro)
quantlogix investors [--type VC] [--q x]          Investor / fund directory (Pro)
quantlogix investor <slug>        One investor / fund profile         (Pro)

quantlogix config set-key <ql_...>   Save your API key
quantlogix config get                Show active key (masked) + base URL
quantlogix config path               Print the config file path

ql is a shorter alias for quantlogix.

Flags

| Flag | Meaning | |---|---| | --json, -j | Raw JSON to stdout (pipe to jq) | | --key <ql_...> | Override the API key for this call | | --api <url> | Override the API base (default https://quantlogix.ai) | | --help, -h | Help, or quantlogix help <command> | | --version, -v | Print version |

Examples

quantlogix signal NVDA
quantlogix news AAPL --json | jq -r '.[0].title'
quantlogix model-card --window 365d
quantlogix screener --signal "Strong Buy" --sector Technology --min-score 70
quantlogix signals NVDA AMD MU
quantlogix company anthropic --financials
QUANTLOGIX_API_KEY=ql_xxx ql swing TSLA

Screener filters: --signal, --sector, --cap mega|large|mid|small|micro, --min-score/--max-score, --min-price/--max-price, --min-market-cap/--max-market-cap, --min-change/--max-change, --sort score|change|market_cap|price, --order desc|asc, --limit, --offset. Use the --flag=value form for negative numbers (e.g. --min-change=-5).

Pretty output goes to stdout; the rate-limit footer and errors go to stderr, so --json | jq stays clean.

Exit codes

| Code | Meaning | |---|---| | 0 | Success | | 1 | Usage / network / runtime error | | 2 | The API authoritatively refused (401 auth, 402 tier-gated, 429 rate-limited) |

Programmatic use

The same client is exported for scripts that don't want to shell out:

import { apiGet } from '@quantlogix/cli';
const { data } = await apiGet('/api/v1/signal', { ticker: 'NVDA' });
console.log(data.composite_score);

Tier notes

Endpoints and rate limits are enforced server-side by your key's plan. Free keys cover signal + news (100 req/mo, 5 req/min); day/swing/micro require Institutional. A 402 with an upgrade link means the endpoint is above your tier. See the full matrix at https://quantlogix.ai/api-docs.

License

MIT © QuantLogix