政府統計の総合窓口(e-Stat)で提供されているAPIを呼び出す手順。 今回はアカウント作成から目的のAPIを呼び出すまでを解説します。 令和2年の国税調査の3次元地域メッシュの人口データを呼び出すまでの手順です。 ※返却のデータ形式はJSON
前提条件
- Mac M1(AppleSilicon)
- e-Stat API3.0(JSON)
全体の流れ
- アカウントを作成し、APIキー(アプリケーションID)を取得
- 提供APIを検索して該当するAPIを探す
- データ取得APIを叩き、目的のデータを取得する
1.アカウントを作成し、APIキー(アプリケーションID)を取得
利用ガイドの掲載とおり、e-StatのAPIを使用するためにはアカウントの作成と、アプリケーションIDを取得する必要がある。 本人確認などややこしい手順は一切なく、通常の無料サービスのように利用目的とメールアドレスやパスワード、本登録をすませばすぐに取得できる。 登録が終わるとマイページが出来、更新情報などをメールアドレスで受け取ることが出来るようになる。
1-1.アカウントを作成し、マイページにログインできる状態にする
利用ガイドからユーザーID(メールアドレス)を入力、登録メールアドレス宛に本登録のためのURLが送られてくるのでURLをクリックして本登録を完了させる
利用機能で「API機能」にチェックを入れ、本登録を完了させる
1-2.マイページにログインし、アプリケーションIDを生成する
ログインページより、ログインを行い、マイページに遷移。
API機能(アプリケーションID発行)に遷移し、アプリケーションIDを生成する。
「名称」「URL」「概要」は管理しやすい任意の文字列でOKです。
ローカルでしか試していませんが、URLは登録URL以外から叩いても正常にレスポンスするようです。(それはそれでどうなんだ・・・)
「発行」を押してアプリケーションIDを生成するとアプリケーションIDが発行されます。
2.提供APIを検索して該当するAPIを探す
データベースページからAPIを検索しても良いが、慣れてくればAPIで該当するAPIを検索しても良い。 政府統計の総合窓口(e-Stat)のAPI 仕様 3.0版より、「http(s)://api.e-stat.go.jp/rest/<バージョン>/app/json/getStatsList?<パラメータ群>」で使いたいAPIの「統計表ID」を取得する
地域メッシュの人口統計データを取得する例
地域メッシュで提供されているのは国税調査で令和2年が最新だったので「searchWord=人口+AND+メッシュ+AND+令和2年」で検索する(GETクエリで半角空白を表現したいときは「+(プラス)」に置き換える) ターミナルを開いてcurlでAPIを叩く。
「人口 AND メッシュ AND 令和2年」で検索するAPI例
結果:
の部分で3次メッシュ(1km)の人口統計データの統計表IDが「800300725」とわかる。 また返却されたJSONはunicodeと圧縮されているので JSON整形 - Webtoolsなどで整形すれば見やすくなる。
参考:
開発支援情報
3.データ取得APIを叩き、目的のデータを取得する
取得した統計表IDを指定し、データを取得するAPIサンプル。
例:令和2年国勢調査 世界測地系(1KMメッシュ)のデータ取得
結果:
例:沖縄県石垣市の地域メッシュコード「36225745」のデータ取得
3次メッシュは6桁なので下記PDFを参考にメッシュコードを指定したデータ取得方法 3次メッシュコード
結果: