EDINET API Client for Python.
Project description
edinet-python
- Download the documents from EDINET.
- Use official EDINET API.
- Extract contents from XBRL.
- Main target of parser is annual reports.
How to use
Install
pip install edinet-python
1. Download the documents from EDINET.
1.1 Get document list of specific day
import edinet
documents = 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}")
when only getting the list metadata (number of documents).
import edinet
metadata = edinet.api.metadata.get("2019-01-31")
print(f"Number of documents is {metadata.count}")
1.2 Get document by document id
from pathlib import Path
import edinet
xbrl_path = edinet.api.document.get_xbrl("S100FGR9", save_dir=Path.cwd())
pdf_path = edinet.api.document.get_pdf("S100FGR9", save_dir=Path.cwd())
2. Extract contents from XBRL
from edinet.xbrl_file import XBRLFile
from edinet.parser.aspects.business import Business
xbrl = XBRLFile("path/to/xbrl/file")
content = xbrl.parse_by(Business).policy_environment_issue_etc
Following aspects are supported. The format is based on 三号様式
that is commonly used for annual report.
- 文書情報:
Metadata
- 会計年度:
fiscal_year
- 会計期間種別:
fiscal_period_type
- 会計年度:
- 企業の概況:
Company
- 主要な経営指標等の推移
- 沿革:
history
- 事業の内容:
business_description
- 関係会社の状況:
affiliated_entities
- 従業員の状況:
employees
- 事業の状況:
Business
- 経営方針、経営環境及び対処すべき課題等:
policy_environment_issue_etc
- 事業等のリスク:
risks
- 経営者による財政状態、経営成績及びキャッシュ・フローの状況の分析(2018年度~):
management_analysis
- 重要事象等の分析及び対応(2018年度~)
- 経営上の重要な契約等
- 研究開発活動:
research_and_development
- (業績等の概要(~2017年度):
overview_of_result
) - (生産、受注及び販売の状況(~2017年度):
analysis_of_production_and_sales
) - (財政状態、経営成績及びキャッシュ・フローの状況の分析(~2017年度):
analysis_of_finance
)
- 経営方針、経営環境及び対処すべき課題等:
- 設備の状況
- 設備投資等の概要
- 主要な設備の状況
- 設備の新設、除却等の計画
- 賃貸資産
- 自社用資産
- 提出会社の状況:
Information
- 株式等の状況:
- 所有者別状況:
shareholders
- 所有者別状況:
- 配当政策:
dividend_policy
- 役員の状況:
directors
- コーポレート・ガバナンスの状況等:
corporate_governance
- 株式等の状況:
- 経理の状況:
Finance
- 連結財務諸表等
- 財務諸表等
- 注記:
notes
- 会計方針の変更/会計基準等の改正等以外の正当な理由による会計方針の変更:
voluntary_accounting_policy_change
- セグメント情報等:
segment_information
- 賃貸等不動産関係:
real_estate_for_lease
- 注記:
- 最近の財務諸表
- 提出会社の株式事務の概要
- 株式公開情報
- 特別利害関係者等の株式等の移動状況
- 第三者割当等の概況
- 株主の状況
- 提出会社の参考情報
- 提出会社の親会社等の情報
- その他の参考情報
References
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
edinet-python-0.1.18.tar.gz
(1.6 MB
view details)
File details
Details for the file edinet-python-0.1.18.tar.gz
.
File metadata
- Download URL: edinet-python-0.1.18.tar.gz
- Upload date:
- Size: 1.6 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 57b172c0ce44e1f0f9e4d09bd64dc439fd3f47d134171469e488260c55d10457 |
|
MD5 | a6fa056a7d45f1cff4a8812cddf9d7d8 |
|
BLAKE2b-256 | bfc87d3864f819e062036c60316e47d72e1f30d04e998f9fc4ec9552a7a723e3 |