住所オートコンプリート
/address/autocomplete [GET]
基本情報
概要
指定したキーワードに対する住所の自動補完候補を取得します。
URL
https://{HOST}/{CID}/v1/address/autocomplete
※APIマーケットの場合はURL体系が異なります
出力形式
- JSON
対応言語
- ja, en, ko, zh-CN, zh-TW, th
パラメータ
| パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
|---|---|---|---|---|---|---|
| word | ✔ | 住所文字列 | 文字列 | 最小：2文字 最大：50文字 |
検索したい住所名称 アラビア数字・漢数字はそのまま検索します 東京都と入力すると”東京都”がヒットするすべてが出力される |
|
| lang | 言語 | 文字列 | ja: 日本語 en: 英語 ko: 韓国語 zh-CN: 中国語(簡体字) zh-TW: 中国語(繁体字) th: タイ語 |
出力する言語を指定します ※多言語オプション申込時のみ利用可能 (APIマーケットでは利用不可) |
||
| datum | 緯度経度の測地系 | 文字列 | wgs84 | wgs84：世界測地系 tokyo：旧日本測地系 |
||
| coord_unit | 出力データに含まれる緯度経度の単位 | 文字列 | degree | degree：度表記の10進法 millisec：ミリ秒表記 |
langパラメータの指定時の注意点
・langパラメータ指定時のレスポンスはMultilingualオブジェクトとして出力されることにご注意ください。
パラメータ構成例
- 「とうk」で始まる住所名称の候補を検索
/address/autocomplete?word=とうk
レスポンス
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 住所情報 | items | Addressオブジェクト | ○ | nullable | 住所情報のまとまり |
| 単位情報 | unit | Unitオブジェクト | 出力される単位の情報 |
Addressオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 住所コード | code | 文字列 | nullable | ||
| 住所テキスト | name | 文字列/Multilingualオブジェクト | langパラメータ指定時は、Multilingualオブジェクトで出力 | ||
| 郵便番号 | postal_code | 文字列 | nullable | ||
| 住所の緯度経度 | coord | Coordinateオブジェクト | |||
| レベル別の住所情報 | 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 | 文字列 | langパラメータでja以外の言語コードを指定時も日本語で出力 | ||
| 住所のレベル | level | 文字列 | 住所レベル 1: 都道府県 2: 市区町村 3: 大字・町 4: 小字・丁目 5: 街区 6: 地番 7: 枝番 |
Unitオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 測地系 | datum | 文字列 | nullable | ||
| 緯度経度の出力形式 | coord_unit | 文字列 | nullable |
レスポンス例
{
"items": [
{
"code": "13103",
"name": "東京都港区",
"coord": {
"lat": 35.65807,
"lon": 139.751413
},
"details": [
{
"code": "13",
"name": "東京都",
"ruby": "とうきょうと",
"level": "1"
},
{
"code": "13103",
"name": "港区",
"ruby": "みなとく",
"level": "2"
}
],
"is_end": false
},
{
・・・
}
],
"unit": {
"datum": "wgs84",
"coord_unit": "degree"
}
}
レスポンス例(多言語返却時 ※word=tokyo&lang=en指定)
{
"items": [
{
"code": "13",
"name": {
"en": "Tokyo"
},
"coord": {
"lat": 35.689553,
"lon": 139.691819
},
"details": [
{
"code": "13",
"name": {
"en": "Tokyo"
},
"ruby": "とうきょうと",
"level": "1"
}
],
"is_end": false
},
{
"code": "13101",
"name": {
"en": "TokyoChiyoda"
},
"coord": {
"lat": 35.694043,
"lon": 139.753586
},
"details": [
{
"code": "13",
"name": {
"en": "Tokyo"
},
"ruby": "とうきょうと",
"level": "1"
},
{
"code": "13101",
"name": {
"en": "Chiyoda"
},
"ruby": "ちよだく",
"level": "2"
}
],
"is_end": false
},
{
・・・
}
],
"unit": {
"datum": "wgs84",
"coord_unit": "degree"
}
}