Zenn
📖

Python＋EDINET APIをやってみる#2 - 書類一覧取得API

2022/03/23に公開
Python
EDINET
tech

はじめ

  • 前回（メタデータのみ取得）のつづき。

https://zenn.dev/indonegiyan/articles/bda196798a5184

  • 今回：メタデータ及び提出書類一覧の取得。

EDINET APIの仕様

参考:
EDINET API関連資料 - EDINET API仕様書

■２つのAPI

  1. 提出された書類の一覧を取得するAPI
  2. 提出された書類を取得するAPI

■書類一覧取得API

リクエスト

  • エンドポイント

    • https://disclosure.edinet-fsa.go.jp/api/バージョン/documents.json
    • バージョンを指定する。

  • HTTP通信方式：TLS

  • HTTPメソッド：GET

  • リクエストパラメータ

    パラメータ名 項目名 必須 設定値 説明
    date ファイル日付 ○ 日付
    （YYYY-MM-DD）    		 出力対象とする書類一覧のファイル日付を指定する。
    type 取得情報 - 1 メタデータのみを取得する。指定がない場合のデフォルト値。
    2 書類一覧及びメタデータを取得する。
    • パラメータの指定方法
      1. 「パラメータ名」と「設定値」を=で結合する。
      2. 複数のパラメータを指定する場合は、1.で作成したパラメータ同士を&で結合する。
      3. 「エンドポイント」と2.で作成したパラメータ文字列を?で結合する。

Python編

参考記事：
Pythonから金融庁のEDINET APIを使って有価証券報告書を取得する

■書類一覧取得APIソースコード

edinet_doc_list2.py
import requests #HTTPリクエスト

#エンドポイント（基本）
endpoint_base = "https://disclosure.edinet-fsa.go.jp/api/v1/"

#パラメータ
param = {
    "date" : "2022-03-23" ,
    "type" : 2
    }

#URL
url = endpoint_base + "documents.json"

#書類一覧の取得
response = requests.get(url, params=param, verify=False)

#表示
print(response.text)

■実行結果

※一部抜粋

実行結果
{
    "metadata":
        {
            "title": "提出された書類を把握するためのAPI",
            "parameter":
                {
                    "date": "2022-03-23",
                    "type": "2"
                },
            "resultset":
                {
                    "count": 272
                },
            "processDateTime": "2022-03-23 19:03",
            "status": "200",
            "message": "OK"
        },
    "results": [
        {
            "seqNumber": 1,
            "docID": "S100NO7S",
            "edinetCode": "E27669",
            "secCode": null,
            "JCN": null,
            "filerName": "ザ・ホンコン・アンド・シャンハイ・バンキング・コーポレイション・リミテッ 
ド",
            "fundCode": null,
            "ordinanceCode": "010",
            "formCode": "150003",
            "docTypeCode": "100",
            "periodStart": null,
            "periodEnd": null,
            "submitDateTime": "2022-03-23 09:00",
            "docDescription": "発行登録追補書類",
            "issuerEdinetCode": null,
            "subjectEdinetCode": null,
            "subsidiaryEdinetCode": null,
            "currentReportReason": null,
            "parentDocID": "S100LFWK",
            "opeDateTime": null,
            "withdrawalStatus": "0",
            "docInfoEditStatus": "0",
            "disclosureStatus": "0",
            "xbrlFlag": "0",
            "pdfFlag": "1",
            "attachDocFlag": "1",
            "englishDocFlag": "0"
        },
	
     ### --- 以下省略 --- ###

■説明

  • 今回は、&type=2、つまりメタデータ及び提出書類一覧の取得。
  • メタデータ部 "metadata"に、
            "resultset":
                {
                    "count": 272
                },

とあるように、272件の提出書類一覧が続きに出力されるため、実行結果への記載は省略している。

おわり

  • 次は提出書類（ZIP、PDF等）の取得を試してみようと思います。

Discussion