Skip to main content

eXtensible Business Report Reader.

Project description

XBRR: eXtensible Business Report Reader

PyPI version Build Status codecov

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!

Install

pip install xbrr

How to use

(Examples are Japanese EDINET API and annual report).

1. API

Download the documents from EDINET.

1.1 Get document list of specific day

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}")

1.2 Get document by document id

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

2. Reader

Extract contents from XBRL.

xbrl = xbrr.edinet.reader.read("path/to/xbrl/file")
content = xbrl.extract(xbrr.edinet.aspects.Business).policy_environment_issue_etc.value

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

bs.png

Please refer to the supported aspects from the following links.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for xbrr, version 0.2.5
Filename, size File type Python version Upload date Hashes
Filename, size xbrr-0.2.5.tar.gz (1.7 MB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page