業務画面の住所候補検索
入力された都道府県・市区町村・町域から郵便番号や住所候補を絞り込みます。
Address to postal code
住所から郵便番号を検索。逆引き・候補検索にも使えるAPI。
都道府県・市区町村・町域などの住所項目を条件に、郵便番号や住所候補を検索できます。郵便番号の逆引きだけでなく、業務画面の候補検索、入力途中の補助、保存済み住所の確認まで同じAddress Search APIで実装できます。
HOW IT WORKS
01住所項目都道府県・市区町村・町域
→02Address Search API複数条件で検索
→03郵便番号・住所候補用途に必要な項目を取得
住所項目を明示して検索するため、郵便番号の逆引き、住所入力補助、業務画面の候補検索へ組み込みやすい構成です。
Use cases
住所から郵便番号を検索する3つの利用例
郵便番号の逆引きだけを目的にせず、候補検索や入力補助、保存済み住所の確認まで同じAddress Search APIでつなげられます。
入力途中の候補補助
住所項目を組み合わせ、ユーザーが選べる郵便番号・住所候補を取得します。
保存済み住所の確認
保存・入力された住所項目を条件に、対応する郵便番号候補を確認する処理へ利用できます。
How it works
住所項目を条件に、郵便番号を検索
Address Search APIでは、住所を構成する項目を条件に指定できます。都道府県、市区町村、町域などを組み合わせ、検索結果からpostcodeを取得します。
住所条件を指定
pref、city、townなどをfilterへ指定します。
条件を組み合わせる
AND・OR、完全一致・前方一致・部分一致を用途に応じて組み合わせられます。
郵便番号を取得
fieldsでpostcodeなど必要な項目だけを返せます。
Example
住所から郵便番号を検索するリクエスト例
たとえば「東京都」「千代田区」「丸の内」で始まる町域をAND条件で検索し、郵便番号と住所項目を取得できます。
自由文検索ではありません
filterはfield・operator・valueを明示する条件式です。住所文字列をそのまま渡して自動解析する契約ではありません。
curl --get 'https://apis.postcode-jp.com/api/v6/postcodes' \
--header 'apikey: YOUR_API_KEY' \
--data-urlencode 'filter=pref==東京都;city==千代田区;town==丸の内*' \
--data-urlencode 'fields=postcode,pref,city,town,generalPostcode,officePostcode' \
--data-urlencode 'limit=10'Address data
一般郵便番号と事業所個別郵便番号の両方を扱える
PostcodeJPは一般郵便番号だけでなく、事業所個別郵便番号も住所検索の対象として扱います。検索結果では種類を識別するfieldも利用できます。
GENERAL一般郵便番号generalPostcode
+OFFICE事業所個別郵便番号officePostcode
→ Address Search API →郵便番号・住所候補用途に必要なfieldを取得
FAQ
よくある質問
住所から郵便番号を検索できますか？
はい。都道府県・市区町村・町域などの住所項目をfilter条件として指定し、郵便番号や住所候補を検索できます。
郵便番号の逆引きAPIとして使えますか？
住所項目を条件に郵便番号や住所候補を検索する用途で利用できます。自由形式の住所文字列を1本渡すだけで自動解析する契約ではなく、都道府県・市区町村・町域などの条件を明示して検索します。
入力補助や候補検索にも使えますか？
はい。入力途中の住所項目から郵便番号や住所候補を取得し、業務画面やフォームで候補を提示する処理へ利用できます。
自由形式の住所文字列をそのまま検索できますか？
Address Search APIのfilterは、field・operator・valueを組み合わせる条件検索です。自由形式住所の解析が必要な場合は、Preview提供中のAddress Parserも確認してください。
一般郵便番号と事業所個別郵便番号の両方を検索できますか？
はい。検索結果には一般郵便番号・事業所郵便番号を識別するfieldがあり、住所条件から必要な候補を取得できます。
検索結果は1件に決まりますか？
住所条件によって複数候補が返る場合があります。候補を画面へ表示する、条件を追加するなど、用途に合わせて扱ってください。