駅/バス停名検索

/transport_node [GET]

基本情報

概要

キーワードや住所など、条件に該当する駅・バス停の一覧を取得します。

URL

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

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

出力形式

JSON

対応言語

ja

出力順

キーワードの類似度と検索のランキングを考慮したスコア降順

パラメータ

パラメータ名	必須	概要	型名	デフォルト値	上下限/選択値	備考
word	✔	検索ワード	文字列			複数指定時はAND条件、OR条件の順で検索します 51文字以降は切り捨てます
address		住所コード	文字列			ピリオド区切りで複数指定できます
type		出力する交通機関	文字列		交通機関タイプより指定	ピリオド区切りで複数指定できます出力する駅・バス停種別を限定したい場合にご利用ください bus_data未指定時はstation.airport.port.shuttle_busstopに上書きされるためbusstop指定は無効になりますバス停の情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可)
options		追加出力情報	文字列		detail：駅・バス停の詳細情報
offset		データの出力開始位置	数値	0	最小値：0 最大値：1000	何件目から表示されるか（1件目が0）を指定します
limit		データの出力件数	数値	10	最小値：1 最大値：100	駅・バス停データの出力件数
bus_data		バスデータ利用情報	文字列		timetable：バスデータを利用するかどうかのフラグ	バス停の情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可)
datum		緯度経度の測地系	文字列	wgs84	wgs84：世界測地系 tokyo：旧日本測地系
coord_unit		出力データに含まれる緯度経度の単位	文字列	degree	degree：度表記の10進法 millisec：ミリ秒表記

type（交通機関タイプ）

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

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

パラメータ構成例

検索ワード「赤坂」で10件検索

/transport_node?word=赤坂

検索ワード「代々木」で10件検索（詳細情報付き）

/transport_node?word=代々木&options=detail

検索ワード「成田」で鉄道駅を10件検索

/transport_node?word=成田&type=station

レスポンス

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

Countオブジェクト

名称	レスポンス名	型名	説明
トータルヒット件数	total	数値	検索ヒットした件数
オフセット値	offset	数値	オフセットが設定されている場合はその値を出力
データの出力件数	limit	数値	データの出力件数に設定されている値 1件しかヒットしなかった場合でも、limit=10でリクエストしている場合は10と出力

Nodeオブジェクト

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

Coordinateオブジェクト

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

NodeDetailオブジェクト

名称	レスポンス名	型名	配列
運行会社情報	company	Companyオブジェクト
会社情報	companies	Companyオブジェクト	〇
ノード情報	poi	NodePoiオブジェクト
路線情報	link	Linkオブジェクト

Companyオブジェクト

名称	レスポンス名	型名	配列	Nullable	説明
運行会社ID	id	文字列
運行会社の名称	name	文字列	〇

NodePoiオブジェクト

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

Numberingオブジェクト

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

ExactCoordinateオブジェクト

名称	レスポンス名	型名	配列	Nullable	説明
上り線のノードの詳細緯度経度	up	Coordinateオブジェクト
下り線のノードの詳細緯度経度	down	Coordinateオブジェクト

Linkオブジェクト

名称	レスポンス名	型名	Nullable
実路線の ID	id	文字列
実路線の名称	name	文字列
実路線の推奨色	color	文字列	nullable
副実路線情報	sub_link	SubLinkオブジェクト	nullable
方面情報	direction_list	DirectionListオブジェクト	nullable

SubLinkオブジェクト

名称	レスポンス名	型名	配列	Nullable	説明
上り方面の副実路線名	up	SubLinkNameオブジェクト		nullable
下り方面の副実路線名	down	SubLinkNameオブジェクト		nullable

SubLinkNameオブジェクト

名称	レスポンス名	型名	配列	Nullable	説明
副実路線名	name	文字列

DirectionListオブジェクト

名称	レスポンス名	型名	配列	Nullable	説明
下り方面情報	down	Directionオブジェクト	〇	nullable
上り方面情報	up	Directionオブジェクト	〇	nullable

Directionオブジェクト

名称	レスポンス名	型名	配列	Nullable	説明
駅/バス停のノードID	id	文字列
駅/バス停の名称	name	文字列

Unitオブジェクト

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

レスポンス例

{
    "count": {
        "total": 19,
        "offset": 0,
        "limit": 10
    },
    "items": [
        {
            "id": "00005506",
            "name": "代々木",
            "ruby": "よよぎ",
            "types": [
                "station"
            ],
            "address_name": "東京都渋谷区千駄ヶ谷",
            "address_code": "13113017000",
            "coord": {
                "lat": 35.683593,
                "lon": 139.702197
            },
            "details": [
                {
                    "company": {
                        "id": "00000004",
                        "name": "ＪＲ東日本"
                    },
                    "companies": [
                        {
                            "id": "00000004",
                            "name": "ＪＲ東日本"
                        }
                    ],
                    "poi": {
                        "name": "代々木",
                        "ruby": "よよぎ",
                        "type": "station",
                        "address_name": "東京都渋谷区千駄ヶ谷",
                        "address_code": "13113017000",
                        "coord": {
                            "lat": 35.683593,
                            "lon": 139.702197
                        },
                        "numbering": [
                            {
                                "symbol": "JY",
                                "number": "18"
                            }
                        ],
                        "exact_coord": {
                            "up": {
                                "lat": 35.683593,
                                "lon": 139.702197
                            },
                            "down": {
                                "lat": 35.683593,
                                "lon": 139.702197
                            }
                        }
                    },
                    "link": {
                        "id": "00000141",
                        "name": "ＪＲ山手線"
                    }
                },
                ・・・
            ]
        },
        ・・・
    ],
    "unit": {
        "datum": "wgs84",
        "coord_unit": "degree"
    }
}

エラー情報

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

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

HTTPステータス	エラーメッセージ	発生理由
405	This http method is invalid : POST (等)	許可されていないHTTPメソッドでアクセスされた場合に発生します。
400	parameter error: word: ['required field']	必須パラメータである word が指定されていない場合に発生します。
400	parameter error: word: ['empty values not allowed']	word に空文字を指定した場合に発生します。
400	parameter error: address: ['an invalid code: {value}']	address にピリオド区切りで不正な住所コードを指定した場合に発生します。
400	parameter error: type: ['an invalid item: {value}']	type にピリオド区切りで station, airport, port, busstop, shuttle_busstop, highway_busstop 以外の不正な値を指定した場合に発生します。
400	parameter error: options: ['unallowed value {value}']	options に detail 以外の不正な値を指定した場合に発生します。
400	parameter error: offset: ['min value is 0']	offset に0未満の値を指定した場合に発生します。
400	parameter error: offset: ['max value is 1000']	offset に1000を超える値を指定した場合に発生します。
400	parameter error: limit: ['min value is 1']	limit に1未満の値を指定した場合に発生します。
400	parameter error: limit: ['max value is 100']	limit に100を超える値を指定した場合に発生します。
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.	契約の運行会社設定に不整合がある場合に発生します。