フリーワードでの駅POI検索
API名:
station/word
概要:
リクエストパラメータで指定される駅名称を元に該当する駅情報を返却します。
※多言語情報の出力には別途契約が必要です。
URI:
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/station/word
<API使用例>
リクエストパラメータ
| パラメータ | 必須 | デフォルト値 | 説明 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| word | ○ | - |
検索ワード 検索語句を指定します。 検索語句はカナ指定もできます。 検索語句の文字数の上限は1024文字です。 本項目は必須項目であるため、未指定の場合はエラーとなります。 |
||||||||||||
| addrcode | - |
絞込み住所コード 検索範囲を指定の住所コードに限定します。市区町村までのコード(2桁または5桁)を指定できます。 複数指定できますが、市区町村を指定する場合は同一都道府県に限定されます。 |
|||||||||||||
| linecode | - |
絞込み路線コード 検索範囲を指定の路線コードに限定します。 |
|||||||||||||
| datum | TOKYO |
測地系 返却される住所代表点の測地系を指定します。 |
|||||||||||||
| limit | 0,100 |
検索結果取得件数 検索結果取得件数を指定します。 取得開始位置の指定範囲は 0～10000 です。 10001 以上の指定をした場合は10000 指定と同様の結果となります。 取得件数の指定範囲は 1~1000 です。 1001以上の指定をした場合は1000指定と同様の結果となります。 |
|||||||||||||
| llunit | dec |
緯度経度形式 緯度経度形式を指定します。 |
|||||||||||||
| sort | -score |
出力順 出力順を指定します。複数値指定できます。 デフォルトは昇順で、降順指定の場合、ソートキーの前方にマイナス(-)を付加します。
|
|||||||||||||
| notmultilanguage | F |
多言語情報出力 検索結果に多言語情報を含まないかを真偽値で指定します。 本パラメータはオプション機能で多言語機能を選択されているクライアントIDのみ有効です。
|
出力データ
出力フォーマット
{ "status": { "code": "0000", "text": "OK" }, "info": { "hit": 3, "facet": { "tod": { "13": 3 }, "shk": { "13104": 3 } } }, "item": [ { "poi": { "text": "四ツ谷駅(JR 中央本線)", "code": "20000000000000002873", "point": { "lat": 35.6827778, "lon": 139.7338972 }, "kana": "ヨツヤエキ", "addressText": "東京都新宿区四谷１丁目５", "zipcode": "160-0004", "phoneNumber": "03-3351-1010", "genre": null, "detail": null, "language": { "zh-cn": { "text": "四谷站(JR中央本线)", "addressParts": [ "东京都", "新宿区", "四谷", "1丁目", "", "5" ], "genre": null }, "zh-tw": { "text": "四谷站(JR中央本線)", "addressParts": [ "東京都", "新宿區", "四谷", "1丁目", "", "5" ], "genre": null }, "en": { "text": "Yotsuya (JR Chuo Main Line)", "addressParts": [ "Tokyo", "Shinjuku", "Yotsuya", "1", "", "5" ], "genre": null }, "ko": { "text": "요츠야 역(JR 츄오 본선)", "addressParts": [ "도쿄도", "신쥬쿠구", "요츠야", "1쵸메", "", "5" ], "genre": null } }, "arrivalInfo": [ { "text": "１（赤坂口）", "kana": "イチアカサカグチ", "exittype": { "code": "03", "text": "出入口" }, "arrivalpoint": { "lat": 35.6824611, "lon": 139.7333528 }, "exitpoint": { "lat": 35.6819889, "lon": 139.7331806 } }, ... ] }, "line": { "code": "0109", "text": "JR 中央本線", "textMulti": { "zh-cn": "JR中央本线", "zh-tw": "JR中央本線", "en": "JR Chuo Main Line", "ko": "JR 츄오 본선" } } }, ... ] }
| キー名 | データ型 | 説明 | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| status | object | ステータス情報が入ります。 | |||||||||||||||||
| code | string |
ステータスコードが入ります。
|
|||||||||||||||||
| text | string | ステータス内容に関するテキスト情報が入ります。 | |||||||||||||||||
| info | object | 検索結果の情報が入ります。 | |||||||||||||||||
| hit | number | 入力された条件に対してヒットした件数が入ります。 | |||||||||||||||||
| facet | object | ファセット情報が入ります。 | |||||||||||||||||
| tod | object | 都道府県毎の件数が入ります。 | |||||||||||||||||
| shk | object | 市区町村毎の件数が入ります。 | |||||||||||||||||
| item | array |
検索結果の配列が入ります。 検索結果が0件の場合は空の配列となります。 |
|||||||||||||||||
| poi | object | POI情報が入ります。 | |||||||||||||||||
| line | object | 路線情報が入ります。 | |||||||||||||||||
| code | number | 路線コードが入ります。 | |||||||||||||||||
| text | string | 路線名称が入ります。 | |||||||||||||||||
| textMulti | object |
翻訳情報のオブジェクトが入ります。
|
|||||||||||||||||
出力例
[通常出力例(多言語情報出力契約時)]
if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&word=四ツ谷駅
{ "status": { "code": "0000", "text": "OK" }, "info": { "hit": 3, "facet": { "tod": { "13": 3 }, "shk": { "13104": 3 } } }, "item": [ { "poi": { "text": "四ツ谷駅(JR 中央本線)", "code": "20000000000000002873", "point": { "lat": 35.6827778, "lon": 139.7338972 }, "kana": "ヨツヤエキ", "addressText": "東京都新宿区四谷１丁目５", "zipcode": "160-0004", "phoneNumber": "03-3351-1010", "genre": null, "detail": null, "language": { "zh-cn": { "text": "四谷站(JR中央本线)", "addressParts": [ "东京都", "新宿区", "四谷", "1丁目", "", "5" ], "genre": null }, "zh-tw": { "text": "四谷站(JR中央本線)", "addressParts": [ "東京都", "新宿區", "四谷", "1丁目", "", "5" ], "genre": null }, "en": { "text": "Yotsuya (JR Chuo Main Line)", "addressParts": [ "Tokyo", "Shinjuku", "Yotsuya", "1", "", "5" ], "genre": null }, "ko": { "text": "요츠야 역(JR 츄오 본선)", "addressParts": [ "도쿄도", "신쥬쿠구", "요츠야", "1쵸메", "", "5" ], "genre": null } }, "arrivalInfo": [ { "text": "１（赤坂口）", "kana": "イチアカサカグチ", "exittype": { "code": "03", "text": "出入口" }, "arrivalpoint": { "lat": 35.6824611, "lon": 139.7333528 }, "exitpoint": { "lat": 35.6819889, "lon": 139.7331806 } }, { "text": "麹町口", "kana": "コウジマチグチ", "exittype": { "code": "03", "text": "出入口" }, "arrivalpoint": { "lat": 35.6826611, "lon": 139.7343556 }, "exitpoint": { "lat": 35.6826611, "lon": 139.7343556 } }, { "text": "四ツ谷口", "kana": "ヨツヤグチ", "exittype": { "code": "03", "text": "出入口" }, "arrivalpoint": { "lat": 35.6828139, "lon": 139.7327667 }, "exitpoint": { "lat": 35.6828139, "lon": 139.7327667 } } ] }, "line": { "code": "0109", "text": "JR 中央本線", "textMulti": { "zh-cn": "JR中央本线", "zh-tw": "JR中央本線", "en": "JR Chuo Main Line", "ko": "JR 츄오 본선" } } }, { "poi": { "text": "四ツ谷駅(東京メトロ 南北線)", "code": "20000000000000003019", "point": { "lat": 35.6827778, "lon": 139.7338972 }, "kana": "ヨツヤエキ", "addressText": "東京都新宿区四谷１丁目５", "zipcode": "160-0004", "phoneNumber": "03-3351-1010", "genre": null, "detail": null, "language": { "zh-cn": { "text": "四谷站(东京Metro地铁南北线)", "addressParts": [ "东京都", "新宿区", "四谷", "1丁目", "", "5" ], "genre": null }, "zh-tw": { "text": "四谷站(東京Metro地鐵南北線)", "addressParts": [ "東京都", "新宿區", "四谷", "1丁目", "", "5" ], "genre": null }, "en": { "text": "Yotsuya (Tokyo Metro Namboku Line)", "addressParts": [ "Tokyo", "Shinjuku", "Yotsuya", "1", "", "5" ], "genre": null }, "ko": { "text": "요츠야 역(도쿄메트로 난보쿠선)", "addressParts": [ "도쿄도", "신쥬쿠구", "요츠야", "1쵸메", "", "5" ], "genre": null } }, "arrivalInfo": [ { "text": "１（赤坂口）", "kana": "イチアカサカグチ", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6824639, "lon": 139.7333444 }, "exitpoint": { "lat": 35.6819889, "lon": 139.7331722 } }, { "text": "２", "kana": "ニ", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6830833, "lon": 139.7326417 }, "exitpoint": { "lat": 35.6829361, "lon": 139.7325833 } }, { "text": "３（四ツ谷口）", "kana": "サンヨツヤグチ", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6832583, "lon": 139.7333583 }, "exitpoint": { "lat": 35.6831694, "lon": 139.7332944 } } ] }, "line": { "code": "0510", "text": "東京メトロ 南北線", "textMulti": { "zh-cn": "东京Metro地铁南北线", "zh-tw": "東京Metro地鐵南北線", "en": "Tokyo Metro Namboku Line", "ko": "도쿄메트로 난보쿠선" } } }, { "poi": { "text": "四ツ谷駅(東京メトロ 丸ノ内線)", "code": "20000000000000003020", "point": { "lat": 35.6827778, "lon": 139.7338972 }, "kana": "ヨツヤエキ", "addressText": "東京都新宿区四谷１丁目５", "zipcode": "160-0004", "phoneNumber": "03-3351-1010", "genre": null, "detail": null, "language": { "zh-cn": { "text": "四谷站(东京Metro地铁丸之内线)", "addressParts": [ "东京都", "新宿区", "四谷", "1丁目", "", "5" ], "genre": null }, "zh-tw": { "text": "四谷站(東京Metro地鐵丸之內線)", "addressParts": [ "東京都", "新宿區", "四谷", "1丁目", "", "5" ], "genre": null }, "en": { "text": "Yotsuya (Tokyo Metro Marunouchi Line)", "addressParts": [ "Tokyo", "Shinjuku", "Yotsuya", "1", "", "5" ], "genre": null }, "ko": { "text": "요츠야 역(도쿄메트로 마루노우치선)", "addressParts": [ "도쿄도", "신쥬쿠구", "요츠야", "1쵸메", "", "5" ], "genre": null } }, "arrivalInfo": [ { "text": "１（赤坂口）", "kana": "イチアカサカグチ", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6824639, "lon": 139.7333444 }, "exitpoint": { "lat": 35.6819889, "lon": 139.7331722 } }, { "text": "２", "kana": "ニ", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6830833, "lon": 139.7326417 }, "exitpoint": { "lat": 35.6829361, "lon": 139.7325833 } }, { "text": "３（四ツ谷口）", "kana": "サンヨツヤグチ", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6832583, "lon": 139.7333583 }, "exitpoint": { "lat": 35.6831694, "lon": 139.7332944 } } ] }, "line": { "code": "0508", "text": "東京メトロ 丸ノ内線", "textMulti": { "zh-cn": "东京Metro地铁丸之内线", "zh-tw": "東京Metro地鐵丸之內線", "en": "Tokyo Metro Marunouchi Line", "ko": "도쿄메트로 마루노우치선" } } } ] }
[通常出力例(多言語情報出力未契約時)]
if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&word=四ツ谷駅
{ "status": { "code": "0000", "text": "OK" }, "info": { "hit": 3, "facet": { "tod": { "13": 3 }, "shk": { "13104": 3 } } }, "item": [ { "poi": { "text": "四ツ谷駅(JR 中央本線)", "code": "20000000000000002873", "point": { "lat": 35.6827778, "lon": 139.7338972 }, "kana": "ヨツヤエキ", "addressText": "東京都新宿区四谷１丁目５", "zipcode": "160-0004", "phoneNumber": "03-3351-1010", "genre": null, "detail": null, "language": null, "arrivalInfo": [ { "text": "１（赤坂口）", "kana": "イチアカサカグチ", "exittype": { "code": "03", "text": "出入口" }, "arrivalpoint": { "lat": 35.6824611, "lon": 139.7333528 }, "exitpoint": { "lat": 35.6819889, "lon": 139.7331806 } }, { "text": "麹町口", "kana": "コウジマチグチ", "exittype": { "code": "03", "text": "出入口" }, "arrivalpoint": { "lat": 35.6826611, "lon": 139.7343556 }, "exitpoint": { "lat": 35.6826611, "lon": 139.7343556 } }, { "text": "四ツ谷口", "kana": "ヨツヤグチ", "exittype": { "code": "03", "text": "出入口" }, "arrivalpoint": { "lat": 35.6828139, "lon": 139.7327667 }, "exitpoint": { "lat": 35.6828139, "lon": 139.7327667 } } ] }, "line": { "code": "0109", "text": "JR 中央本線", "textMulti": null } }, { "poi": { "text": "四ツ谷駅(東京メトロ 南北線)", "code": "20000000000000003019", "point": { "lat": 35.6827778, "lon": 139.7338972 }, "kana": "ヨツヤエキ", "addressText": "東京都新宿区四谷１丁目５", "zipcode": "160-0004", "phoneNumber": "03-3351-1010", "genre": null, "detail": null, "language": null, "arrivalInfo": [ { "text": "１（赤坂口）", "kana": "イチアカサカグチ", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6824639, "lon": 139.7333444 }, "exitpoint": { "lat": 35.6819889, "lon": 139.7331722 } }, { "text": "２", "kana": "ニ", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6830833, "lon": 139.7326417 }, "exitpoint": { "lat": 35.6829361, "lon": 139.7325833 } }, { "text": "３（四ツ谷口）", "kana": "サンヨツヤグチ", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6832583, "lon": 139.7333583 }, "exitpoint": { "lat": 35.6831694, "lon": 139.7332944 } } ] }, "line": { "code": "0510", "text": "東京メトロ 南北線", "textMulti": null } }, { "poi": { "text": "四ツ谷駅(東京メトロ 丸ノ内線)", "code": "20000000000000003020", "point": { "lat": 35.6827778, "lon": 139.7338972 }, "kana": "ヨツヤエキ", "addressText": "東京都新宿区四谷１丁目５", "zipcode": "160-0004", "phoneNumber": "03-3351-1010", "genre": null, "detail": null, "language": null, "arrivalInfo": [ { "text": "１（赤坂口）", "kana": "イチアカサカグチ", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6824639, "lon": 139.7333444 }, "exitpoint": { "lat": 35.6819889, "lon": 139.7331722 } }, { "text": "２", "kana": "ニ", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6830833, "lon": 139.7326417 }, "exitpoint": { "lat": 35.6829361, "lon": 139.7325833 } }, { "text": "３（四ツ谷口）", "kana": "サンヨツヤグチ", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6832583, "lon": 139.7333583 }, "exitpoint": { "lat": 35.6831694, "lon": 139.7332944 } } ] }, "line": { "code": "0508", "text": "東京メトロ 丸ノ内線", "textMulti": null } } ] }
[検索結果が0件の例]
if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&word=日本橋&addrcode=11
{ "status": { "code": "0000", "text": "OK" }, "info": { "hit": 0, "facet": null }, "item": [] }