@orats/cli

ORATS options analytics CLI — institutional-grade IV, Greeks, volatility forecasts, and historical data.

Setup

1. Install the CLI

npm install -g @orats/cli

2. Install skills for Claude Code

This installs ORATS domain knowledge (field definitions, methodology, signal interpretation) so AI assistants can provide deeper context when working with ORATS data.

orats skills

3. Set your API token

Get your token at orats.com/docs, then:

export ORATS_TOKEN=<your-token>

To persist it, add the export to your shell profile (~/.zshrc, ~/.bashrc, etc.).

Usage

List available endpoints:

orats data --help

Quick examples:

# Real-time IV for a ticker
orats data live-summaries --ticker SPY --fields stockPrice,iv30d,iv60d,iv90d

# Filtered options chain (25–35 DTE, 30–70 delta)
orats data live-strikes --ticker AAPL --dte 25,35 --delta .30,.70

# Forecast vs implied (overpriced screener) — filter, sort, and cap, no external tools
orats data delayed-cores --fields ticker,iv30d,orFcst20d \
  --where 'iv30d/orFcst20d > 1.15' --sort '-(iv30d/orFcst20d)' --limit 5

Filtering, sorting, grouping, and projection are all built in — no jq or other external tools required. --where selects rows with a predicate, --sort orders by a field or expression, --unique-by keeps one row per group, --limit caps, and --fields/--filter-output pick or compute columns. All accept comparison, boolean, and arithmetic operators plus functions (abs, round, substr, …) — e.g. --filter-output 'expirDate,skew=vol75-vol25' adds a computed column.

Field lookup (no API token required):

orats glossary iv30d            # explain a specific field
orats glossary 'iv*'            # glob search — fields beginning with "iv"
orats data live-summaries --list-fields true       # all fields for an endpoint
orats data live-summaries --schema                 # JSON Schema dump

Output formats: toon (default for TTY), json (default when piped), yaml, csv, md, jsonl. Override with --format or use --csv true.