メインページ > 国立国会図書館サーチについて > 外部提供インタフェース(API)

外部提供インタフェース(API)


外部提供インタフェース(API) | 提供機能の詳細APIのご利用について



1. 国立国会図書館サーチで提供するAPI

国立国会図書館サーチでは、検索用APIとハーベスト用APIの2種類のAPIを提供しています。
  • 検索用API
    • 国立国会図書館サーチの検索ができます。(検索対象範囲は、使用するAPIのプロトコルによって異なります。)
    • SRU、SRW、OpenSearch、OpenURL、Z39.50に対応しています。
  • ハーベスト用API
    • 国立国会図書館サーチに格納されたメタデータのダウンロードができます。
    • OAI-PMHで提供しています。
      ※ 機能の一部でキャッシュ機能を用いているため、リクエスト条件やタイミングによって応答性能が大きく変わる場合があります。

2.各APIの概要

各APIの入力・出力形式、アクセスURL(ベースURL)は以下の通りです。
プロトコル 入力形式 出力形式 アクセスURL
SRU URL XML http://iss.ndl.go.jp/api/sru
SRW XML XML http://iss.ndl.go.jp/api/srw
OpenSearch URL XML(RSS) http://iss.ndl.go.jp/api/opensearch
OpenURL URL HTML http://iss.ndl.go.jp/api/openurl
Z39.50 (Z39.50) (Z39.50) iss.ndl.go.jp:210
OAI-PMH URL XML http://iss.ndl.go.jp/api/oaipmh
国立国会図書館サーチで検索できるデータのうち、許諾が得られたもののみをAPIで提供しています。詳細は、「4.API仕様書」をご覧ください。国立国会図書館サーチが持つメタデータは、「国立国会図書館ダブリンコアメタデータ記述(DC-NDL)」に従っています。したがって、各プロトコルで返戻されるデータの形式も、このDC-NDLを基本形としています。詳細はメタデータをご覧ください。

3. リクエスト例

  • 2008年1月1日以降に出版されていて、タイトルに「桜」を含むものを検索する(SRU)
    • 結果:こちら
    • ※CQLは、title=“桜”AND from=“2008”となります。ただし、実際のリクエストURLは、これをUTF-8にてエンコードしたものをqueryに付加したURLです。
      (「title=“桜”AND from=“2008”」をエンコードしたものは、「title%3d%22%e6%a1%9c%22%20AND%20from=%222008%22」)
  • タイトルに「マリーアントワネット」を含み、かつ分類(NDC)が「2(歴史)」のものを検索する(OpenSearch)
    • 結果:こちら
    • ※NDCは前方一致検索です。
  • 著者に「夏目漱石」を含むものを検索する(OpenURL)
    • 結果:こちら
    • ※実際のリクエストURLは、UTF-8にてエンコードしたものをqueryに付加したURLです。

4. API仕様書(日本語版)


5. API仕様書(英語版)

Return formats are DC-NDL(RDF), DC-NDL(Simple) and DC(Dublin Core). For more details, see Metadata page and Standards for Digital Information.