事業所別郵便番号検索

/address/postal_code_business [GET]

基本情報

概要

郵便番号を指定して事業所などに紐づく住所情報を取得します。

URL

https://{HOST}/{CID}/v1/address/postal_code_business

※APIマーケットでは提供しておりません

出力形式

JSON

対応言語

ja

出力順

住所コードの昇順

パラメータ

パラメータ名	必須	概要	型名	デフォルト値	上下限/選択値
postal_code	✔	郵便番号文字列	文字列		7桁
datum		緯度経度の測地系	文字列	wgs84	wgs84：世界測地系 tokyo：旧日本測地系
coord_unit		出力データに含まれる緯度経度の単位	文字列	degree	degree：度表記の10進法 millisec：ミリ秒表記

パラメータ構成例

郵便番号「1008792」の住所を検索

/address/postal_code_business?postal_code=1008792

レスポンス

名称	レスポンス名	型名	配列	説明
住所情報	items	PostalCodeオブジェクト	○	住所情報のまとまり
単位情報	unit	Unitオブジェクト		出力される単位の情報

PostalCodeオブジェクト

名称	レスポンス名	型名	配列	説明
郵便番号	postal_code	文字列
住所テキスト	name	文字列
住所の緯度経度	coord	Coordinateオブジェクト
住所の詳細情報	address	Addressオブジェクト	○
郵便番号が紐づく種別	type	文字列		種別情報 office: 事業所個別郵便番号 postal_area: 建物に割り振られた郵便番号 address: 通常の郵便番号

Coordinateオブジェクト

名称	レスポンス名	型名	配列	説明
住所の代表緯度	lat	数値
住所の代表経度	lon	数値

Addressオブジェクト

名称	レスポンス名	型名	配列
住所コード	address_code	文字列
住所テキスト	address_name	文字列
住所の緯度経度	address_coord	Coordinateオブジェクト
レベル別の住所情報	details	AddressDetailオブジェクト	○

AddressDetailオブジェクト

名称	レスポンス名	型名	説明
対象レベルまでの住所コード	code	文字列
対象レベルの住所テキスト	name	文字列
対象レベルの住所テキストのふりがな	ruby	文字列
住所のレベル	level	文字列	住所レベル　1: 都道府県　2: 市区町村　3: 大字・町　4: 小字・丁目

Unitオブジェクト

名称	レスポンス名	型名	配列	説明
測地系	datum	文字列
緯度経度の出力形式	coord_unit	文字列

レスポンス例

{
    "items": [
        {
            "postal_code": "1008792",
            "name": "日本郵便　株式会社",
            "coord": {
                "lat": 35.686836,
                "lon": 139.767099
            },
            "address": {
                "address_code": "13101006002",
                "address_name": "東京都千代田区大手町2丁目",
                "address_coord": {
                    "lat": 35.685169,
                    "lon": 139.768185
            },
            "details": [
                {
                    "code": "13",
                    "name": "東京都",
                    "ruby": "とうきょうと",
                    "level": "1"
                },
                {
                    "code": "13101",
                    "name": "千代田区",
                    "ruby": "ちよだく",
                    "level": "2"
                },
                {
                    "code": "13101006",
                    "name": "大手町",
                    "ruby": "おおてまち",
                    "level": "3"
                },
                {
                    "code": "13101006002",
                    "name": "2丁目",
                    "ruby": "2ちょうめ",
                    "level": "4"
                }
            ]
        },
        "type": "office"
        }
    ],
    "unit": {
        "datum": "wgs84",
        "coord_unit": "degree"
    }
}