フリーワードでの住所検索

API名: 
address/word
概要: 
リクエストパラメータで指定されるフリーワードに該当する住所情報を返却します。

※多言語情報の出力には別途契約が必要です。

URI: 

http://core.its-mo.com/zmaps/api/apicore/core/v1_0/address/word

<API使用例>
http://core.its-mo.com/zmaps/api/apicore/core/v1_0/address/word?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&word=新橋

リクエストパラメータ
パラメータ 必須 デフォルト値 説明
word - 検索ワード
検索語句を指定します。
読み仮名、英語、中国語(簡体、繁体)、韓国語での検索も可能です。and 条件の複数値指定ができます。

複数値指定の上限は50件で1語句の上限は1024文字です。
本項目は必須項目であるため、未指定の場合はエラーとなります。

datum   TOKYO 測地系
返却される住所代表点の測地系を指定します。
limit   0,100 検索結果取得件数
検索結果取得件数を指定します。
取得件数の指定範囲は 1~1000 です。1000件以上の指定をした場合は1000件指定と同様の結果となります。
addrcode   - 絞込み住所コード
検索範囲を指定の住所コードに限定します。
llunit   dec 緯度経度形式
緯度経度形式を指定します。
ambiguoussearch   F 曖昧検索指定
指定された検索ワードについて、曖昧検索を行うかを真偽値で指定します。
T 曖昧検索を行います。
F 曖昧検索を行いません。

出力データ
出力フォーマット
{"status":{"code":"0000",
           "text":"OK"},
 "info":{"hit":285},
 "item":[{"text":"東京都港区新橋",
          "code":"13103016",
          "point":{"lat":35.6632111,
                   "lon":139.7592972},
          "parts":["東京都","港区","新橋"],
          "kana":"トウキヨウトミナトクシンバシ",
          "zipcode":"105-0004",
          "end":false,
          "bounds":{"sw":{"lat":35.6569947,
                          "lon":139.7546539},
                    "ne":{"lat":35.6663358,
                          "lon":139.7658286}},
          "kanaParts":["トウキヨウト","ミナトク","シンバシ"],
          "level":"oaz",
          "language":{"en":{"text":"TokyoMet. Minatoku Shinbashi",
                            "parts":["TokyoMet.","Minatoku","Shinbashi"]},
                      "zh-cn":{"text":"东京都 港区 新桥",
                               "parts":["东京都","港区","新桥"]},
                      "zh-tw":{"text":"東京都 港區 新橋",
                               "parts":["東京都","港區","新橋"]},
                      "ko":{"text":"도쿄도 미나토구 신바시",
                            "parts":["도쿄도","미나토구","신바시"]}}},
         ...,]}
キー名 データ型 説明
status   object ステータス情報が入ります。
info   object 検索結果の情報が入ります。
  hit number 入力された条件に対してヒットした件数が入ります。
item   array 住所の配列が入ります。検索結果が0件の場合は空の配列となります。

出力例

[通常出力例(多言語情報出力契約時)]
http://core.its-mo.com/zmaps/api/apicore/core/v1_0/address/word?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&word=新橋&addrcode=13

{"status":{"code":"0000",
           "text":"OK"},
 "info":{"hit":272},
 "item":[{"text":"東京都港区新橋",
          "code":"13103016",
          "point":{"lat":35.6632111,
                   "lon":139.7592972},
          "parts":["東京都","港区","新橋"],
          "kana":"トウキヨウトミナトクシンバシ",
          "zipcode":"105-0004",
          "end":false,
          "bounds":{"sw":{"lat":35.6569947,
                          "lon":139.7546539},
                    "ne":{"lat":35.6663358,
                          "lon":139.7658286}},
          "kanaParts":["トウキヨウト","ミナトク","シンバシ"],
          "level":"oaz",
          "language":{"en":{"text":"Tokyo Minato-ku Shinbashi",
                            "parts":["Tokyo","Minato-ku","Shinbashi"]},
                      "zh-cn":{"text":"东京都 港区 新桥",
                               "parts":["东京都","港区","新桥"]},
                      "zh-tw":{"text":"東京都 港區 新橋",
                               "parts":["東京都","港區","新橋"]},
                      "ko":{"text":"도쿄도 미나토구 신바시",
                            "parts":["도쿄도","미나토구","신바시"]}}},
...]}

[通常出力例(多言語情報出力未契約時)]
http://core.its-mo.com/zmaps/api/apicore/core/v1_0/address/word?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&word=新橋&addrcode=13

{"status":{"code":"0000",
           "text":"OK"},
 "info":{"hit":272},
 "item":[{"text":"東京都港区新橋",
          "code":"13103016",
          "point":{"lat":35.6632111,
                   "lon":139.7592972},
          "parts":["東京都","港区","新橋"],
          "kana":"トウキヨウトミナトクシンバシ",
          "zipcode":"105-0004",
          "end":false,
          "bounds":{"sw":{"lat":35.6569947,
                          "lon":139.7546539},
                    "ne":{"lat":35.6663358,
                          "lon":139.7658286}},
          "kanaParts":["トウキヨウト","ミナトク","シンバシ"],
          "level":"oaz",
          "language":null},
...]}

[検索結果が0件の例]
http://core.its-mo.com/zmaps/api/apicore/core/v1_0/address/word?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&word=南新橋

{"status":{"code":"0000",
           "text":"OK"},
 "info":{"hit":0},
 "item":[]}