Features:
- API: Download the documents from official publication site.
- Reader: Extract contents from XBRL.
Supported documents:
- Japan
- API: EDINET
- Reader: Mainly supports annual reports disclosed on EDINET.
- America
- API: Comming soon
- Reader: Comming soon
We are welcome the contribution to support other countries API & Documents!
pip install xbrr
(Examples are Japanese EDINET API and annual report).
Download the documents from EDINET.
import xbrr
documents = xbrr.edinet.api.documents.get("2019-01-31")
print(f"Number of documents is {len(documents.list)}")
print(f"Title of first document is {documents.list[0].title}")from pathlib import Path
import xbrr
xbrl_path = xbrr.edinet.api.document.get_xbrl("S100FGR9", save_dir=Path.cwd())
pdf_path = xbrr.edinet.api.document.get_pdf("S100FGR9", save_dir=Path.cwd())Each XBRL includes taxonomy information. If you want to deal with these files, execute the following.
xbrl_dir = xbrr.edinet.api.document.get_xbrl("S100FGR9", save_dir=Path.cwd(), expand_level="dir")Extract contents from XBRL.
xbrl = xbrr.edinet.reader.read("path/to/xbrl/file")
content = xbrl.extract(xbrr.edinet.aspects.Business).policy_environment_issue_etc.valueExtract financial statements.
xbrl_dir = xbrr.edinet.reader.read("path/to/xbrl/dir")
xbrl_dir.extract(xbrr.edinet.aspects.Finance).bs.to_csv("bs.csv", index=False)
Please refer to the supported aspects from the following links.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent