本ドキュメントに関する注意事項

本ドキュメントは有報キャッチャーにおけるAtomAPI実装を解説するものです。有報キャッチャーの運営者である(有)プレシスがその作成と更新を行っています。 本ドキュメントおよび有報キャッチャーのAtomAPI実装は変更される可能性があります。

変更履歴

AtomAPIとは

AtomAPI はウェブリソースを出版、編集するためのアプリケーション・プロトコル仕様です。 有報キャッチャーのAtomAPIを利用することで、開発者は有報キャッチャーで保持管理しているIR情報を参照する オリジナルのアプリケーションを作成することができます。

AtomAPIについて詳しくは http://www.ietf.org/html.charters/atompub-charter.html(英語)などを参照してください。

有報キャッチャーAtomAPI はオリジナルのアプリケーションから有報キャッチャーで保持管理しているIR情報(EDINET/TDnetで開示された情報)を参照するためのインターフェースです。

有報キャッチャーAtomAPIを利用することで、EDINETや適時開示情報のウェブサイト(HTML)を解析してパラメーターを組み立てPOSTするといった、いわゆるHTMLスクレイピングのような手法を行うことなしに、専用のAPIインタフェースを使ってアプリケーションを実装することができます。

有報キャッチャーにおけるAtomAPI実装の概要

有報キャッチャーAtomAPIはRESTをサポートしています。現時点でSOAPはサポートしていません。

HTTP の GET/POST/PUT/DELETE を特定のURIに対して行い、そのリクエストに規定のXML文書を加えて送信することでインタフェースが用意している操作を行うことができます(現在はGETのみ使用)。また、一部の操作はそのレスポンスとして規定のXML文書を返却します。

現時点でAPIがサポートしている操作は以下です。

  • EDINET情報配信サービス ~ EDINETで開示された法定開示情報の一覧の取得
  • EDINET情報配信サービス(XBRL情報があるもの) ~ EDINETで開示された法定開示情報(XBRL添付)の一覧の取得
  • 適時開示情報配信サービス ~ TDnetで開示された適時開示情報の一覧の取得
  • 適時開示情報配信サービス(XBRL情報があるもの) ~ TDnetで開示された適時開示情報(XBRL添付)の一覧の取得
  • コーポレート・ガバナンス情報配信サービス ~ 東証/ジャスダックにて開示されたコーポレート・ガバナンス情報の一覧の取得

以下、有報キャッチャーAtomAPIの詳細を解説します。

サービス文書

有報キャッチャーAtomAPIのサービス文書は以下になります。サービス文書に対しGETリクエストを行うことで、FeedURIを取得することができます。

http://resource.ufocatch.com/atom

リクエスト

GET /atom

レスポンス

HTTP/1.1 200 OK
Content-Type: text/xml

<?xml version="1.0" encoding="utf-8"?>
<service xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://www.w3.org/2007/app">
  <workspace>
    <atom:title>有報キャッチャー Webサービス</atom:title>
    <collection href="http://resource.ufocatch.com/atom/edinet">
      <atom:title>有報キャッチャー - EDINET情報配信サービス</atom:title>
    </collection>
    <collection href="http://resource.ufocatch.com/atom/edinetx">
      <atom:title>有報キャッチャー - EDINET情報配信サービス(XBRL情報があるもの)</atom:title>
    </collection>
    <collection href="http://resource.ufocatch.com/atom/tdnet">
      <atom:title>有報キャッチャー - 適時開示情報配信サービス</atom:title>
    </collection>
    <collection href="http://resource.ufocatch.com/atom/tdnetx">
      <atom:title>有報キャッチャー - 適時開示情報配信サービス(XBRL情報があるもの)</atom:title>
    </collection>
    <collection href="http://resource.ufocatch.com/atom/cg">
      <atom:title>有報キャッチャー - コーポレート・ガバナンス情報配信サービス</atom:title>
    </collection>
  </workspace>
</service>

FeedURI

FeedURIは、有報キャッチャーで管理している情報をAtomフィードで取得するためのエンドポイントです。GETメソッドのみをサポートしています。

リクエスト

GET /atom/{種別}
GET /atom/{種別}/query/{クエリワード}

{種別}は、edinet,edinetx,tdnet,tdnetx,cgのいずれかです。
{クエリワード}は、クエリ(UTF-8を使用し、URLエンコードしてください)です。企業名、件名、証券コード、EDINETコードなどに一致するものを検索します。4桁の数値を指定すると、自動的に証券コードとみなされます。

レスポンス

通常のAtomフィードにて結果を返します。ここでは省略します

エントリーは最近のものから出力し、200件ごとにページングしています。ページングについてはgihyo.jpの記事『Web APIの次世代標準プロトコル「Atom Publishing Protocol」』などが参考になります。

クライアント

当APIを利用したクライアント実装例として、以下のものがあります。