フリーワードでのPOI検索
API名:
poi/word
概要:
リクエストパラメータで指定されるフリーワードに該当するPOI情報を返却します。
※多言語情報の出力には別途契約が必要です。
※全ての地下街・駅構内詳細図情報の出力が基本契約内でご利用頂けることになりました。
ご利用をご希望の方は営業にお申し出ください。
URI:
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/word
リクエストパラメータ
| パラメータ | 必須 | デフォルト値 | 説明 | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| word | ○ | - |
検索ワード 検索語句を指定します。 複数値指定で AND または OR 検索ができます。 複数値指定の上限は50件で１語句の上限は1024文字です。 本項目は必須項目であるため、未指定の場合はエラーとなります。 |
||||||||||||||||
| srchtype | and |
検索タイプ word パラメータを複数値指定した場合の検索タイプを指定します。
|
|||||||||||||||||
| 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 |
出力順
出力順を指定します。複数値指定できます。
デフォルトは昇順で、降順指定の場合、ソートキーの前方にマイナス（-）を付加します。
|
|||||||||||||||||
| notmultilanguage | F |
多言語情報出力 検索結果に多言語情報を含まないかを真偽値で指定します。 本パラメータはオプション機能で多言語機能を選択されているクライアントIDのみ有効です。
|
出力データ
出力フォーマット
{"status":{"code":"0000", "text":"OK"}, "info":{"hit":4, "facet":{"tod":{"13":4}, "shk":{"13102":4}, "genre":{"0022000120":{"text":"文化施設/博物館", "count":4}}, "areaInfo":string, "detailInfo":{"00000080":{"text":"ＪＲ両国駅", "count":1}}, "genreMlang":null}}, "item":[{"text":"東京都江戸東京博物館", "code":"00000000000000226015", "point":{"lat":35.6933194, "lon":139.7991778}, "kana":"トウキョウトエドトウキョウハクブツカン", "addressText":"東京都墨田区横網１丁目４－１", "zipcode":"130-0015", "phoneNumber":"03-3626-9974", "genre":{"code":"0022000120", "text":"文化施設/博物館"}, "detail":{"areaid": string, "areaname": string, "detailid": string, "detailname": string, "floorname": string, "level": string}, "language": {"zh-cn": {"text": "东京都江户东京博物馆", "addressParts": ["东京都","墨田区","横网","1丁目","4","1"], "genre": "文化设施/博物馆"}, "zh-tw": {"text": "東京都江戶東京博物館", "addressParts": ["東京都","墨田區","横網","1丁目","4","1"], "genre": "文化設施/博物館"}, "en": {"text": "Edo Tokyo Museum", "addressParts": ["Tokyo","Sumida","Yokoami","1","4","1"], "genre": "Cultural Spot/Museum"}, "ko": {"text": "도쿄도 에도 도쿄 박물관", "addressParts": ["도쿄도","스미다구","씨름꾼","1가","4","1"], "genre": "문화 시설/박물관"}}, "arrivalInfo": [{"text": "出入口", "kana": "デイリグチ", "exittype": {"code": "99", "text": "未調査"}, "arrivalpoint": {"lat": 35.6936333, "lon": 139.8006833}, "exitpoint": {"lat": 35.6936333, "lon": 139.8006833}}]}, ... ]}
| キー名 | データ型 | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|
| status | object | ステータス情報が入ります。 | ||||||
| code | string |
ステータスコードが入ります。
|
||||||
| text | string | ステータス内容に関するテキスト情報が入ります。 | ||||||
| info | object | 検索結果の情報が入ります。 | ||||||
| hit | number | 入力された条件に対してヒットした件数が入ります。 | ||||||
| facet | object | ファセット情報が入ります。 | ||||||
| tod | object | 都道府県毎の件数が入ります。 | ||||||
| shk | object | 市区町村毎の件数が入ります。 | ||||||
| genre | object | ジャンルコード毎の件数が入ります。 | ||||||
| areainfo | object | エリア毎の件数が入ります。 | ||||||
| detailInfo | object | 詳細図番号毎の件数が入ります。 | ||||||
| genreMlang | object | 言語別ジャンルコード毎の件数が入ります。 | ||||||
| item | array |
POI情報の配列が入ります。 検索結果が0件の場合は空の配列となります。 |
||||||
出力例
[通常出力例(多言語情報出力契約時)]
if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&word=タリーズコーヒー東京ビッグサイト店
{"status": {"code": "0000", "text": "OK"}, "info": {"hit": 1, "facet": {"tod": {"13": 1}, "shk": {"13108": 1}, "genre": {"0024000140": {"text": "グルメ/その他グルメ", "count": 1}}, "areaInfo": null, "detailInfo": null, "genreMlang": {"zh-cn": {"0024000140": {"text": "美食/其他美食", "count": 1}}, "zh-tw": {"0024000140": {"text": "美食/其他美食", "count": 1}}, "en": {"0024000140": {"text": "Gourmet/Other Gourmet", "count": 1}}, "ko": {"0024000140": {"text": "구루메(맛집)/기타 구루메(맛집)", "count": 1}}}}}, "item": [{"text": "タリーズコーヒー東京ビッグサイト店", "code": "00000000000002761915", "point": {"lat": 35.6265139, "lon": 139.7972972}, "kana": "タリーズコーヒートウキョウビッグサイトテン", "addressText": "東京都江東区有明３－１１－１", "zipcode": "135-0063", "phoneNumber": "03-3527-5086", "genre": {"code": "0024000140", "text": "グルメ/その他グルメ"}, "detail": null, "language": {"zh-cn": {"text": "TULLY'S咖啡 东京BigSite店", "addressParts": [ "东京都", "江东区", "有明", "3", "11", "1"], "genre": "美食/其他美食"}, "zh-tw": {"text": "TULLY'S咖啡 東京BigSite店", "addressParts": [ "東京都", "江東區", "有明", "3", "11", "1"], "genre": "美食/其他美食"}, "en": {"text": "TULLY'S COFFEE Tokyo Big Site", "addressParts": [ "Tokyo", "Koto", "Ariake", "3", "11", "1"], "genre": "Gourmet/Other Gourmet"}, "ko": {"text": "털리스 커피 도쿄 빅사이트점", "addressParts": [ "도쿄도", "코토구", "아리아케", "3", "11", "1"], "genre": "구루메(맛집)/기타 구루메(맛집)"}}, "arrivalInfo": [{"text": "出入口１", "kana": "デイリグチイチ", "exittype": {"code": "99", "text": "未調査"}, "arrivalpoint": {"lat": 35.6269889, "lon": 139.7989194}, "exitpoint": {"lat": 35.6269889, "lon": 139.7989194}}, {"text": "出入口２", "kana": "デイリグチニ", "exittype": {"code": "99", "text": "未調査"}, "arrivalpoint": {"lat": 35.6261694, "lon": 139.7961083}, "exitpoint": {"lat": 35.6261694, "lon": 139.7961083}}]}]}
[通常出力例(多言語情報出力未契約時)]
if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&word=タリーズコーヒー東京ビッグサイト店
{"status": {"code": "0000", "text": "OK"}, "info": {"hit": 1, "facet": {"tod": {"13": 1}, "shk": {"13108": 1}, "genre": {"0024000140": {"text": "グルメ/その他グルメ", "count": 1}}, "areaInfo": null, "detailInfo": null, "genreMlang": null, "item": [{"text": "タリーズコーヒー東京ビッグサイト店", "code": "00000000000002761915", "point": {"lat": 35.6265139, "lon": 139.7972972}, "kana": "タリーズコーヒートウキョウビッグサイトテン", "addressText": "東京都江東区有明３－１１－１", "zipcode": "135-0063", "phoneNumber": "03-3527-5086", "genre": {"code": "0024000140", "text": "グルメ/その他グルメ"}, "detail": null, "language": null, "arrivalInfo": [{"text": "出入口１", "kana": "デイリグチイチ", "exittype": {"code": "99", "text": "未調査"}, "arrivalpoint": {"lat": 35.6269889, "lon": 139.7989194}, "exitpoint": {"lat": 35.6269889, "lon": 139.7989194}}, {"text": "出入口２", "kana": "デイリグチニ", "exittype": {"code": "99", "text": "未調査"}, "arrivalpoint": {"lat": 35.6261694, "lon": 139.7961083}, "exitpoint": {"lat": 35.6261694, "lon": 139.7961083}}]}]}
[検索結果が0件の例]
if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&word=江戸東京博物館&addrcode=11
{"status": {"code": "0000", "text": "OK"}, "info": {"hit": 0, "facet": null}, "item": [] }