開発ガイド

ここでは、提供APIを使って、開発を始めるために必要な情報を紹介しています。

1 APIの概要

政府統計の総合窓口(e-Stat)で提供している統計データを機械判読可能な形式(XML等)で取得できるAPI(Application Programming Interface)を提供します。

banner_api 

 

2 API機能の活用方法

1.利用者の情報システムにe-Statのデータを自動的に反映

・常に最新の情報を表示、主要な情報をまとめて表示

・利用者の情報システムが統計データを保持しない場合であっても、常時APIを経由して自動的に最新のデータをウェブサイトに反映させる等の利用が想定される。

 

2.ユーザー保有やインターネット上のデータ等と連動させた高度な統計データ分析

事前に統計データを一括でダウンロードしDB等に格納した後、BIツール等で分析するなどの利用が想定される。

・政府統計の総合窓口(e-Stat)から、EXCEL等をまとめてダウンロードしDB等に格納するには、多くの手間や時間がかるが、API機能を利用することにより、簡易にDB等に格納することが可能。

・最新情報は、差分を取り込むことで対応。

 

 

3 API機能の仕様

API機能は機能ごとに別々のURLとパラメータを用意しています。

api-spec

 

以下では、API機能を利用して、実際に統計データを取得するまでのプロセスを紹介しています。

 

[統計データ取得プロセス]

① 「統計表情報取得」機能を利用して、目的の統計表の統計表IDを取得します。調査年月、調査名及び検索キーワードなどをパラメータとして、検索できます。

 

② ①のレスポンスとして取得した統計表IDをパラメータとして、「メタ情報取得」機能を利用します。目的の統計表に係るメタ情報を確認できます。

 

③ ①のレスポンスとして取得した統計表ID及び②のレスポンスとして取得したメタ情報をパラメータとして、目的の統計データを取得します。

data-processing

 

 

4 提供データの構造

  • 統計表情報取得

表題、調査年月、統計表IDなどの情報を統計表の件数分、取得します。

statsList_sample

 

 

  • メタ情報取得

分類事項、時間軸事項、地域事項、表章事項をメタ情報の件数分、取得します。

metainfo_sample

 

 

  • 統計データ取得

統計データの数値情報を統計数値(セル)の件数分だけ出力します。

statsData_sample