×close

　

　

おしらせ

2021-10-01
各種モバイル端末向けに公開していたアプリケーションのサポートとサービス提供を終了しました。誠に申し訳ございませんが、今後は、既にインストール済みのアプリケーションからも検索結果を取得できません。端末からアプリケーションの削除をお願い申し上げます。

サービス概要

EXP-POSTALはWEB APIとして提供します。
HTTPS通信でEXP-POSTALに接続いただくだけで、XML文書またはJSON文書の住所情報を取得できますので、
ご自由にアプリケーションに組み込んでご利用いただけます。

住所情報は日本郵便株式会社の郵便番号データを利用しています。
日本郵便のデータダウンロードサイトに掲載される最新の郵便番号データを使用しており、
お客様システムでのデータ更新の手間なく、最新情報が利用できます。

EXP-POSTALでは以下の検索をご利用いただけます。

・郵便番号検索
  1～7桁の郵便番号での検索、ハイフンの有り無しにかかわらず検索いただけます。
  また、大口事業所個別番号での検索にも対応しております。

  ※大口事業所個別番号について

・地名検索
  都道府県、市区郡町村、町域の地名のいずれかで検索いただけます。

・階層検索
  都道府県から選択し、該当の住所を検索いただけます。

リクエスト・レスポンスフォーマット

各検索機能ごとに対応したURLに適切なリクエストパラメータおよびリクエストヘッダーを用いてGETでアクセスすることにより、
住所情報を取得できます。
リクエストおよびレスポンスはすべてUTF-8でご利用ください。

認証はBASIC認証でおこないます。プログラムからご使用の場合は、リクエストヘッダーに設定の上ご使用ください。

ベースとなるURLは以下になります。
https://webapi.mss.agrex.co.jp/PostalDataApi/api/search

各検索機能のURLは以下になります。

郵便番号検索（すべての郵便番号）
https://webapi.mss.agrex.co.jp/PostalDataApi/api/search/postal?[パラメータ]
郵便番号検索（大口事業所郵便番号以外）
https://webapi.mss.agrex.co.jp/PostalDataApi/api/search/postal/choiki?[パラメータ]
郵便番号検索（大口事業所郵便番号のみ）
https://webapi.mss.agrex.co.jp/PostalDataApi/api/search/postal/jigyosho?[パラメータ]
地名検索
https://webapi.mss.agrex.co.jp/PostalDataApi/api/search/address?[パラメータ]
階層検索
https://webapi.mss.agrex.co.jp/PostalDataApi/api/search/kaiso?[パラメータ]

各API仕様

郵便番号検索入力パラメーター

パラメータ値説明
postcode（必須）string１～７桁の半角英数字
limitint取得最大候補数
1以上の半角数字を設定してください。デフォルトは20です。
pageint取得ページ番号
1以上の半角数字を設定してください。デフォルトは1です。
hyphenintハイフン出力設定
デフォルトは0です。
  • 0：ハイフンなし
  • 1：ハイフンあり
formatstringレスポンス出力形式
デフォルトはjsonです。
  • json：JSON形式
  • xml：XML形式

（例）
https://webapi.mss.agrex.co.jp/PostalDataApi/api/search/postal?postcode=183-00&page=2
https://webapi.mss.agrex.co.jp/PostalDataApi/api/search/postal/choiki?postcode=1830005&page=1&limit=10
https://webapi.mss.agrex.co.jp/PostalDataApi/api/search/postal/jigyosho?postcode=10&page=2&hyphen=1


地名文字列検索入力パラメーター

パラメータ値説明
address（必須）string地名文字列
全角文字のみまたは半角文字のみで入力してください。
limitint取得最大候補数
1以上の半角数字を設定してください。デフォルトは20です。
pageint取得ページ番号
1以上の半角数字を設定してください。デフォルトは1です。
hyphenintハイフン出力設定
デフォルトは0です。
  • 0：ハイフンなし
  • 1：ハイフンあり
formatstringレスポンス出力形式
デフォルトはjsonです。
  • json：JSON形式
  • xml：XML形式
modeint上位階層結果取得設定
デフォルトは0です。
  • 0：取得しない
  • 1：検索結果なしの場合、検索できた階層までの結果を取得します。

（例）
https://webapi.mss.agrex.co.jp/PostalDataApi/api/search/address?address=ﾄｳｷｮｳﾄﾌﾁｭｳｼ1-1&format=json&mode=1


階層検索入力パラメーター

パラメータ値説明
kaisoid（必須）int検索結果で取得できるparentまたはchildの値を設定してください。
0は最上位階層です。
limitint取得最大候補数
1以上の半角数字を設定してください。デフォルトは20です。
pageint取得ページ番号
1以上の半角数字を設定してください。デフォルトは1です。
hyphenintハイフン出力設定
デフォルトは0です。
  • 0：ハイフンなし
  • 1：ハイフンあり
formatstringレスポンス出力形式
デフォルトはjsonです。
  • json：JSON形式
  • xml：XML形式

（例）
https://webapi.mss.agrex.co.jp/PostalDataApi/api/search/kaiso?kaisoid=0


出力パラメータ

パラメータ値説明
statusintステータス
正常時には200が返ります。400番台は入力エラー、500番台はサーバーのエラーです。
messagestringエラーメッセージ
正常時は空文字となります。
seastrstring検索文字列
countint取得結果候補数
lists-- 検索結果が複数の場合は以下が配列として返却されます。 --
jiscodestringJISコード
postcodestring郵便番号
kanatodostringカナ住所都道府県
typeが0の時のみ設定されます。
kanashikuchostringカナ住所市区町村
typeが0の時のみ設定されます。
kanachoikistringカナ住所町域
typeが0の時のみ設定されます。
kanahosokustringカナ住所補足
typeが0の時のみ設定されます。
kanjitodostring漢字住所都道府県
kanjishikuchostring漢字住所市区町村
kanjichoikistring漢字住所町域
kanjihosokustring漢字住所補足
parentint上位階層ID
typeが0の時のみ設定されます。
最上位階層の場合は0が設定されます。
childint下位階層ID
typeが0の時のみ設定されます。
下位階層がない場合は0、存在する場合は1以上の値が設定されます。
kanajigyoshostringカナ大口事業所名
typeが1の時のみ設定されます。
kanjijigyoshostring漢字大口事業所名
typeが1の時のみ設定されます。
typeint候補の種類
  • 0：町域の郵便番号住所候補
  • 1：大口事業所郵便番号住所候補

お問い合わせ

ご利用にはライセンスが必要となります。下記よりお問い合わせください。

お問い合わせ