×close
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は以下になります。
パラメータ | 値 | 説明 |
---|---|---|
postcode(必須) | string | 1~7桁の半角英数字 |
limit | int | 取得最大候補数 1以上の半角数字を設定してください。デフォルトは20です。 |
page | int | 取得ページ番号 1以上の半角数字を設定してください。デフォルトは1です。 |
hyphen | int | ハイフン出力設定 デフォルトは0です。
|
format | string | レスポンス出力形式 デフォルトはjsonです。
|
(例)
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 | 地名文字列 全角文字のみまたは半角文字のみで入力してください。 |
limit | int | 取得最大候補数 1以上の半角数字を設定してください。デフォルトは20です。 |
page | int | 取得ページ番号 1以上の半角数字を設定してください。デフォルトは1です。 |
hyphen | int | ハイフン出力設定 デフォルトは0です。
|
format | string | レスポンス出力形式 デフォルトはjsonです。
|
mode | int | 上位階層結果取得設定 デフォルトは0です。
|
パラメータ | 値 | 説明 |
---|---|---|
kaisoid(必須) | int | 検索結果で取得できるparentまたはchildの値を設定してください。 0は最上位階層です。 |
limit | int | 取得最大候補数 1以上の半角数字を設定してください。デフォルトは20です。 |
page | int | 取得ページ番号 1以上の半角数字を設定してください。デフォルトは1です。 |
hyphen | int | ハイフン出力設定 デフォルトは0です。
|
format | string | レスポンス出力形式 デフォルトはjsonです。
|
(例)
https://webapi.mss.agrex.co.jp/PostalDataApi/api/search/kaiso?kaisoid=0
パラメータ | 値 | 説明 | |
---|---|---|---|
status | int | ステータス 正常時には200が返ります。400番台は入力エラー、500番台はサーバーのエラーです。 |
|
message | string | エラーメッセージ 正常時は空文字となります。 |
|
seastr | string | 検索文字列 | |
count | int | 取得結果候補数 | |
lists | -- 検索結果が複数の場合は以下が配列として返却されます。 -- | ||
jiscode | string | JISコード | |
postcode | string | 郵便番号 | |
kanatodo | string | カナ住所都道府県 typeが0の時のみ設定されます。 |
|
kanashikucho | string | カナ住所市区町村 typeが0の時のみ設定されます。 |
|
kanachoiki | string | カナ住所町域 typeが0の時のみ設定されます。 |
|
kanahosoku | string | カナ住所補足 typeが0の時のみ設定されます。 |
|
kanjitodo | string | 漢字住所都道府県 | |
kanjishikucho | string | 漢字住所市区町村 | |
kanjichoiki | string | 漢字住所町域 | |
kanjihosoku | string | 漢字住所補足 | |
parent | int | 上位階層ID typeが0の時のみ設定されます。 最上位階層の場合は0が設定されます。 |
|
child | int | 下位階層ID typeが0の時のみ設定されます。 下位階層がない場合は0、存在する場合は1以上の値が設定されます。 |
|
kanajigyosho | string | カナ大口事業所名 typeが1の時のみ設定されます。 |
|
kanjijigyosho | string | 漢字大口事業所名 typeが1の時のみ設定されます。 |
|
type | int | 候補の種類
|
ご利用にはライセンスが必要となります。下記よりお問い合わせください。
お問い合わせ