更新日:2023年11月26日
おおさかポータルAPI
おおさかポータルのデータは、API(Application Programming Interface)を利用することにより、JSON形式もしくはXML形式で取得することができます。
おおさかポータルAPIで取得できるデータは、「クリエイティブ・コモンズ表示4.0国際ライセンス」(CC-BY)により、オープンデータとしてご利用いただけます。
以下をご確認のうえ、お使いください。
1.ご利用にあたって
(1)おおさかポータルのデータのご利用について
- オープンデータとしてご利用いただけるのは、「おおさかポータルAPIにより直接取得できるデータ」(「事項」「文献」「年表」の各データ。以下「対象データ」)のみです。
※データに含まれるURL(外部サイトのほか、「おおさかeコレクション」など大阪府立図書館の他のシステムを含みます)にアクセスすることによって取得できるデータは、対象データには含まれません。それぞれの利用条件をご確認ください。
- ご利用になるサイトやアプリケーション等には、おおさかポータルのデータを利用している旨、表示してください。
(2)おおさかポータルAPIのご利用について
- おおさかポータルAPIのご利用にあたって、手続き等は必要ありません。
2に記載の「おおさかポータルAPI仕様」をご覧いただき、ご利用ください。 - サーバへの過負荷を避けるため、特定のサーバから継続して大量のアクセスがある場合は、アクセスの遮断等の措置を行う場合があります。
(3)免責事項
- 本システムおよびデータのご利用により生じた損害、または本システムの停止等により生じた損害について、大阪府立図書館は一切の責任を負いません。
2.おおさかポータルAPI仕様
提供しているAPIは、次の8種類です。
API名称 | 内容 |
---|---|
かんたん検索API | 指定したキーワードで「事項」「文献」「年表」のデータを一括で検索し、結果を返却します。 |
詳細検索(事項)API | 指定した検索条件で「事項」データを検索し、結果を返却します。 詳細な検索条件を指定することができます。 |
詳細検索(文献)API | 指定した検索条件で「文献」データを検索し、結果を返却します。 詳細な検索条件を指定することができます。 |
詳細検索(年表)API | 指定した検索条件で「年表」データを検索し、結果を返却します。 詳細な検索条件を指定することができます。 |
事項詳細API | 指定した事項IDの「事項」データを返却します。 当該事項データに紐づく「文献」データ、「年表」データも出力されます。 |
文献詳細API | 指定した文献IDの「文献」データを返却します。 |
年表詳細API | 指定した年表IDの「年表」データを返却します。 |
アクセス数上位事項API | 集計期間等を指定してアクセス数上位の事項データを返却します。 |
各APIの詳細仕様は、次をご覧ください。
ヘルプ
- おおさかポータルの使い方
- おおさかポータルAPI