@invinite-org/invinite-data-cli

Command-line interface for the Invinite Data API — access company data, financial statements, SEC filings, institutional ownership, and more from your terminal.

Installation

From npm

npm install -g @invinite-org/invinite-data-cli

To update to the latest version:

npm update -g @invinite-org/invinite-data-cli

From source

git clone https://github.com/outraday-org/invinite-data-cli.git
cd invinite-data-cli
npm install
npm run build
npm link

Requires Node.js >= 20.

Authentication

The recommended way to authenticate is browser login:

invd login

The browser flow creates a revocable, 90-day Data API key and stores it in the OS keychain when available (with local CLI config as a fallback). The sign-in also appears in the web UI's Data API key settings. If you belong to multiple teams, choose one explicitly:

invd login --team <teamId>

To revoke the browser sign-in and remove the locally stored credential:

invd logout

Manual API keys remain supported. The active key is resolved in the following order:

1. Environment variable — INVINITE_DATA_API_KEY
2. Current directory .env file — INVINITE_DATA_API_KEY=...
3. OS keychain — via the optional keytar package
4. Stored config — set with the CLI

Set your API key

invd config set-key

You'll be prompted to enter your key (input is masked). Alternatively, export it as an environment variable:

export INVINITE_DATA_API_KEY=your-api-key

Because environment and .env values take precedence over stored credentials, invd logout will tell you to remove them manually when either is active.

AI Plugin

This repo includes plugins for AI coding tools that enable AI-powered financial data retrieval and analysis. Supports Claude Code, OpenCode, Codex, and Copilot.

Choose an integration

• Standalone skill: installs the Invinite workflow and CLI reference. It prefers MCP when connected and falls back to the local invd CLI.
• Standalone MCP connector: add https://data.invinite.com/t/<teamId>/mcp in Claude's connector settings, leave OAuth client ID/secret empty, and complete browser OAuth. This supplies tools but not the packaged research workflows.
• Claude plugin: bundles the skill, remote MCP connector, data agent, and research commands. During setup, enter the team ID shown in the team-pinned MCP URL in Invinite Data API settings; OAuth still uses Dynamic Client Registration and PKCE.

The team ID controls access, usage, and billing for MCP calls. CLI calls use the team selected by invd login --team <teamId> and do not inherit the plugin's connector setting.

Quick install

# Interactive — prompts for runtime and scope
npx @invinite-org/invinite-data-cli@latest plugin install

# Non-interactive examples
npx @invinite-org/invinite-data-cli@latest plugin install --claude --global
npx @invinite-org/invinite-data-cli@latest plugin install --claude --local
npx @invinite-org/invinite-data-cli@latest plugin install --opencode --global
npx @invinite-org/invinite-data-cli@latest plugin install --codex --global
npx @invinite-org/invinite-data-cli@latest plugin install --copilot --local
npx @invinite-org/invinite-data-cli@latest plugin install --all --global

Update

To update the plugin to the latest version, re-run the install command:

npx @invinite-org/invinite-data-cli@latest plugin install --claude --global
npx @invinite-org/invinite-data-cli@latest plugin install --all --global

Uninstall

npx @invinite-org/invinite-data-cli@latest plugin uninstall --claude --global
npx @invinite-org/invinite-data-cli@latest plugin uninstall --all --global

What gets installed

| Runtime | Skill | Agent | Command | |---------|-------|-------|---------| | Claude Code | skills/invinite-data-cli/SKILL.md | agents/invinite-data.md | commands/financial-research.md | | OpenCode | command/invinite-data-cli.md | agents/invinite-data.md | — | | Codex | skills/invinite-data-cli/SKILL.md | — | skills/invinite-financial-research/SKILL.md | | Copilot | skills/invinite-data-cli/SKILL.md | — | skills/invinite-financial-research/SKILL.md |

Alternative: Claude Code plugin directory

claude --plugin-dir /path/to/invinite-data-cli/claude-plugin

The Claude plugin also includes compare-companies, analyze-filing, and ownership-review. Its .mcp.json connects the team-pinned remote server automatically; use /mcp to complete OAuth or inspect connection status in Claude Code. In Claude web/Desktop, install the plugin through your organization's plugin marketplace, enter the team ID when prompted, and connect the bundled connector.

Usage examples

Use /financial-research for multi-step analysis:

/financial-research Compare Apple, Microsoft, and Google's profitability and growth over the last 3 years
/financial-research Who are the largest institutional holders of TSLA and what are recent ownership changes?
/financial-research Analyze risk factors from NVDA's latest 10-K filing

Or ask questions directly — the AI will auto-trigger the skill and delegate to the data agent as needed.

Note: The CLI must be installed and authenticated (see Authentication) for the plugin to work.

Global Options

These options are available on all data commands:

| Flag | Description | |------|-------------| | --json | Output raw JSON (pipe-friendly) | | --all | Auto-paginate through all results |

Commands

• login — Log in through your browser (--team <teamId> for multi-team users)
• logout — Revoke the current browser sign-in and clear local credentials
• config — Manage CLI configuration
• health — Check API health
• company — Company information
• financials — Financial statements
• metrics — Financial metrics, ratios, and growth
• segments — Segmented financials
• filings — SEC filings
• ownership — Institutional ownership
• insider-trades — Insider trading data
• ipos — IPO listings
• market — Market data
• metadata — API metadata
• ws — WebSocket streaming

config

Manage CLI configuration.

# Set API key (interactive, masked input)
invd config set-key

# Set custom API base URL
invd config set-url https://custom-api.example.com

# Show current configuration
invd config show

# Reset all configuration to defaults
invd config reset

health

Check API health status.

invd health

company

Company information, search, and corporate actions.

company list

List all available companies.

invd company list

company search

Search companies by ticker or name.

| Option | Description | Default | |--------|-------------|---------| | -q, --query <text> | Search query (required) | — | | -l, --limit <n> | Maximum results | 10 | | --offset <n> | Pagination offset | 0 |

invd company search -q "Apple"
invd company search -q MSFT --limit 5

company details

Fetch company details.

| Option | Description | |--------|-------------| | -i, --identifier <ticker> | Ticker symbol or CIK (required) |

invd company details -i AAPL

company dividends

Fetch stock dividends.

| Option | Description | Default | |--------|-------------|---------| | -i, --identifier <ticker> | Ticker symbol or CIK (required) | — | | --start-date <date> | Start date (YYYY-MM-DD) | — | | --end-date <date> | End date (YYYY-MM-DD) | — | | -s, --sort <dir> | Sort direction (asc / desc) | desc | | -l, --limit <n> | Maximum results | 40 | | --offset <n> | Pagination offset | 0 |

invd company dividends -i AAPL --start-date 2023-01-01

company fiscal-periods

Fetch available fiscal periods.

| Option | Description | Default | |--------|-------------|---------| | -i, --identifier <ticker> | Ticker symbol or CIK (required) | — | | -s, --sort <dir> | Sort direction (asc / desc) | desc | | -l, --limit <n> | Maximum results | 40 | | --offset <n> | Pagination offset | 0 |

invd company fiscal-periods -i MSFT

company splits

Fetch stock splits.

| Option | Description | Default | |--------|-------------|---------| | -i, --identifier <ticker> | Ticker symbol or CIK (required) | — | | -s, --sort <dir> | Sort direction (asc / desc) | desc | | -l, --limit <n> | Maximum results | 40 | | --offset <n> | Pagination offset | 0 |

invd company splits -i AAPL

financials

Financial statements — standardized and as-reported.

All statement commands share these options:

| Option | Description | Default | |--------|-------------|---------| | -i, --identifier <ticker> | Ticker symbol or CIK (required) | — | | -p, --period <type> | Fiscal period: quarterly, annual, ytd, ttm (required) | — | | -s, --sort <dir> | Sort direction (asc / desc) | desc | | -l, --limit <n> | Maximum results | 10 | | --offset <n> | Pagination offset | 0 | | --detailed | Include formula, accession number, HTML tag info | — | | --presentation | Return nested tree structure | — | | --as-reported | Use as-reported data instead of standardized | — | | --with-formula | Include formula info (only with --detailed) | — |

--detailed and --presentation are mutually exclusive.

financials income-statement

invd financials income-statement -i AAPL -p annual
invd financials income-statement -i AAPL -p quarterly --detailed
invd financials income-statement -i AAPL -p annual --presentation
invd financials income-statement -i AAPL -p annual --as-reported

financials balance-sheet

invd financials balance-sheet -i MSFT -p quarterly --limit 4

financials cash-flow

invd financials cash-flow -i GOOGL -p annual

financials snapshot

Fetch the latest complete financial snapshot. Uses comma-separated identifiers instead of a single identifier.

| Option | Description | Default | |--------|-------------|---------| | -i, --identifiers <tickers> | Comma-separated ticker symbols or CIKs (required) | — | | -p, --period <type> | Fiscal period (required) | — | | --calendar-year <year> | Filter by calendar year | — | | --calendar-quarter <q> | Filter by calendar quarter | — | | --detailed | Include detailed info | — | | --presentation | Return nested tree structure | — | | --as-reported | Use as-reported data | — |

invd financials snapshot -i AAPL,MSFT,GOOGL -p annual
invd financials snapshot -i AAPL -p quarterly --calendar-year 2024 --calendar-quarter 3

metrics

Financial metrics, ratios, and growth rates.

metrics ratios

Fetch financial ratios.

| Option | Description | Default | |--------|-------------|---------| | -i, --identifier <ticker> | Ticker symbol or CIK (required) | — | | -p, --period <type> | Fiscal period (required) | — | | --category <cat> | Filter: valuation, profitability, liquidity, solvency | — | | -s, --sort <dir> | Sort direction | desc | | -l, --limit <n> | Maximum results | 10 | | --offset <n> | Pagination offset | 0 |

invd metrics ratios -i AAPL -p annual --category profitability

metrics cagr

Fetch compound annual growth rate metrics.

| Option | Description | Default | |--------|-------------|---------| | -i, --identifier <ticker> | Ticker symbol or CIK (required) | — | | --period-years <years> | CAGR period: 3, 5, 10 | — | | -s, --sort <dir> | Sort direction | desc | | -l, --limit <n> | Maximum results | 10 | | --offset <n> | Pagination offset | 0 |

invd metrics cagr -i AAPL --period-years 5

metrics growth

Fetch growth metrics.

| Option | Description | Default | |--------|-------------|---------| | -i, --identifier <ticker> | Ticker symbol or CIK (required) | — | | -p, --period <type> | Fiscal period (required) | — | | --growth-type <type> | year_over_year or quarter_over_quarter | — | | -s, --sort <dir> | Sort direction | desc | | -l, --limit <n> | Maximum results | 10 | | --offset <n> | Pagination offset | 0 |

invd metrics growth -i MSFT -p quarterly --growth-type year_over_year

segments

Segmented financial data.

segments list

| Option | Description | Default | |--------|-------------|---------| | -i, --identifier <ticker> | Ticker symbol or CIK (required) | — | | -p, --period <type> | Fiscal period (required) | — | | --segment-id <id> | Filter by segment ID | — | | --detailed | Include detailed breakdown | — | | -s, --sort <dir> | Sort direction | desc | | -l, --limit <n> | Maximum results | 10 | | --offset <n> | Pagination offset | 0 |

invd segments list -i AAPL -p annual
invd segments list -i AAPL -p annual --detailed

filings

SEC filings data.

filings list

Fetch SEC filings for a company.

| Option | Description | Default | |--------|-------------|---------| | -i, --identifier <ticker> | Ticker symbol or CIK (required) | — | | --form-type <type> | Filter by form type (e.g., 10-K, 10-Q, 8-K) | — | | -s, --sort <dir> | Sort direction | desc | | -l, --limit <n> | Maximum results | 40 | | --offset <n> | Pagination offset | 0 |

invd filings list -i AAPL --form-type 10-K

filings search

Search SEC filings using natural language.

| Option | Description | |--------|-------------| | -r, --request <text> | Search query (required) | | -i, --identifier <ticker> | Filter by company | | --accession-number <num> | Filter by accession number |

invd filings search -r "revenue recognition policy changes" -i AAPL

filings sections

Fetch SEC filing sections.

| Option | Description | |--------|-------------| | -i, --identifier <ticker> | Ticker symbol or CIK (required) | | --form-type <type> | Form type: 10-Q, 10-K, 8-K (required) | | --section-id <id> | Filter by section ID | | --accession-number <num> | Filter by accession number | | --fiscal-year <year> | Filter by fiscal year | | --fiscal-quarter <q> | Filter by fiscal quarter |

invd filings sections -i AAPL --form-type 10-K --section-id risk_factors

filings form-types

List available SEC form types.

| Option | Description | |--------|-------------| | -i, --identifier <ticker> | Filter by company (optional) |

invd filings form-types
invd filings form-types -i AAPL

ownership

Institutional ownership data.

ownership holdings-by-investor

Fetch all holdings for an institutional investor.

| Option | Description | Default | |--------|-------------|---------| | --cik <cik> | Institution CIK (required) | — | | -s, --sort <dir> | Sort direction | desc | | -l, --limit <n> | Maximum results | 100 | | --offset <n> | Pagination offset | 0 |

invd ownership holdings-by-investor --cik 0001067983

ownership holdings-by-company

Fetch institutional holders of a company.

| Option | Description | Default | |--------|-------------|---------| | -i, --identifier <ticker> | Ticker symbol or CIK (required) | — | | --min-value <n> | Minimum holding value filter | — | | -s, --sort <dir> | Sort direction | desc | | -l, --limit <n> | Maximum results | 100 | | --offset <n> | Pagination offset | 0 |

invd ownership holdings-by-company -i AAPL --min-value 1000000

ownership transactions

Fetch institutional ownership transactions.

| Option | Description | Default | |--------|-------------|---------| | --cik <cik> | Institution CIK | — | | -i, --identifier <ticker> | Ticker symbol or CIK | — | | --start-date <date> | Start date (YYYY-MM-DD) | — | | --end-date <date> | End date (YYYY-MM-DD) | — | | --type <type> | Transaction type: new_buy, added, reduced, sold_out | — | | --calendar-year <year> | Filter by calendar year | — | | --calendar-quarter <q> | Filter by calendar quarter | — | | -s, --sort <dir> | Sort direction | desc | | -l, --limit <n> | Maximum results | 100 | | --offset <n> | Pagination offset | 0 |

invd ownership transactions -i AAPL --type new_buy
invd ownership transactions --cik 0001067983 --calendar-year 2024

ownership institutions

List institutional investors.

| Option | Description | Default | |--------|-------------|---------| | --ciks <ciks> | Comma-separated institution CIKs | — | | -s, --sort <dir> | Sort direction | asc | | -l, --limit <n> | Maximum results | 100 | | --offset <n> | Pagination offset | 0 |

invd ownership institutions
invd ownership institutions --ciks 0001067983,0001364742

insider-trades

Insider trading data.

insider-trades list

| Option | Description | Default | |--------|-------------|---------| | -i, --identifier <ticker> | Ticker symbol or CIK (required) | — | | --start-date <date> | Start date (YYYY-MM-DD) | — | | --end-date <date> | End date (YYYY-MM-DD) | — | | --acquired-disposed <ad> | A (acquisition) or D (disposition) | — | | -s, --sort <dir> | Sort direction | desc | | -l, --limit <n> | Maximum results | 100 | | --offset <n> | Pagination offset | 0 |

invd insider-trades list -i AAPL
invd insider-trades list -i TSLA --acquired-disposed D --limit 20

ipos

IPO listings.

ipos list

| Option | Description | Default | |--------|-------------|---------| | --start-date <date> | Start date (YYYY-MM-DD) | — | | --end-date <date> | End date (YYYY-MM-DD) | — | | -s, --sort <dir> | Sort direction | desc | | -l, --limit <n> | Maximum results | 100 | | --offset <n> | Pagination offset | 0 |

invd ipos list --start-date 2024-01-01 --end-date 2024-12-31

market

Market data.

market holidays

Fetch market holidays.

| Option | Description | Default | |--------|-------------|---------| | -s, --sort <dir> | Sort direction | asc | | -l, --limit <n> | Maximum results | 100 | | --offset <n> | Pagination offset | 0 |

invd market holidays

metadata

API metadata and available identifiers.

metadata metrics

List all available standardized financial metrics.

invd metadata metrics

metadata section-ids

List available section IDs for SEC filings.

invd metadata section-ids

ws

Real-time WebSocket streaming.

ws listen

Listen to real-time SEC filing notifications. Automatically reconnects on disconnection with exponential backoff.

invd ws listen

Press Ctrl+C to disconnect.

Output Formats

By default, data is displayed as formatted tables with aligned columns and number formatting.

# Default table output
invd company search -q Apple

# Raw JSON output (useful for piping to jq or other tools)
invd company search -q Apple --json

# Pipe to jq
invd financials income-statement -i AAPL -p annual --json | jq '.data[0]'

Financial statements with --presentation are displayed as indented trees showing the hierarchical structure of line items.

Pagination

Results are paginated by default. Use --limit and --offset to control pagination manually, or use --all to automatically fetch all pages:

# Get first 10 results (default)
invd company dividends -i AAPL

# Get results 20-30
invd company dividends -i AAPL --limit 10 --offset 20

# Fetch all results automatically
invd company dividends -i AAPL --all

Development

# Run in development mode (no build step)
npm run dev -- company search -q Apple

# Build
npm run build

# Run tests
npm test

# Lint
npm run lint

License

ISC