edinetdb — CLI for the EDINET DB API

Command-line interface for EDINET DB, a financial-data API covering the ~3,850 Japanese listed companies filed through the FSA's EDINET system (Electronic Disclosure for Investors' NETwork).

pip install edinetdb
edinetdb auth login    # paste your key from https://edinetdb.jp/developers
edinetdb search toyota
edinetdb financials E02144 --years 5
edinetdb screener -w 'roe:gte=15' -w 'equity_ratio:gte=50'

Install

pip install edinetdb

Python 3.10+ is required. The only runtime dependencies are typer, httpx, and rich.

Authenticate

All endpoints except status and search require an API key. Get a free key at https://edinetdb.jp/developers and store it:

edinetdb auth login
# API key: ****************
# Saved credentials to /Users/you/.config/edinetdb/credentials

Alternatively, set the environment variable:

export EDINETDB_API_KEY=your_key_here

Resolution order: --api-key flag → EDINETDB_API_KEY env → stored credentials.

Commands

Run edinetdb <command> --help for per-command flags.

Output

Every command supports --format {json,table,csv} (-f). Table is the default for flat list results; company details default to JSON.

edinetdb rankings roe --limit 10 --format csv > roe_top10.csv
edinetdb financials E02144 --years 5 --format json | jq '.[].revenue'

Exit codes map to the error class:

Configuration

Named profiles allow multiple keys (e.g. personal + team):

edinetdb auth login --profile team
edinetdb --profile team search softbank     # requires per-command flag, TBD
EDINETDB_PROFILE=team edinetdb search softbank

Links

• API documentation & live Redoc UI: https://edinetdb.jp/docs/api-reference
• OpenAPI spec: https://edinetdb.jp/v1/openapi.yaml
• Get an API key: https://edinetdb.jp/developers
• Issues: https://github.com/Cabocia/edinet-db/issues

License

Apache 2.0 © 2026 Cabocia Inc.