駅/バス停オートコンプリート

/transport_node/autocomplete [GET]

基本情報

概要

指定したワードに対する駅/バス停名の自動補完候補を取得します。

URL

https://{HOST}/{CID}/v1/transport_node/autocomplete

※APIマーケットの場合はURL体系が異なります

出力形式

JSON

対応言語

ja

パラメータ

パラメータ名	必須	概要	型名	デフォルト値	上下限/選択値	備考
word	✔	検索ワード	文字列		最小：2文字最大：50文字	検索したい駅/バス停名称アラビア数字・漢数字はそのまま検索します
word_match		検索方法	文字列	prefix		ワードの検索方法 prefix : 前方一致 partial : 部分一致
type		出力する交通機関	文字列		交通機関タイプより指定	ピリオド区切りで複数指定できます出力する駅・バス停種別を限定したい場合にご利用ください（未指定の場合は全種別が検索されます）バス停の情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可)
coord		検索地点	カンマ区切りの数値			検索を行う基準地点の緯度経度・「緯度,経度」の順で指定・ミリ秒表記、度表記(10進数)に対応 coordパラメータ指定時には指定した緯度経度からの距離順に返却されます
radius		検索範囲の半径(単位 : m)	数値	10000	最大値：100000	coord指定時のみ有効
link		路線ID	文字列			ピリオド区切りで複数指定できます
bus_data		バスデータ利用情報	文字列		timetable : バスデータを利用するかどうかのフラグ	バス停の情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可)
datum		緯度経度の測地系	文字列	wgs84	wgs84：世界測地系 tokyo：旧日本測地系
coord_unit		出力データに含まれる緯度経度の単位	文字列	degree	degree：度表記の10進法 millisec：ミリ秒表記

type（交通機関タイプ）

'type' は以下の文字列を取り得ます。

文字列	概要	備考
station	鉄道駅
airport	空港
port	港
busstop	路線バスのバス停	バス停の情報取得は、オプション機能のため、別途契約が必要となります
shuttle_busstop	空港連絡バスのバス停
highway_busstop	高速バスのバス停	バス停の情報取得は、オプション機能のため、別途契約が必要となります

データの出力件数について

当APIでは、出力件数が一律20までとなります。

パラメータ構成例

「とうｋ」で始まる駅/バス停名称の候補を検索

/transport_node/autocomplete?word=とうｋ

レスポンス

名称	レスポンス名	型名	配列	Nullable	説明
駅・バス停情報	items	Nodeオブジェクト	〇
単位情報	unit	Unitオブジェクト			出力される単位の情報

Nodeオブジェクト

名称	レスポンス名	型名	配列	Nullable	説明
駅/バス停のノードID	id	文字列
駅/バス停の名称	name	文字列
駅/バス停の名称の読み仮名	ruby	文字列		nullable
ノードタイプの一覧	types	文字列	〇
住所の表示名	address_name	文字列		nullable
住所コード	address_code	文字列		nullable
駅/バス停の代表緯度経度	coord	Coordinateオブジェクト			株式会社ナビタイムジャパンが独自で算出しています
駅ナンバリング情報	numbering	Numberingオブジェクト	○	nullable

Coordinateオブジェクト

名称	レスポンス名	型名	配列	Nullable	説明
緯度	lat	数値
経度	lon	数値

Numberingオブジェクト

名称	レスポンス名	型名	配列	Nullable	説明
駅シンボル記号	symbol	文字列		nullable
駅番号	number	文字列		nullable

Unitオブジェクト

名称	レスポンス名	型名	配列	Nullable	説明
測地系	datum	文字列		nullable
緯度経度の出力形式	coord_unit	文字列		nullable

レスポンス例

{
    "items": [
        {
            "id": "00006668",
            "name": "東京",
            "ruby": "とうきょう",
            "types": [
                "station"
            ],
            "address_name": "東京都千代田区丸の内",
            "address_code": "13101055000",
            "coord": {
                "lat": 35.680805,
                "lon": 139.767798
            },
            "numbering": [
                {
                    "symbol": "M",
                    "number": "17"
                },
                {
                    "symbol": "JO",
                    "number": "19"
                },
                {
                    "symbol": "JK",
                    "number": "26"
                },
                {
                    "symbol": "JE",
                    "number": "01"
                },
                {
                    "symbol": "JY",
                    "number": "01"
                },
                {
                    "symbol": "JC",
                    "number": "01"
                },
                {
                    "symbol": "JT",
                    "number": "01"
                },
                {
                    "symbol": "JU",
                    "number": "01"
                }
            ]
        },
        ・・・
    ]
}

エラー情報

エラーハンドリングについて

エラーメッセージは追加/変更/削除されることがあります。
エラーハンドリングされる場合はHTTPステータスコードをもとにご対応ください。
共通エラーについてはこちらをご参照ください。

HTTPステータス	エラーメッセージ	発生理由
405	This http method is invalid : POST (等)	許可されていないHTTPメソッドでアクセスされた場合に発生します。
400	parameter error: word: ['required field']	必須パラメータである word が指定されていない、または空文字の場合に発生します。
400	parameter error: word: ['min length is 2']	word が2文字未満の場合に発生します。
400	parameter error: word: ['max length is 50']	word が50文字を超える場合に発生します。
400	parameter error: word_match: ['an invalid item: {value}']	word_match にピリオド区切りで prefix, partial 以外の不正な値を指定した場合に発生します。
400	parameter error: type: ['an invalid item: {value}']	type にピリオド区切りで station, airport, port, busstop, shuttle_busstop, highway_busstop 以外の不正な値を指定した場合に発生します。
400	parameter error: coord: ['an invalid coordinate : {value}']	coord が「緯度,経度」形式でない場合、または緯度と経度で表記（度表記／ミリ秒表記）が異なる場合に発生します。
400	parameter error: coord: ['an invalid latitude : {value}']	coord に指定した緯度が不正な場合に発生します。
400	parameter error: coord: ['an invalid longitude : {value}']	coord に指定した経度が不正な場合に発生します。
400	parameter error: radius: ['min value is 0']	radius に0未満の値を指定した場合に発生します。
400	parameter error: radius: ['max value is 100000']	radius に100000を超える値を指定した場合に発生します。
400	parameter error: radius: ["field 'coord' is required"]	coord を指定せずに radius のみを指定した場合に発生します。
400	parameter error: link: ['an invalid code: {value}']	link にピリオド区切りで不正な路線IDを指定した場合に発生します。
400	parameter error: bus_data: ['unallowed value {value}']	bus_data に timetable 以外の不正な値を指定した場合に発生します。
400	parameter error: datum: ['unallowed value {value}']	datum に wgs84, tokyo 以外の不正な値を指定した場合に発生します。
400	parameter error: coord_unit: ['unallowed value {value}']	coord_unit に degree, millisec 以外の不正な値を指定した場合に発生します。
400	bad usage on this contract　:　bus_data	bus_data を指定、または type に busstop / highway_busstop を指定したが、契約でバスデータ利用オプションが有効化されていない場合に発生します。
400	bad usage on this contract　:　use_company and unuse_company must be either.	契約の運行会社設定に不整合がある場合に発生します。