Asa's Opendata Catalog

当サイトのオープンデータAPIについて

About the Open Data API on this site

当サイトのオープンデータカタログでは、APIをご利用いただけます。このページでは、本APIの利用方法をご案内します。

You can use the API in the Open Data Catalog on this website. This page will guide you through the use of this API.

基本仕様

Basic Specifications

利用方法

How to Use

オープンデータのURL取得方法

How to obtain URLs for open data

  1. 利用したいオープンデータのページにアクセスします。

  2. データへのURLを取得する
    「データへのURLを取得する」ボタンをクリックします。

  3. モーダルが表示されます
    モーダルが表示されます。「URLをコピー」ボタンをクリックすると、URLがクリップボードにコピーされます。
  1. Access the page of the open data you want to use.

  2. Get URL to the data
    Click the "Get URL to the data" button

  3. Shows a modal
    A modal will be displayed. Click the "Copy the URL" button to copy the URL to the clipboard.

CSVをJSONとして表示

Convert CSV to JSON

CSVのオープンデータのURLの末尾に、?mode=jsonをつけることで、CSVファイルをJSONファイルとして表示します。

By adding ?mode=json to the end of the open data URL, the CSV file will be displayed as a JSON file.

データのフィルタリング

Data Filtering

URLの末尾に、filterクエリパラメータを渡すことで、データのフィルタリングができます。 なお、CSVファイルにおいてフィルタリングする場合、上記「CSVをJSONとして表示」と併用する必要があります。

By passing the filter query parameter at the end of the URL, you can filter the data. Note that if you want to filter CSV files, you need to use it in conjunction with "Convert CSV to JSON" above.

複数の条件で絞り込みたい場合、filter=条件1;条件2;...のように空白なしのセミコロン区切りで指定してください。 AND検索です。条件に合う要素がない場合、[]が返されます。

If you want to filter by more than one condition, use filter=condition1;condition2;..., separated by a semicolon with no spaces. This is AND search. If there is no element that matches the conditions, [] will be returned.

  • キーの絞り込み

    JSONファイルにおいて、指定したキーのみを表示します。
    形式:key__["キー1","キー2","..."]
  • 日付の絞り込み

    指定したキーに対する値において、日付の大小で絞り込みます。
    形式:date__キー__{fromまたはto}__日付(ISO形式)
    • キーが「aaa」のデータに対して、2021年1月1月以降のデータのみを表示する場合: date__aaa__from__2021-01-01
    • キーが「bbb」のデータに対して、2020年12月31月以前のデータのみを表示する場合: date__bbb__to__2020-12-31
    • キーが「ccc」のデータに対して、2020年1月1月のみのデータのみを表示する場合は、上の2つを組み合わせることによって実現できます: date__ccc__from__2020-01-01;date__ccc__to__2020-01-01
  • 数字の絞り込み

    指定したキーに対する値において、数字の大小で絞り込みます。 値が数字ではない場合、常にFalseが返されます。
    形式:num__キー__{overまたはunder}__数字
    • キーが「ddd」のデータに対して、値が10以上のものを表示する場合: num__ddd__over__10
    • キーが「eee」のデータに対して、値が20以下のものを表示する場合: num__eee__under__20
  • 文字列の絞り込み

    指定したキーに対する値において、文字列と等しいかどうかで絞り込みます。 なお、指定された文字列に__が含まれる場合、__も含めて認識されます。
    数字を絞り込む場合、こちらの方法ではうまくいきません。 「数字の絞り込み」の条件を複数組み合わせてください。
    形式:str__キー__{eqまたはne}__文字列
    • キーが「fff」のデータに対して、値が「hoge」と等しいものを表示する場合: str__fff__eq__hoge
    • キーが「ggg」のデータに対して、値が「fuga」ではないものを表示する場合: str__ggg__ne__fuga
  • Filtering the key

    Displays only the specified key in the JSON file.
    Format: key__["key1","key2","..."]
  • Filtering the date

    Narrows down the list of values for the specified key by the size of the date.
    Format: date__key__{"from" or "to"}__date(ISO format)
    • To display only the data after January 1, 2021 for the data whose key is "aaa": date__aaa__from__2021-01-01
    • To display only data before December 31, 2020 for data with the key "bbb": date__aaa__to__2020-12-31
    • For data with the key "ccc", if you want to display only the data for January 1, 2020, you can combine the above two methods: date__ccc__from__2020-01-01;date__ccc__to__2020-01-01
  • Filtering the number

    Narrows down by the number in the value for the specified key. False will always be returned if the value is not a number.
    Format: num__key__{"over" or "under"}__number
    • To display data with a key of "ddd" and a value of 10 or more: num__ddd__over__10
    • To display data with a key of "eee" and a value of 20 or less: num__eee__under__20
  • Filtering the string

    Narrows down the list of values for a given key by whether it is equal to a string or not. If the specified string contains __, it will be recognized including __.
    If you want to narrow down the numbers, this method will not work. Please combine multiple conditions of "Filtering the number".
    Format: str__key__{"eq" or "ne"}__string
    • To display data whose key is "fff" and whose value is equal to "hoge": str__fff__eq__hoge
    • To display data whose key is "ggg" and whose value is not "fuga": str__ggg__ne__fuga
keyboard_arrow_up