エキスパートエンタープライズサブスクリプションサービス 郵便番号サービス

概要

郵便番号情報を検索・取得するAPIサービスです。郵便番号・都道府県・市区町村・町域や、それぞれのフリガナ、大口事業所名などの条件から日本の住所情報を検索できます。結果は1件でも複数でも同一形式で返り、json／toml の出力形式を選べます。

主な機能

• 郵便番号からの取得（/zipcode/{zip}）。同一郵便番号に複数町域がある場合は複数件を返却
• 複数条件（AND結合）での検索。zip／pref／city／town／pref_furi／city_furi／town_furi／office を組み合わせ可能
• 完全一致（既定）／部分一致（partial=1 で %値% 照合）
• ワイルドカード照合（値に *＝0文字以上／?＝1文字 を含めるとパターン照合。partial より優先）
• 郵便番号正規化（ハイフン・空白などの区切りを除去し7桁で照合）
• 出力形式の選択（format=json（既定）／toml）。1件でも複数でも同一形式
• 最大返却件数の指定（max。既定1000・上限1000）

API

エンドポイント

メソッド	パス	説明
GET	/zipcode/{zip}	郵便番号から取得（検索と同一形式で返す）
GET	/zipcode/search	複数条件で検索
GET	/health	ヘルスチェック

パラメータ

検索フィールド（複数指定可・AND結合）:

名前	説明	例
zip	郵便番号（正規化7桁で照合）	zip=0640941
pref	都道府県名	pref=北海道
city	市区町村名	city=札幌市中央区
town	町域名	town=旭ケ丘
pref_furi	都道府県フリガナ	pref_furi=ホッカイドウ
city_furi	市区町村フリガナ	city_furi=サッポロシチュウオウク
town_furi	町域フリガナ	town_furi=アサヒガオカ
office	大口事業所名	office=エキスパート

共通パラメータ:

名前	説明	例
partial	1 を付けると各条件を部分一致（%値%）で照合	partial=1
max	最大返却件数（既定1000・上限1000）	max=50
format	出力形式 json（既定）／toml	format=toml

リクエスト例

# 郵便番号から取得（ハイフンあり／なしいずれも可）
curl "https://zipcode.expert-g.cloud/zipcode/064-0941"
curl "https://zipcode.expert-g.cloud/zipcode/0640941"

# 都道府県・市区町村で検索
curl "https://zipcode.expert-g.cloud/zipcode/search?pref=北海道&city=札幌市中央区"

# 町域を部分一致で検索
curl "https://zipcode.expert-g.cloud/zipcode/search?town=旭ケ丘&partial=1"

# ワイルドカード＋TOML出力
curl "https://zipcode.expert-g.cloud/zipcode/search?pref=東京都&town=*丸の内*&format=toml"

レスポンス例

1件でも複数でも同一形式で返り、results は常に配列です。

{
  "query": {"zip": "0640941"},
  "count": 1,
  "results": [
    {
      "zip": "064-0941",
      "ken_name": "北海道",
      "ken_furi": "ホッカイドウ",
      "city_name": "札幌市中央区",
      "city_furi": "サッポロシチュウオウク",
      "town_name": "旭ケ丘",
      "town_furi": "アサヒガオカ",
      "office_name": "",
      "office_address": ""
    }
  ]
}

format=toml を指定した場合は、count と [[results]] テーブル配列で返します（null値は空文字）。条件不正・形式不正の場合は {"error": "..."} を返します。

ライセンス

本サービスはエキスパートエンタープライズサブスクリプションサービスで提供されます。

• ライセンス詳細: LICENSE

サービス

• エキスパートエンタープライズサブスクリプションサービス

会社情報

• 株式会社エキスパートエンタープライズ
• 株式会社エキスパートソフトウェア