Skip to main content

EDINET API Client for Python.

Project description


PyPI version Build Status codecov

  • Download the documents from EDINET.
  • Extract contents from XBRL.
    • Main target of parser is annual reports.

How to use


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 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.

  1. 文書情報: Metadata
    1. 会計年度: fiscal_year
    2. 会計期間種別: fiscal_period_type
  2. 企業の概況: Company
    1. 主要な経営指標等の推移
    2. 沿革: history
    3. 事業の内容: business_description
    4. 関係会社の状況: affiliated_entities
    5. 従業員の状況: employees
  3. 事業の状況: Business
    1. 経営方針、経営環境及び対処すべき課題等: policy_environment_issue_etc
    2. 事業等のリスク: risks
    3. 経営者による財政状態、経営成績及びキャッシュ・フローの状況の分析(2018年度~): management_analysis
    4. 重要事象等の分析及び対応(2018年度~)
    5. 経営上の重要な契約等
    6. 研究開発活動: research_and_development
    • (業績等の概要(~2017年度): overview_of_result)
    • (生産、受注及び販売の状況(~2017年度): analysis_of_production_and_sales)
    • (財政状態、経営成績及びキャッシュ・フローの状況の分析(~2017年度): analysis_of_finance)
  4. 設備の状況
    1. 設備投資等の概要
    2. 主要な設備の状況
    3. 設備の新設、除却等の計画
    4. 賃貸資産
    5. 自社用資産
  5. 提出会社の状況: Information
    1. 株式等の状況:
      • 所有者別状況: shareholders
    2. 配当政策: dividend_policy
    3. 役員の状況: directors
    4. コーポレート・ガバナンスの状況等: corporate_governance
  6. 経理の状況: Finance
    1. 連結財務諸表等
    2. 財務諸表等
      • 注記: notes
      • 会計方針の変更/会計基準等の改正等以外の正当な理由による会計方針の変更: voluntary_accounting_policy_change
      • セグメント情報等: segment_information
      • 賃貸等不動産関係: real_estate_for_lease
    3. 最近の財務諸表
  7. 提出会社の株式事務の概要
  8. 株式公開情報
    1. 特別利害関係者等の株式等の移動状況
    2. 第三者割当等の概況
    3. 株主の状況
  9. 提出会社の参考情報
    1. 提出会社の親会社等の情報
    2. その他の参考情報


Project details

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 hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page