オープンデータをRESTで検索してみた

2020年9月11日2024年3月23日検証してみた

Contents

1. 今回利用したサービス
2. Web APIを調べる
3. WebFOCUSデータアダプタを設定する
4. シノニムを作成する

WebFOCUSのデータアダプタでは、REST API を使用したデータ検索ができます。
今回は、RESTアダプタを使用して、オープンデータを検索してみました。

オープンデータとは？

オープンデータとは，「機械判読に適したデータ形式で、二次利用が可能な利用ルールで公開されたデータ」であり「人手を多くかけずにデータの二次利用を可能とするもの」です。つまり，誰でも許可されたルールの範囲内で自由に複製・加工や頒布などができるデータをいいます。もちろん商用としても利用可能です。
引用元：自治体オープンデータ

RESTとは？

REST 【 Representational State Transfer 】
RESTとは、分散システムにおいて複数のソフトウェアを連携させるのに適した設計原則の一つ。
一般によく使われる（本来は狭義の）RESTは、パラメータを指定して特定のURLにHTTPでアクセスすると、XMLやJSONなどで記述されたメッセージが送られてくるようなシステム、および、そのような呼び出し規約（「RESTful API」と呼ばれる）のことを指す。
引用元：IT用語辞典 e-Words

今回利用したサービス

統計ダッシュボード

国や民間企業等が提供している主要な統計データをグラフ等に加工して一覧表示し、視覚的に分かりやすく、簡単に利用できる形で提供するシステムです。
引用元：統計ダッシュボードとは

データの構造やAPIの説明なども、同サイトで説明されていますので、すぐに利用することができます。

Web APIを調べる

Web APIを調べてみます。

XMLフォーマットのデータを取得するのであれば、

ベースURL：　https://dashboard.e-stat.go.jp/api/1.0/Xml/getData?
必須パラメータ：　IndicatorCode　（系列コード）

ウェブブラウザで指定するならこんな感じ

https://dashboard.e-stat.go.jp/api/1.0/Xml/getData?
IndicatorCode=0201010000000010000
※実際には改行は含まれません

系列コードは、別途「統計メタ情報（系列）」のAPIで取得した系列コードを使用とのことだが、今回は系列コードを固定して使用しました。

これだけ指定すれば統計データが取得できるとのことですが、絞り込みたいので、下記のパラメータを追加して使用してみます。

パラメータ名	パラメータの概要	コード	説明
ParentRegionCode	上位地域コード	情報を取得したい地域コードの上位地域コード5桁	例１）「00000」（全国）「01000」（北海道）
RegionalRank	地域階級	1,2,3,4	国、全国（日本）、都道府県、市区町村
TimeFrom	時間軸（開始）	yyyymm00 yyyy1Q00,yyyy2Q00,yyyy3Q00,yyyy4Q00 yyyyCY00 yyyyFY00	月四半期暦年年度
TimeTo	時間軸（終了）	時間軸（開始）と同じ	時間軸（開始）と同じ
Cycle	データ周期	1,2,3,4	月、四半期、年、年度

パラメータを組み合わせるとこんな感じになります。

https://dashboard.e-stat.go.jp/api/1.0/Xml/getData?
IndicatorCode=0201010000000010000
&ParentRegionCode=00000&RegionalRank=3
&TimeFrom=1980CY00&TimeTo=9999CY00&Cycle=3
※実際には改行は含まれません