はじめに

郵便番号の検索APIを使って、住所検索を行ってみる。

環境

1
2

curl 7.81.0 (x86_64-pc-linux-gnu) libcurl/7.81.0 OpenSSL/3.0.2 zlib/1.2.11 brotli/1.0.9 zstd/1.4.8 libidn2/2.3.2 libpsl/0.21.0 (+libidn2/2.3.2) libssh/0.9.6/openssl/zlib nghttp2/1.43.0 librtmp/2.3 OpenLDAP/2.5.17
jq-1.6

APIの利用

を利用する。

APIの仕様も上記に記載されているので、それに則ってAPIをコールする。

住所検索

[ベースURL] + [パラメータ]という形式なので下記のように呼び出す。

zipcode
1000001
1

curl https://zipcloud.ibsnet.co.jp/api/search?zipcode=1000001 | jq

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

{
  "message": null,
  "results": [
    {
      "address1": "東京都",
      "address2": "千代田区",
      "address3": "千代田",
      "kana1": "ﾄｳｷｮｳﾄ",
      "kana2": "ﾁﾖﾀﾞｸ",
      "kana3": "ﾁﾖﾀﾞ",
      "prefcode": "13",
      "zipcode": "1000001"
    }
  ],
  "status": 200
}

利用用途

  • Webサイトのフォームにおける住所検索
  • 住所マスタの更新や整合性チェック

等が考えられる

ただ、利用規約に則ったものでないといけないので注意が必要 https://zipcloud.ibsnet.co.jp/rule/api

参考

おわりに

WebAPIを活用できるようになりたいので、まずは郵便番号から住所を検索するAPIを使ってみた。
アプリケーションに組み込めるようになると楽しいので、他にも便利なAPIがないかを調査したいところ。