逆ジオコーディング
/address/reverse_geocoding [GET]
基本情報
概要
緯度経度を指定して住所情報を取得します。
URL
https://{HOST}/{CID}/v1/address/reverse_geocoding
※RapidAPIの場合はURL体系が異なります
出力形式
- JSON
対応言語
- ja, en, ko, zh-CN, zh-TW, th
パラメータ
| パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
|---|---|---|---|---|---|---|
| coord | ✔ | 緯度経度 | 数値(カンマ区切り) | 指定した緯度経度に最も近い住所を検索します | ||
| options | 追加出力情報 | 文字列 | exact_coord：建物到着地点 | 追加で出力する情報 ※D2Dオプション申込時のみ利用可能です (RapidAPIでは利用不可) |
||
| lang | 言語 | 文字列 | ja: 日本語 en: 英語 ko: 韓国語 zh-CN: 中国語(簡体字) zh-TW: 中国語(繁体字) th: タイ語 |
出力する言語を指定します ・ピリオド区切りで複数指定可能 ※多言語オプション申込時のみ利用可能 (RapidAPIでは利用不可) |
||
| datum | 緯度経度の測地系 | 文字列 | wgs84 | wgs84：世界測地系 tokyo：旧日本測地系 |
||
| coord_unit | 出力データに含まれる緯度経度の単位 | 文字列 | degree | degree：度表記の10進法 millisec：ミリ秒表記 |
langパラメータの指定時の注意点
・多言語に対応したレスポンスはMultilingualオブジェクトとして出力されることにご注意ください。
パラメータ構成例
- 緯度経度「35.624822,139.742121」に最も近い住所情報を取得
/address/reverse_geocoding?coord=35.624822,139.742121
レスポンス
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 住所情報 | items | Addressオブジェクト | ○ | 住所情報のまとまり |
| 単位情報 | unit | Unitオブジェクト | 出力される単位の情報 |
Addressオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 住所コード | code | 文字列 | ||
| 住所テキスト | name | 文字列/Multilingualオブジェクト | langパラメータ指定時は、Multilingualオブジェクトで出力 | |
| 郵便番号 | postal_code | 文字列 | ||
| 住所の緯度経度 | coord | Coordinateオブジェクト | ||
| 建物到着地点の緯度経度 | exact_coord | Coordinateオブジェクト | ○ | パラメータ「options=exact_coord」指定時かつデータが存在する場合のみ出力 |
| レベル別の住所情報 | details | AddressDetailオブジェクト | ○ |
Coordinateオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 各地点の代表緯度 | lat | 数値 | ||
| 各地点の代表経度 | lon | 数値 |
AddressDetailオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 対象レベルまでの住所コード | code | 文字列 | ||
| 対象レベルの住所テキスト | name | 文字列/Multilingualオブジェクト | langパラメータ指定時は、Multilingualオブジェクトで出力 | |
| 対象レベルの住所テキストのふりがな | ruby | 文字列 | 多言語出力指定時も日本語で出力 | |
| 住所のレベル | level | 文字列 | 住所レベル 1: 都道府県 2: 市区町村 3: 大字・町 4: 小字・丁目 5: 街区 6: 地番 7: 枝番 |
Multilingualオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 英語名称 | en | 文字列 | ||
| 日本語名称 | ja | 文字列 | ||
| 韓国語名称 | ko | 文字列 | ||
| タイ語名称 | th | 文字列 | ||
| 中国語(簡体字)名称 | zh-CN | 文字列 | ||
| 中国語(繁体字)名称 | zh-TW | 文字列 |
Unitオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 測地系 | datum | 文字列 | ||
| 緯度経度の出力形式 | coord_unit | 文字列 |
レスポンス例
{ "items": [ { "code": "131090060010000600001", "name": "東京都品川区北品川1丁目6-16", "postal_code": "1400001", "coord": { "lat": 35.624696, "lon": 139.740504 }, "details": [ { "code": "13", "name": "東京都", "ruby": "とうきょうと", "level": "1" }, { "code": "13109", "name": "品川区", "ruby": "しながわく", "level": "2" }, { "code": "13109006", "name": "北品川", "ruby": "きたしながわ", "level": "3" }, { "code": "13109006001", "name": "1丁目", "ruby": "1ちょうめ", "level": "4" }, { "code": "1310900600100006", "name": "6", "ruby": "6", "level": "5" }, { "code": "131090060010000600001", "name": "16", "ruby": "16", "level": "6" } ] } ], "unit": { "datum": "wgs84", "coord_unit": "degree" } }
レスポンス例(多言語返却時 ※lang=ja.en.ko指定)
{ "items": [ { "code": "131090060010000600001", "name": { "en": "Tokyo Shinagawa Kita-shinagawa 1-6-16", "ja": "東京都品川区北品川1丁目6-16", "ko": "도쿄도시나가와구기타시나가와1쵸메6-16" }, "postal_code": "1400001", "coord": { "lat": 35.624696, "lon": 139.740504 }, "details": [ { "code": "13", "name": { "en": "Tokyo", "ja": "東京都", "ko": "도쿄도" }, "ruby": "とうきょうと", "level": "1" }, { "code": "13109", "name": { "en": "Shinagawa", "ja": "品川区", "ko": "시나가와구" }, "ruby": "しながわく", "level": "2" }, { "code": "13109006", "name": { "en": "Kita-shinagawa", "ja": "北品川", "ko": "기타시나가와" }, "ruby": "きたしながわ", "level": "3" }, { "code": "13109006001", "name": { "en": "1", "ja": "1丁目", "ko": "1쵸메" }, "ruby": "1ちょうめ", "level": "4" }, { "code": "1310900600100006", "name": { "en": "6", "ja": "6", "ko": "6" }, "ruby": "6", "level": "5" }, { "code": "131090060010000600001", "name": { "en": "16", "ja": "16", "ko": "16" }, "ruby": "16", "level": "6" } ] } ], "unit": { "datum": "wgs84", "coord_unit": "degree" } }