正規化や住所入力に便利な住所APIをGitHub Pages で公開しました！

Photo by Sangga Rima Roman Selia on Unsplash

住所のAPIを作りました。

この API は、弊社がオープンデータで公開している Geolonia 住所をベースに、GitHub Pages 上でホストしていますので、フォークして使っていただくことも可能です。

仕様

この API には、「都道府県名 & 市区町村名」用と、「大字町丁目及び小字」用の2つの API エンドポイントを用意しています。

都道府県名 & 市区町村名 API

https://geolonia.github.io/japanese-addresses/api/ja.json

この API は、以下の例のように都道府県名をキーにした、市区町村名の配列を値として持つ JSON を返します。

$ curl https://geolonia.github.io/japanese-addresses/api/ja.json | jq .
{
  "北海道": [
    "札幌市中央区",
    "札幌市北区",
    "札幌市東区",
    ...
  ],
  "青森県": [
    "青森市",
    "弘前市",
    "八戸市",
    ...
  ],
  "岩手県": [
    "盛岡市",
    "宮古市",
    "大船渡市",
    ...
  ],
  ...
  ...
  ...
}

大字町丁目及び小字 API

https://geolonia.github.io/japanese-addresses/api/<都道府県名>/<市区町村名>.json

※ 都道府県名及び市区町村名は URL エンコードを行ってください。

例: https://geolonia.github.io/japanese-addresses/api/ja/%E5%8C%97%E6%B5%B7%E9%81%93/%E6%9C%AD%E5%B9%8C%E5%B8%82%E4%B8%AD%E5%A4%AE%E5%8C%BA.json

[
  "旭ケ丘一丁目",
  "旭ケ丘二丁目",
  "旭ケ丘三丁目",
  "旭ケ丘四丁目",
  "旭ケ丘五丁目",
  "旭ケ丘六丁目",
  "大通西十丁目",
  "大通西十一丁目",
  ...
  ...
]

FAQ

API にうちの住所の地名が無いんだけど？

はい、都道府県名及び基礎自治体名は網羅されているはずですが、残念ながら町丁目名以降の地名は完全にすべての地名が網羅されているわけではありません。改善すべくいろいろと検討中です。

都道府県コードや市区町村コードもレスポンスに入れてほしい。

レスポンスを軽くすることを優先して、都道府県コードや市区町村コードはレスポンスに含めていません。

本 API はオープンソースかつ GitHub Pages で公開していますので、ビルド用のソースも公開しています。カスタマイズが必要な方は、フォークしてお好みなレスポンスにカスタマイズしていただくことが可能です。

ライセンスは？

MIT ライセンスとします。この API は、GitHub Pages を利用してホストしており、API をビルドするためのソースコードもリポジトリ上にあります。

https://github.com/geolonia/japanese-addresses