Skip to content

About

Command-line interface for EDINET DB — Japanese listed company financial data API. pip install edinetdb

Resources

Stars

6 stars

Watchers

0 watching

Forks

Latest commit

 

History

1 Commit

Folders and files

Repository files navigation

edinetdb — CLI for the EDINET DB API

PyPI Python License

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

Command What it does
auth login / logout / whoami Manage stored credentials
search <query> Find companies by name, EDINET code, or securities code
company <E-code> Company details + latest financials
financials <E-code> Financial time series (annual / quarterly)
ratios <E-code> ROE, ROA, margins, CAGR, valuation ratios
analysis <E-code> AI-generated health score + benchmark counts
text-blocks <E-code> Business description, risks, MD&A
text-analysis <E-code> Structured text (12 types: risks, dividends, governance, …)
expenses <E-code> SGA expense breakdown (14 categories × 4 groups)
segments <E-code> Segment-level revenue, OI, assets
cross-shareholdings <E-code> Policy-holding securities detail
real-estate <E-code> Real-estate note + land-price benchmarks
facilities <E-code> Facility-level properties with book value
earnings <E-code> TDNet earnings disclosure history
calendar JPX earnings release calendar
rankings <metric> Top companies by a financial metric
screener 106-metric multi-condition screener
shareholders get/search/history/activists Large shareholding reports
industries list/get Industry averages and company listings
watchlist list/add/remove Personal watchlist
status API health + data freshness

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:

Code Meaning
0 Success
1 Unclassified error
2 Authentication error (401/403)
3 Rate limit exceeded (429)
4 Not found (404)
5 Bad request / validation (400)
6 Server error (5xx)

Configuration

Variable Default
EDINETDB_API_KEY (not set)
EDINETDB_BASE_URL https://edinetdb.jp/v1
EDINETDB_PROFILE default
XDG_CONFIG_HOME ~/.config (credentials stored in $XDG_CONFIG_HOME/edinetdb/credentials)

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

License

Apache 2.0 © 2026 Cabocia Inc.

About

Command-line interface for EDINET DB — Japanese listed company financial data API. pip install edinetdb

Resources

Stars

6 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages