住所コード検索
/address/code [GET]
基本情報
概要
住所コードを指定して住所情報を取得します。
URL
https://{HOST}/{CID}/v1/address/code
※APIマーケットの場合はURL体系が異なります
出力形式
- JSON
対応言語
- ja, en, ko, zh-CN, zh-TW, th
パラメータ
| パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
|---|---|---|---|---|---|---|
| code | ✔ | 住所コード | 文字列 | ピリオド区切りで複数指定可能です 住所コードを用いた住所検索との違いについては、こちらをご覧ください |
||
| options | 追加出力情報 | 文字列 | exact_coord：建物到着地点 | 追加で出力する情報 ※D2Dオプション申込時のみ利用可能です (APIマーケットでは利用不可) |
||
| lang | 言語 | 文字列 | ja: 日本語 en: 英語 ko: 韓国語 zh-CN: 中国語(簡体字) zh-TW: 中国語(繁体字) th: タイ語 |
出力する言語を指定します ・ピリオド区切りで複数指定可能 ※多言語オプション申込時のみ利用可能 (APIマーケットでは利用不可) |
||
| datum | 緯度経度の測地系 | 文字列 | wgs84 | wgs84：世界測地系 tokyo：旧日本測地系 |
||
| coord_unit | 出力データに含まれる緯度経度の単位 | 文字列 | degree | degree：度表記の10進法 millisec：ミリ秒表記 |
住所コード検索と住所検索におけるcodeパラメータの違いについて
住所コード検索（/address/code）、住所検索におけるcodeパラメータはいずれも
住所コードを用いて住所検索を行うサービスですが、レスポンスに以下のような違いがあります。
【住所コード検索】
指定した住所コードと完全一致する住所を出力する
例：code=13（東京都）を指定した場合、レスポンスは東京都に関する情報のみ
【住所検索のcodeパラメータ】
指定した住所コードの1階層下の住所を一覧で出力する
例：code=13（東京都 / レベル1）を指定した場合、レスポンスは住所コード「13101（東京都千代田区）」をはじめとするレベル2の住所一覧
langパラメータの指定時の注意点
・多言語に対応したレスポンスはMultilingualオブジェクトとして出力されることにご注意ください。
パラメータ構成例
- 住所コード「13101001」の住所情報を取得
/address/code?code=13101001
レスポンス
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 住所情報 | items | Addressオブジェクト | ○ | nullable | 住所情報のまとまり |
| 単位情報 | unit | Unitオブジェクト | 出力される単位の情報 |
Addressオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 住所コード | code | 文字列 | nullable | ||
| 住所テキスト | name | 文字列/Multilingualオブジェクト | langパラメータ指定時は、Multilingualオブジェクトで出力 | ||
| 郵便番号 | postal_code | 文字列 | nullable | ||
| 住所の緯度経度 | coord | Coordinateオブジェクト | |||
| 建物到着地点の緯度経度 | exact_coord | Coordinateオブジェクト | ○ | nullable | パラメータ「options=exact_coord」指定時かつデータが存在する場合のみ出力 |
| レベル別の住所情報 | details | AddressDetailオブジェクト | ○ | ||
| 住所階層終端フラグ | is_end | 真偽値 | nullable | 住所階層の深さが最下であることを表すフラグ 以下のいずれかが返却される true：詳細な住所は存在しない false：詳細な住所が存在する データが存在する場合のみ出力 |
Multilingualオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 英語名称 | en | 文字列 | nullable | ||
| 日本語名称 | ja | 文字列 | |||
| 韓国語名称 | ko | 文字列 | nullable | ||
| タイ語名称 | th | 文字列 | nullable | ||
| 中国語(簡体字)名称 | zh-CN | 文字列 | nullable | ||
| 中国語(繁体字)名称 | zh-TW | 文字列 | nullable |
住所情報が存在した場合のlangパラメータ指定言語の返却について
langパラメータの中に'ja'が含まれていた場合'ja'の値は必ず返却さ
Coordinateオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 各地点の代表緯度 | lat | 数値 | |||
| 各地点の代表経度 | lon | 数値 |
AddressDetailオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 対象レベルまでの住所コード | code | 文字列 | nullable | ||
| 対象レベルの住所テキスト | name | 文字列/Multilingualオブジェクト | langパラメータ指定時は、Multilingualオブジェクトで出力 | ||
| 対象レベルの住所テキストのふりがな | ruby | 文字列 | 多言語出力指定時も日本語で出力 | ||
| 住所のレベル | level | 文字列 | 住所レベル 1: 都道府県 2: 市区町村 3: 大字・町 4: 小字・丁目 5: 街区 6: 地番 7: 枝番 |
Unitオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 測地系 | datum | 文字列 | nullable | ||
| 緯度経度の出力形式 | coord_unit | 文字列 | nullable |
レスポンス例
{
"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"
}
],
"is_end": false
}
],
"unit": {
"datum": "wgs84",
"coord_unit": "degree"
}
}
レスポンス例(多言語返却時 ※lang=ja.en.ko指定)
{
"items": [
{
"code": "13101001000",
"name": {
"en": "Tokyo Chiyoda Iidabashi",
"ja": "東京都千代田区飯田橋",
"ko": "도쿄도치요다구이다바시"
},
"postal_code": "1020072",
"coord": {
"lat": 35.699887,
"lon": 139.748119
},
"details": [
{
"code": "13",
"name": {
"en": "Tokyo",
"ja": "東京都",
"ko": "도쿄도"
},
"ruby": "とうきょうと",
"level": "1"
},
{
"code": "13101",
"name": {
"en": "Chiyoda",
"ja": "千代田区",
"ko": "치요다구"
},
"ruby": "ちよだく",
"level": "2"
},
{
"code": "13101001",
"name": {
"en": "Iidabashi",
"ja": "飯田橋",
"ko": "이다바시"
},
"ruby": "いいだばし",
"level": "3"
}
],
"is_end": false
}
],
"unit": {
"datum": "wgs84",
"coord_unit": "degree"
}
}