フリーワードでのPOI検索

API名:

poi/word

概要:

リクエストパラメータで指定されるフリーワードに該当するPOI情報を返却します。

※多言語情報の出力には別途契約が必要です。
※全ての地下街・駅構内詳細図情報の出力が基本契約内でご利用頂けることになりました。
ご利用をご希望の方は営業にお申し出ください。

URI:

https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/word

https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/word?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&word=江戸東京博物館

リクエストパラメータ

パラメータ

必須

デフォルト値

説明

word

○

検索ワード
検索語句を指定します。
複数値指定で AND または OR 検索ができます。
複数値指定の上限は50件で１語句の上限は1024文字です。
本項目は必須項目であるため、未指定の場合はエラーとなります。

srchtype

and

検索タイプ
word パラメータを複数値指定した場合の検索タイプを指定します。

and	AND 検索
or	OR 検索

addrcode

絞込み住所コード
検索範囲を指定の住所コードに限定します。市区町村までのコード(2桁または5桁)を指定できます。
複数指定できますが、市区町村を指定する場合は同一都道府県に限定されます。

genrecode

絞込みジャンルコード
検索範囲を指定のジャンルコードに限定します。
5桁または10桁のコードで指定します。
複数値指定するとOR検索で絞込みされます。
ジャンルコード取得はジャンルコード一覧取得APIを使用してください。
ジャンルコード一覧は下記よりダウンロードできます。
・ジャンルコード一覧(Excel)

datum

TOKYO

測地系
返却される住所代表点の測地系を指定します。

limit

0,100

検索結果取得件数
検索結果取得件数を指定します。
取得開始位置の指定範囲は 0~10000 です。
10001以上の値が指定された場合、10000指定と同様の結果となります。
取得件数の指定範囲は 1~1000 です。
1001以上の値が指定された場合、1000指定と同様の結果となります。

llunit

dec

緯度経度形式
緯度経度形式を指定します。

detailid

地下街・駅構内詳細図番号
地下街・駅構内詳細図番号を指定します。

sort

-score

出力順

出力順を指定します。複数値指定できます。
デフォルトは昇順で、降順指定の場合、ソートキーの前方にマイナス（-）を付加します。

score	マッチングスコア
nm	施設名称
kn	施設名カナ
tod	都道府県コード
fnm	完全一致
snm	前方一致
nmlen	名称の文字数

notmultilanguage

多言語情報出力
検索結果に多言語情報を含まないかを真偽値で指定します。
本パラメータはオプション機能で多言語機能を選択されているクライアントIDのみ有効です。

T	多言語情報を含まない
F	多言語情報を含む

出力データ

出力フォーマット

{"status":{"code":"0000",
           "text":"OK"},
 "info":{"hit":4,
         "facet":{"tod":{"13":4},
                  "shk":{"13102":4},
                  "genre":{"0011000110":{"text":"車・交通/駐車場",
                                         "count":4}},
                  "areaInfo":null,
                  "detailInfo":null,
                  "genreMlang":null}},
 "item":[{"text":"東京駅八重洲パーキング東駐車場（高速道路入口）",
          "code":"00000000000002556417",
          "point":{"lat":35.6765639,
                   "lon":139.7736222},
          "kana":"トウキョウエキヤエスパーキングヒガシチュウシャジョウコウソクドウロイリグチ",
          "addressText":"東京都中央区八重洲２丁目１－１",
          "zipcode":"104-0028",
          "phoneNumber":"03-3271-4111",
          "genre":{"code":"0011000110",
                   "text":"車・交通/駐車場"},
          "detail":null,
          "language":null,
          "arrivalInfo":[{"text":"首都高側入口",
                          "kana":"シュトコウガワイリグチ",
                          "exittype":{"code":"01",
                                      "text":"入口"},
                          "arrivalpoint":{"lat":35.6774139,
                                          "lon":139.7726472},
                          "exitpoint":{"lat":35.6774139,
                                       "lon":139.7726472}}]},
　　　　　...]}

キー名

データ型

説明

status

object

ステータス情報が入ります。

code

string

ステータスコードが入ります。

0000	正常終了
0001	タイムアウトが発生またはデータサイズが制限値を超えたため処理が中断された

text

string

ステータス内容に関するテキスト情報が入ります。

info

object

検索結果の情報が入ります。

hit

number

入力された条件に対してヒットした件数が入ります。

facet

object

ファセット情報が入ります。

tod

object

都道府県毎の件数が入ります。

shk

object

市区町村毎の件数が入ります。

genre

object

ジャンルコード毎の件数が入ります。

areainfo

object

エリア毎の件数が入ります。

detailInfo

object

詳細図番号毎の件数が入ります。

genreMlang

object

言語別ジャンルコード毎の件数が入ります。

item

array

POI情報の配列が入ります。
検索結果が0件の場合は空の配列となります。

出力例

[通常出力例(多言語情報出力契約時)]

https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/word?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&word=タリーズコーヒー東京

{"status":{"code":"0000",
"text":"OK"},
"info":{"hit":5,
"facet":{"tod":{"13":5},
"shk":{"13102":2,
"13104":1,
"13107":1,
"13108":1},
"genre":{"0024000140":{"text":"グルメ/その他グルメ",
"count":5}},
"areaInfo":null,
"detailInfo":null,
"genreMlang":{"zh-cn":{"0024000140":{"text":"美食/其他美食",
"count":5}},
"zh-tw":{"0024000140":{"text":"美食/其他美食",
"count":5}},
"en":{"0024000140":{"text":"Gourmet/Other Gourmet",
"count":5}},
"ko":{"0024000140":{"text":"구루메(맛집)/기타 구루메(맛집)",
"count":5}}}}},
"item":[{"text":"タリーズコーヒー東京女子医科大学病院店",
"code":"00000000000002569061",
"point":{"lat":35.69385,
"lon":139.72285},
"kana":"タリーズコーヒートウキョウジョシイカダイガクビョウインテン",
"addressText":"東京都新宿区河田町８－１",
"zipcode":"162-0054",
"phoneNumber":"03-5919-4770",
"genre":{"code":"0024000140",
"text":"グルメ/その他グルメ"},
"detail":null,
"language":{"zh-cn":{"text":"TULLY'S咖啡",
"addressParts":["东京都","新宿区","河田町","8","1"],
"genre":"美食/其他美食"},
"zh-tw":{"text":"TULLY'S咖啡",
"addressParts":["東京都","新宿區","河田町","8","1"],
"genre":"美食/其他美食"},
"en":{"text":"Tully's Coffee",
"addressParts":["Tokyo","Shinjuku-ku","Kawadacho","8","1"],
"genre":"Gourmet/Other Gourmet"},
"ko":{"text":"툴리스 커피",
"addressParts":["도쿄도","신쥬쿠구","카와다쵸","8","1"],
"genre":"구루메(맛집)/기타 구루메(맛집)"}},
"arrivalInfo":[]},
{"text":"タリーズコーヒー東京ダイヤビルディング店",
"code":"00000000000001802211",
"point":{"lat":35.6721167,
"lon":139.7871417},
"kana":"タリーズコーヒートウキョウダイヤビルディングテン",
"addressText":"東京都中央区新川１－２８－３８",
"zipcode":"104-0033",
"phoneNumber":"03-3537-7766",
"genre":{"code":"0024000140",
"text":"グルメ/その他グルメ"},
"detail":null,
"language":{"zh-cn":{"text":"TULLY'S咖啡",
"addressParts":["东京都","中央区","新川","1丁目","28","38"],
"genre":"美食/其他美食"},
"zh-tw":{"text":"TULLY'S咖啡",
"addressParts":["東京都","中央區","新川","1丁目","28","38"],
"genre":"美食/其他美食"},
"en":{"text":"Tully's Coffee",
"addressParts":["Tokyo","Chuo-ku","Shinkawa","1Chome","28","38"],
"genre":"Gourmet/Other Gourmet"},
"ko":{"text":"툴리스 커피",
"addressParts":["도쿄도","츄오구","신카와","1쵸메","28","38"],
"genre":"구루메(맛집)/기타 구루메(맛집)"}},
"arrivalInfo":[]},
...]}

[通常出力例(多言語情報出力未契約時)]

https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/word?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&word=タリーズコーヒー東京

{"status":{"code":"0000",
"text":"OK"},
"info":{"hit":5,
"facet":{"tod":{"13":5},
"shk":{"13102":2,
"13104":1,
"13107":1,
"13108":1},
"genre":{"0024000140":{"text":"グルメ/その他グルメ",
"count":5}},
"areaInfo":null,
"detailInfo":null,
"genreMlang":null}},
"item":[{"text":"タリーズコーヒー東京女子医科大学病院店",
"code":"00000000000002569061",
"point":{"lat":35.69385,
"lon":139.72285},
"kana":"タリーズコーヒートウキョウジョシイカダイガクビョウインテン",
"addressText":"東京都新宿区河田町８－１",
"zipcode":"162-0054",
"phoneNumber":"03-5919-4770",
"genre":{"code":"0024000140",
"text":"グルメ/その他グルメ"},
"detail":null,
"language":null,
"arrivalInfo":[]},
{"text":"タリーズコーヒー東京ダイヤビルディング店",
"code":"00000000000001802211",
"point":{"lat":35.6721167,
"lon":139.7871417},
"kana":"タリーズコーヒートウキョウダイヤビルディングテン",
"addressText":"東京都中央区新川１－２８－３８",
"zipcode":"104-0033",
"phoneNumber":"03-3537-7766",
"genre":{"code":"0024000140",
"text":"グルメ/その他グルメ"},
"detail":null,
"language":null,
"arrivalInfo":[]},
...]}

[検索結果が0件の例]

https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/word?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&word=江戸東京博物館&addrcode=11

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

ヘッダー用問い合わせリンク

メインメニュー

API マニュアル

フリーワードでのPOI検索

検索フォーム

ヘッダー用問い合わせリンク

メインメニュー

現在地

API マニュアル

フリーワードでのPOI検索