RESAS APIを使ってみる(1)
投稿日: 2017年01月22日 更新日: 2017年07月22日
※ 本記事はGoogle Chromeの利用を前提とします。
1. RESAS APIの登録
RESAS APIの登録を行いましょう。
https://opendata.resas-portal.go.jp/
※マイページから「利用規約の確認」を実施しないとAPIにアクセスした際に403 Forbiddenでエラーになるので注意。
登録が完了し、利用規約の確認をすることでAPI-KEYが発行されAPIが使えるようになります。
2. RESAS APIの仕様書
APIの仕様書を確認しましょう。
https://opendata.resas-portal.go.jp/docs/api/v1/index.html
※ネットの記事で/v1-rc.1/でアクセスしている記事が散見されますが、2017年1月22日時点では/v1/が正しいので注意。
3. WEB APIテストクライアントを使ったRESAS APIのテスト
Google ChromeアプリのWEB APIテストクライアントである「Postman」を使って動作確認をしてみましょう。
まずはChromeにPostmanアプリをインストールします。
Google Chromeを使ったweb-apiテストクライアント https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop?hl=ja
都道府県一覧の取得
試しに都道府県一覧を取得してみましょう。
https://opendata.resas-portal.go.jp/docs/api/v1/prefectures.html
GETするURLにhttps://opendata.resas-portal.go.jp/api/v1/prefectures を指定し、HeadersのKeyにX-API-KEYを、Valueに先程取得したAPI-KEYを指定します。
SendでREST APIを叩いて都道府県データが返ってくれば成功です。
市区町村一覧の取得
次に市区町村一覧を取得してみましょう。このAPIはパラメータとしてprefCode(都道府県コード)を渡してあげる必要があります。
https://opendata.resas-portal.go.jp/docs/api/v1/cities.html
GETするURLにhttps://opendata.resas-portal.go.jp/api/v1/cities?prefCode=23 を指定し、HeadersのKeyにX-API-KEYを、Valueに先程取得したAPI-KEYを指定します。
※prefCode=23は愛知県の都道府県コードです。
SendでREST APIを叩くと今度は愛知県の市区町村一覧が取得できます。
RESAS APIは上記2つのAPIで取得できるprefCodeとcityCodeをパラメータとして取るAPIが多いので、上記2つのAPIは覚えておいたほうが良いです。
人口の自然増減の取得
最後に、人口増減を取得してみましょう。このAPIでは先程の2つのAPIで取得したprefCode(都道府県コード)とcityCode(市区町村コード)をパラメータとして使用します。
※ageFromとageToもRequired=true(必須)となっていますが実際には必須ではありません。
https://opendata.resas-portal.go.jp/docs/api/v1/population/nature.html
GETするURLにhttps://opendata.resas-portal.go.jpapi/v1/population/nature?prefCode=23&cityCode=23100 を指定し、同じようにHeadersのKeyにX-API-KEYを、Valueに先程取得したAPI-KEYを指定します。
※prefCode=23は愛知県の都道府県コード、cityCode=23100は名古屋市の市区町村コードです。
4. 最後に
以上がRESAS APIの使い方の基本となります。
RESAS APIには上記以外にも様々なAPIがあります。仕様書を見ながら自分が取得したいデータのAPIを使ってみたください。
次回はサーバサイドのプログラムでRESAS APIを使ってみたいと思います。
名前:宮内 はじめ
Code for Nagoya名誉代表
E2D3名古屋支部長
プログラマーです。GISやデータビズが好きです。このサイトは宮内の個人的なメモです。