Skip to main content

EDINET API client & XBRL parser for Japanese financial disclosures

Project description

edinet

EDINET(金融庁の電子開示システム)の開示データを Python から簡単に扱うためのライブラリ。

XBRL のパース、財務諸表の組み立て、タクソノミの解析までをワンストップで提供します。

Status: Alpha — API は安定していません。破壊的変更の可能性があります。

Features

  • 書類一覧の取得 — 日付・書類種別でフィルタして Filing 一覧を取得
  • XBRL パース — Fact / Context / Unit を構造化オブジェクトとして抽出
  • DEI 抽出 — 会計基準(J-GAAP / IFRS / US-GAAP)、報告期間、企業属性を自動判別
  • 財務諸表の組み立て — PL / BS / CF を科目ラベル付きで取得(現在 J-GAAP のみ)
  • Linkbase 解析 — Presentation / Calculation / Definition の木構造をパース
  • タクソノミラベル解決 — 標準タクソノミ + 提出者タクソノミのラベルを自動解決
  • Async 対応 — 全 I/O 操作に sync / async ペアを提供

Installation

pip install edinet

Quick Start

import edinet

# API キーの設定
edinet.configure(api_key="YOUR_API_KEY")

# 書類一覧の取得
filings = edinet.documents("2025-06-26", doc_type="120")  # 有価証券報告書

# XBRL から財務諸表を取得
for filing in filings:
    if filing.has_xbrl:
        stmts = filing.xbrl()
        pl = stmts.income_statement()
        bs = stmts.balance_sheet()
        for item in pl.items:
            print(f"{item.label_ja}: {item.value:,}")
        break

低レベル API

from edinet.xbrl import parse_xbrl_facts, extract_dei
from edinet.xbrl.contexts import ContextCollection, structure_contexts
from edinet.xbrl.units import structure_units
from edinet.xbrl.linkbase import parse_presentation_linkbase

# XBRL インスタンスのパース
xbrl_path, xbrl_bytes = filing.fetch()
parsed = parse_xbrl_facts(xbrl_bytes, source_path=xbrl_path)

# DEI(企業属性)の抽出
dei = extract_dei(parsed.facts)
print(dei.filer_name_ja)          # 企業名
print(dei.accounting_standards)   # AccountingStandard.JAPAN_GAAP
print(dei.security_code)          # 証券コード

# Context / Unit の構造化
contexts = ContextCollection(structure_contexts(parsed.contexts))
units = structure_units(parsed.units)

# フィルタチェーン
consolidated = contexts.filter_consolidated().filter_no_extra_dimensions()

Requirements

  • Python >= 3.12
  • EDINET API キー(EDINET で取得)

License

MIT

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-0.0.1.tar.gz (18.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

edinet-0.0.1-py3-none-any.whl (1.2 MB view details)

Uploaded Python 3

File details

Details for the file edinet-0.0.1.tar.gz.

File metadata

  • Download URL: edinet-0.0.1.tar.gz
  • Upload date:
  • Size: 18.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.12

File hashes

Hashes for edinet-0.0.1.tar.gz
Algorithm Hash digest
SHA256 e25c58618368e805f1e4596d0d97735519898b0c25680e5fddc28ce600328bdf
MD5 7bda9d2bc2d16ca4073c24fc5a8f260f
BLAKE2b-256 954329b21b6761e1f4f20315c7e9a5c2e9e5b65f6b815fce89eff5e3a1e2c125

See more details on using hashes here.

File details

Details for the file edinet-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: edinet-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 1.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.12

File hashes

Hashes for edinet-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d1fa2a4b9b4f1fe45f3f0f015646415c8560d86f93c1ad1ec4a1bedb5a2a461c
MD5 da250c0ce5e1ae06d432e14e35784a28
BLAKE2b-256 6101ac23efe677edf8923230374492b101e7f9ac122edd96b59ba5a182272b65

See more details on using hashes here.

Supported by

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