外部提供インタフェースについて

ご利用にあたって
仕様
検索例
使う！

レファレンス事例を検索し、取得するためのインタフェース（API：Application Programming Interface）の提供を開始しました（2010/3/30）。

ご利用にあたって

非営利目的の場合

非営利目的での利用であれば、どなたでもご利用いただけます。

利用上の留意点（クレジットの表示）

レファレンス協同データベースの外部提供インタフェースを用いていることが分かるような形でご利用ください（サービス連結点で示す、サイト上に明記する等）。また、各レファレンス事例の著作権は、特記されていない限り、当該データの提供館に帰属します。各データを表示する際は、提供館名を明示してください。

※レファレンス協同データベース「利用上の注意」、国立国会図書館ウェブサイト「免責事項」もご確認ください。

利用状況ご連絡のお願い

必須ではありませんが、利用状況を事務局までご連絡いただければ幸いです。

営利目的の場合

営利目的の利用については事務局までご相談ください。

仕様

概要

アクセスURL	http://crd.ndl.go.jp/refapi/servlet/refapi.RSearchAPI
対象データ	レファレンス事例（一般公開データのみ）
検索	詳細検索画面と同等の検索が可能です。
出力項目	すべてのデータを出力します。ソート順は詳細検索画面で指定可能な「最終更新日」「事例作成日」「管理番号」に加えて「登録番号」「被参照数」も指定可能です。
取得可能データ数	現在上限値はありません。今後の状況により上限値を設定する場合があります。「結果の何番目からのデータを取得するか」をユーザが指定できるので、1回目は1件目から、2回目は201件目からのような形でデータを取得することも可能です。
提供プロトコル	REST

詳細

レファレンス協同データベースシステム　検索用API仕様書

検索例

自館のデータを取得したい！（国立国会図書館）
　リクエスト： http://crd.ndl.go.jp/refapi/servlet/refapi.RSearchAPI?LIB-ID=1110001
　結果：こちら
　※指定がないので、最終更新日の降順で200件目までのデータが取得されます。（デフォルト）
自館データの被参照数トップ10を取得したい！（国立国会図書館）
　リクエスト： http://crd.ndl.go.jp/refapi/servlet/refapi.RSearchAPI?LIB-ID=1110001&sort=50&results_num=10
　結果：こちら
　※被参照数の降順（sort=50）、返却件数10件（results_num=10）と指定しています。
被参照数トップ10を取得したい！（全館）
　リクエスト： http://crd.ndl.go.jp/refapi/servlet/refapi.RSearchAPI?LST-DATE_from=20030101&sort=50&results_num=10
　結果：こちら
　※LST-DATE_from=20030101は、2003年1月1日以降に更新されたデータです。日付はYYYYMMDD（年月日）で指定します。
質問に「さくら」を含む事例を検索したい！
　リクエスト： http://crd.ndl.go.jp/refapi/servlet/refapi.RSearchAPI?query=01_%e3%81%95%e3%81%8f%e3%82%89
　結果：こちら
　※リクエストはUTF-8にてエンコードする必要があります。
　※「query=01_」は「質問」をあらわします。
　※「%e3%81%95%e3%81%8f%e3%82%89」は「さくら」をUTF-8でエンコードしたものです。

query_logic（検索条件結合）、query（検索条件）

回答に「天気」と「予報」を含むデータを検索！
　リクエスト： http://crd.ndl.go.jp/refapi/servlet/refapi.RSearchAPI?query=02_%e5%a4%a9%e6%b0%97%20%e4%ba%88%e5%a0%b1
　結果：こちら
　※「query=02_」は「回答」をあらわします。
　※「%20」はスペースをUTF-8でエンコードしたものです。このスペースは「天気」と「予報」をAND条件で結びます。
　※「%e5%a4%a9%e6%b0%97」は「天気」を、「%e4%ba%88%e5%a0%b1」は「予報」をUTF-8でエンコードしたものです。
回答に「天気」を含み、かつ参考資料に「事典」をを含むデータを検索！
　リクエスト： http://crd.ndl.go.jp/refapi/servlet/refapi.RSearchAPI?query=02_%e5%a4%a9%e6%b0%97.04_%e4%ba%8b%e5%85%b8
　結果：こちら
　※queryの「02_」は「回答」を、「04_」は「参考資料」をあらわします。
　※ピリオド(.)で連結された項目間（ここでは回答と参考資料）を、「query_logic」で指定された条件（ANDまたはOR）で結びますが、ここでは「query_logic」が省略されているので、デフォルトの「AND条件」で結んでいます。
　※「%e5%a4%a9%e6%b0%97」は「天気」を、「%e4%ba%8b%e5%85%b8」は「事典」をUTF-8でエンコードしたものです。
質問あるいは回答に「中東」あるいは「中近東」を含むデータを検索！
　リクエスト： http://crd.ndl.go.jp/refapi/servlet/refapi.RSearchAPI?query_logic=2&query=01_%e4%b8%ad%e6%9d%b1%2c%e4%b8%ad%e8%bf%91%e6%9d%b1.02_%e4%b8%ad%e6%9d%b1%2c%e4%b8%ad%e8%bf%91%e6%9d%b1
　結果：こちら
　※「query_logic=2」はqueryのピリオド(.)で連結された項目間（ここでは質問と回答）を、「OR条件」で結びます。
　※queryの「01_」は「質問」を、[02_」は「回答」をあらわします。
　※「%2c」はカンマ(,)をUTF-8でエンコードしたものです。このカンマは「中東」と「中近東」をOR検索で結びます。
　※「%e4%b8%ad%e6%9d%b1」は「中東」を、「%e4%b8%ad%e8%bf%91%e6%9d%b1」は「中近東」をUTF-8でエンコードしたものです。
質問に「奈良」を含むが、「奈良時代」を含まないデータを検索！
　リクエスト： http://crd.ndl.go.jp/refapi/servlet/refapi.RSearchAPI?query=01_%e5%a5%88%e8%89%af.01not_%e5%a5%88%e8%89%af%e6%99%82%e4%bb%a3
　結果：こちら
　※「query_logic」は省略されており、デフォルトのAND条件で、「奈良」と「not奈良時代」を結んでいます。
　※「%e5%a5%88%e8%89%af」は「奈良」を、「%e5%a5%88%e8%89%af%e6%99%82%e4%bb%a3」は「奈良時代」をUTF-8でエンコードしたものです。

　NDC

NDCが「556（各種の船舶．艦艇）」あるいは「665（漁船．漁具）」のデータを検索！
　リクエスト： http://crd.ndl.go.jp/refapi/servlet/refapi.RSearchAPI?NDC=556.665
　結果：こちら
　※NDCは前方一致、OR検索です。
キーワードに「金沢」を含み、かつNDCが「7(芸術)「8(言語)「9(文学)」で始まらないデータを検索！
　リクエスト： http://crd.ndl.go.jp/refapi/servlet/refapi.RSearchAPI?query=03_%e9%87%91%e6%b2%a2&NDC=not_7.8.9
　結果：こちら
　※queryの「03_」は「キーワード」をあらわします。
　※NOT検索は、全体（7,8,9すべて）にかかります。個別に指定することはできません。
　※「%e9%87%91%e6%b2%a2」は「金沢」をUTF-8でエンコードしたものです。

半角ピリオド（URLなど）

回答に「crd.ndl.go.jp」を含むデータを検索！
　リクエスト： http://crd.ndl.go.jp/refapi/servlet/refapi.RSearchAPI?query=02_crdndlgojp
　結果：こちら
　※queryの「02_」は「回答」をあらわします。
　※「.（半角ピリオド）」は検索のキーワードとして使用できないため、URLなどを検索する際には「.」を除いた形で検索します。

使う！

活用情報を共有するためのページはこちら。
サンプルや利用例を掲載しています。