住所コード検索

/address/code [GET]

基本情報

概要

住所コードを指定して住所情報を取得します。

URL

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

※Rakuten RapidAPIの場合はURL体系が異なります

出力形式

  • JSON

対応言語

  • ja

パラメータ

パラメータ名 必須 概要 型名 デフォルト値 上下限/選択値 備考
code 住所コード 文字列 ピリオド区切りで複数指定可能です
住所コードを用いた住所検索との違いについては、以下の「住所コード検索と住所検索におけるcodeパラメータの違いについて」をご覧ください
options 追加出力情報 文字列 exact_coord:建物到着地点 追加で出力する情報
※D2Dオプション申込時のみ利用可能です
(Rakuten RapidAPIでは利用不可)
datum 緯度経度の測地系 文字列 wgs84 wgs84:世界測地系
tokyo:旧日本測地系
coord_unit 出力データに含まれる緯度経度の単位 文字列 degree degree:度表記の10進法
millisec:ミリ秒表記

住所コード検索と住所検索におけるcodeパラメータの違いについて

住所コード検索(/address/code)、住所検索におけるcodeパラメータはいずれも
住所コードを用いて住所検索を行うサービスですが、レスポンスに以下のような違いがあります。

【住所コード検索】
指定した住所コードと完全一致する住所を出力する
例:code=13(東京都)を指定した場合、レスポンスは東京都に関する情報のみ
【住所検索のcodeパラメータ】
指定した住所コードの1階層下の住所を一覧で出力する
例:code=13(東京都 / レベル1)を指定した場合、レスポンスは住所コード「13101(東京都千代田区)」をはじめとするレベル2の住所一覧

パラメータ構成例

  • 住所コード「13101001」の住所情報を取得
/address/code?code=13101001

レスポンス

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

Addressオブジェクト

名称 レスポンス名 型名 配列 説明
住所コード code 文字列
住所テキスト name 文字列
郵便番号 postal_code 文字列
住所の緯度経度 coord Coordinateオブジェクト
建物到着地点の緯度経度 exact_coord Coordinateオブジェクト パラメータ「options=exact_coord」指定時のみ出力
データに入っている場合のみ出力
レベル別の住所情報 details AddressDetailオブジェクト

Coordinateオブジェクト

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

AddressDetailオブジェクト

名称 レスポンス名 型名 配列 説明
対象レベルまでの住所コード code 文字列
対象レベルの住所テキスト name 文字列
対象レベルの住所テキストのふりがな ruby 文字列 多言語で利用している場合は未出力
住所のレベル level 文字列 住所レベル
 1: 都道府県
 2: 市区町村
 3: 大字・町
 4: 小字・丁目
 5: 街区
 6: 地番
 7: 枝番

Unitオブジェクト

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

レスポンス例

{
    "items": [
        {
            "code": "13101001000",
            "name": "東京都千代田区飯田橋",
            "postal_code": "1020072",
            "coord": {
                "lat": 35.699513,
                "lon": 139.749264
            },
            "details": [
                {
                    "code": "13",
                    "name": "東京都",
                    "ruby": "とうきょうと",
                    "level": "1"
                },
                {
                    "code": "13101",
                    "name": "千代田区",
                    "ruby": "ちよだく",
                    "level": "2"
                },
                {
                    "code": "13101001",
                    "name": "飯田橋",
                    "ruby": "いいだばし",
                    "level": "3"
                }
            ]
        }
    ],
    "unit": {
        "datum": "wgs84",
        "coord_unit": "degree"
    }
}