v0.1.0 — first public release

Initial public release of the edinetdb CLI.

Install

pip install edinetdb
edinetdb auth login   # paste your API key from https://edinetdb.jp/developers
edinetdb search toyota

What's included

Command-line interface for the EDINET DB REST API, covering financial data for ~3,850 Japanese listed companies sourced from FSA EDINET filings.

• 23 commands across 27 v1 REST endpoints (companies, financials, ratios, rankings, screener, shareholders, earnings, real-estate, and more)
• Output formats: --format {json,table,csv} (table is default for flat results; company details default to JSON)
• Authentication: edinetdb auth login stores keys at ~/.config/edinetdb/credentials (chmod 0600); EDINETDB_API_KEY env override; named profiles supported
• Typed error → exit code mapping (auth=2, rate_limit=3, not_found=4, validation=5, server=6)
• Rate limit headers surfaced on errors with upgrade URL

Dependencies

• Python 3.10+
• typer (CLI framework)
• httpx (HTTP client)
• rich (table/JSON formatting)

Tested

• 27 tests (10 config + 6 client + 11 commands) — all green
• CI runs against Python 3.10 / 3.11 / 3.12 / 3.13

Also new

• OpenAPI 3.0 spec published at https://edinetdb.jp/v1/openapi.yaml (JSON variant at /openapi.json)
• Redoc API docs at https://edinetdb.jp/docs/api-reference with x-codeSamples for every endpoint
• Full EDINET DB REST API coverage (27 operations) in the public spec

Documentation

• CLI README: https://github.com/Cabocia/edinetdb-cli#readme
• API Reference: https://edinetdb.jp/docs/api-reference
• PyPI page: https://pypi.org/project/edinetdb/

Quick examples

# Search companies
edinetdb search toyota --limit 3

# Get company details
edinetdb company E02144

# Financial time series
edinetdb financials E02144 --years 5 --format csv

# Screen companies (ROE >= 15% AND 3-year CAGR >= 10%)
edinetdb screener -w 'roe:gte=15' -w 'revenue_cagr_3y:gte=10'

# Reverse shareholder lookup
edinetdb shareholders search "BlackRock"

# AI analysis
edinetdb analysis E02144

See edinetdb --help for the full command tree.

License

Apache 2.0 — © 2026 Cabocia Inc.

Feedback

Issues and pull requests welcome at https://github.com/Cabocia/edinetdb-cli/issues