edgar-cli

library0.1.4jsnpmunverified

edgar-cli v0.1.4 is an agent-friendly CLI for accessing SEC EDGAR filings and company facts, designed for Node.js (>=18) and usable via npx without requiring Python. It provides commands for resolving tickers, listing/getting filings, extracting XBRL facts, and performing research syncing/querying with deterministic caching profiles. The CLI enforces SEC identity requirements via --user-agent or EDGAR_USER_AGENT and outputs stable JSON envelopes for automation. It differentiates from other EDGAR tools by being npx-friendly, TypeScript-native, and offering research capabilities with configurable filing profiles.

devops http-networking data

npm install edgar-cli

github ↗package ↗

INSTALL

IMPORT

SIG · EDGAR-CLI

edgar-cli

devopsjavascriptv0.1.4

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

edgar-cli (binary)

✓ npx edgar-cli --help

✗ npm install -g edgar-cli && edgar-cli --help (global install not required, use npx)

Recommended usage is via npx; global install works but npx avoids version conflicts.

EDGAR_USER_AGENT

✓ export EDGAR_USER_AGENT='Your Name your.email@example.com'

✗ Setting EDGAR_USER_AGENT in .env file (CLI reads only from environment variable, not .env)

The CLI reads this environment variable at runtime; it is required for all SEC commands.

Demonstrates setting SEC identity and running resolve, filings list, and facts get commands.

export EDGAR_USER_AGENT='Example User user@example.com' npx edgar-cli resolve AAPL npx edgar-cli filings list --id AAPL --form 10-K --query-limit 2 npx edgar-cli facts get --id AAPL --taxonomy us-gaap --concept Revenues --latest

edgar --version

Debug

Known issues

gotchaSEC identity is required for all commands; missing EDGAR_USER_AGENT or --user-agent causes 'IDENTITY_REQUIRED' error.

fix

Set EDGAR_USER_AGENT environment variable or pass --user-agent to each command.

affects: >=0.1.0

gotchaThe --id parameter for resolve and filings commands expects a ticker symbol, not a CIK number or company name; incorrect input may yield empty results.

fix

Use the official ticker symbol (e.g., AAPL for Apple Inc.).

affects: >=0.1.0

gotchaFiling accession numbers must include leading zeros and be in the format SEC uses (e.g., 0000320193-26-000006); omitting leading zeros may cause 'not found' errors.

fix

Copy the exact accession number from SEC EDGAR or use the filings list command to get valid accessions.

affects: >=0.1.0

Errors

Common errors & fixes

IDENTITY_REQUIRED: SEC EDGAR requires a declared identity

EDGAR_USER_AGENT not set and --user-agent not provided.

fix

Set EDGAR_USER_AGENT environment variable or pass --user-agent 'Your Name your.email@example.com'.

Error: No such file or directory: .../edgar-cli/cache/...

Cache directory does not exist and cannot be created (permissions or missing parent directories).

fix

Ensure the cache directory is writable, or set EDGAR_CACHE_DIR to a writable path; create the directory manually if needed.

Upgrade

Version history

0.1.4latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

7 hits · last 30 days

node