住所オートコンプリート
/address/autocomplete [GET]
基本情報
概要
指定したキーワードに対する住所の自動補完候補を取得します。
URL
https://{HOST}/{CID}/v1/address/autocomplete
※Rakuten RapidAPIの場合はURL体系が異なります
出力形式
- JSON
対応言語
- ja
パラメータ
パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
---|---|---|---|---|---|---|
word | ✔ | 住所文字列 | 文字列 | 最小:2文字 最大:50文字 |
検索したい住所名称 アラビア数字・漢数字はそのまま検索します 東京都と入力すると”東京都”がヒットするすべてが出力される |
|
datum | 緯度経度の測地系 | 文字列 | wgs84 | wgs84:世界測地系 tokyo:旧日本測地系 |
||
coord_unit | 出力データに含まれる緯度経度の単位 | 文字列 | degree | degree:度表記の10進法 millisec:ミリ秒表記 |
パラメータ構成例
- 「とうk」で始まる住所名称の候補を検索
/address/autocomplete?word=とうk
レスポンス
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
住所情報 | items | Addressオブジェクト | ○ | 住所情報のまとまり |
単位情報 | unit | Unitオブジェクト | 出力される単位の情報 |
Addressオブジェクト
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
住所コード | code | 文字列 | ||
住所テキスト | name | 文字列 | ||
郵便番号 | postal_code | 文字列 | ||
住所の緯度経度 | coord | Coordinateオブジェクト | ||
レベル別の住所情報 | details | AddressDetailオブジェクト | ○ |
Coordinateオブジェクト
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
住所の代表緯度 | lat | 数値 | ||
住所の代表経度 | lon | 数値 |
AddressDetailオブジェクト
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
対象レベルまでの住所コード | code | 文字列 | ||
対象レベルの住所テキスト | name | 文字列 | ||
対象レベルの住所テキストのふりがな | ruby | 文字列 | 多言語で利用している場合は未出力 | |
住所のレベル | level | 文字列 | 住所レベル 1: 都道府県 2: 市区町村 3: 大字・町 4: 小字・丁目 5: 街区 6: 地番 7: 枝番 |
Unitオブジェクト
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
測地系 | datum | 文字列 | ||
緯度経度の出力形式 | coord_unit | 文字列 |
レスポンス例
{ "items": [ { "code": "13103", "name": "東京都港区", "coord": { "lat": 35.65807, "lon": 139.751413 }, "details": [ { "code": "13", "name": "東京都", "ruby": "とうきょうと", "level": "1" }, { "code": "13103", "name": "港区", "ruby": "みなとく", "level": "2" } ] }, { ・・・ } ], "unit": { "datum": "wgs84", "coord_unit": "degree" } }