ルート検索（トータルナビ）

/route_transit [GET]

基本情報

概要

電車（航空路線、徒歩含む）を移動手段として、２地点間のルートを検索します。経由地の指定も可能です。

ウィジェットAPIについて

ルート検索（トータルナビ）の機能を搭載したWeb画面つきのAPIがございます。
詳細に関しては、仕様書やサンプルからご確認いただけます。

URL

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

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

出力形式

JSON
GeoJSON

対応言語

ja, en, ko, zh-CN, zh-TW, th

出力順

出力順はorderパラメータで指定した項目で並び替えを行った順

パラメータ

パラメータ名	必須	概要	型名	デフォルト値	上下限/選択値	備考
start	✔	出発地点	・地点のJSON表現・文字列（ノードID）・カンマ区切りの数値（緯度,経度）			ノードIDの指定例：00007820（表参道駅）
goal	✔	到着地点	・地点のJSON表現・文字列（ノードID）・カンマ区切りの数値（緯度,経度）
start_time	(✔)	出発時刻	文字列（日付時刻） YYYY-MM-DDThh:mm:ss			時刻の指定例　2019-09-26T08:00:00
goal_time	(✔)	到着時刻	文字列（日付時刻） YYYY-MM-DDThh:mm:ss			時刻の指定例　2019-10-01T08:00:00
first_operation	(✔)	始発の検索日付	文字列（日付）			始発検索する日付を指定します日付の指定例　2019-09-26 ※時刻表データ利用時のみ指定可能 (APIマーケットでは利用不可)
last_operation	(✔)	終発の検索日付	文字列（日付）			終発検索する日付を指定します日付の指定例　2019-09-26 ※時刻表データ利用時のみ指定可能 (APIマーケットでは利用不可)
via		経由地	地点のJSON表現（配列）			経由地指定の上限数は10地点ですただし、バス時刻表データのみを利用する場合かつ4地点以上指定された場合は、平均時間を用いた鉄道のみルート検索になります
via_type		経由地巡回モード	文字列	specified	specified: 指定順 optimal: 最適順	指定した経由地をどのように巡回するかを指定します
unuse		利用しない公共移動手段	文字列			ピリオド区切りで複数指定可能です詳細はこちらをご確認ください
walk_route		徒歩の利用ルート指定	文字列		avoid_step：階段回避ルート avoid_escalator：階段とエスカレータ回避ルート avoid_rain：雨に濡れにくいルート babycar：ベビーカーが通れるルート	未指定の場合は推奨ルートを使用しますピリオド区切りで複数指定可能です walk_speedを指定した場合はエラーとなります
walk_speed		徒歩の速度(単位：km/h)	数値	4.8	最小値：3.0 最大値：8.0	小数値は第一位まで有効です walk_routeを指定した場合はエラーとなります
use_car		車の利用有無	真偽値	false	- true：車を使う - false：車を使わない	経由地と同時に指定することはできません(falseを指定してもエラーとなります) 詳細はこちらをご覧ください
use_share_cycle		シェアサイクルの利用有無	真偽値	false	- true：シェアサイクルを使う - false：シェアサイクルを使わない	詳細はこちらをご覧ください ※時刻表データ利用時のみ指定可能 (APIマーケットでは利用不可)
bicycle_speed		自転車の速度(単位：km/h)	整数値（時速）	15	最小値：5 最大値：132	use_share_cycle指定時のみ有効
bicycle_condition		自転車ルート検索の優先考慮事項	文字列	recommend	recommend：推奨 total_distance：距離が短い low_pitched：坂道が少ない high_pitched：坂道が多い main_street：大通り優先 back_street：裏通り優先 cycling_road：サイクリングロード優先	use_share_cycle指定時のみ有効
special_pass		特別企画乗車券指定	文字列			利用を考慮する特別企画乗車券を指定しますピリオド区切りで複数指定可能です ※時刻表データ利用時のみ指定可能 (APIマーケットでは利用不可) 詳細はこちらをご確認ください
avoid_node		乗り降り回避ノード	文字列(ノードID)			ピリオド区切りで複数指定可能です指定した駅での乗り降りを回避します
order		出力順	文字列	time_optimized	time_optimized: 時刻順 total_distance: 総移動距離 walk_distance: 総徒歩移動距離 fare: 料金 time: 所要時間 transit: 乗換回数 commuter_pass_price: 定期券運賃 co2：二酸化炭素排出量	詳細はこちらをご確認ください二酸化炭素排出量についての詳細はこちらをご覧ください
term		検索時間の範囲(単位：分)	数値	1440	最大値：2880
commuter_pass		定期券区間指定	定期区間のJSON表現（配列）		最大10区間まで	以下の場合は定期券区間を指定しても無効になります・walk_routeの値にavoid_stepもしくはavoid_escalatorを指定した場合・経由地を指定した場合・新幹線を利用する場合・定期券区間が300kmを超える場合詳細はこちらをご覧ください
unuse_turnback		折り返しを禁止するかどうか	真偽値	false	- true：折り返しを禁止する - false：折り返しを禁止しない
limit		検索数	数値	5	最小値：1 最大値：10	以下の場合は指定したルートが無効になります・巡回地点を指定した場合・1対多、多対1ルート検索をした場合
train_data		電車の利用データ	文字列	average	average：平均所要時間を用いた乗換検索 timetable：電車時刻表データを用いた乗換検索	電車時刻表データを利用する場合はオプション契約が別途必要となります (APIマーケットでは利用不可)
bus_data		バスの利用データ	文字列	none	none：バス時刻表利用なし timetable：バス時刻表利用あり	バス時刻表データを利用する場合はオプション契約が別途必要となります (APIマーケットでは利用不可)
options		追加出力情報	文字列		railway_calling_at：乗換の途中駅情報 bus_commuter_pass：バス定期券情報 congestion：混雑度情報 co2：二酸化炭素概算排出量	バス定期券情報はバスデータ利用時のみ指定可能 (APIマーケットでは利用不可) 混雑度情報は時刻表データ利用時のみ指定可能 (APIマーケットでは利用不可) 混雑度情報の詳細はこちらをご覧ください二酸化炭素排出量についての詳細はこちらをご覧ください
shape		形状出力	真偽値	false	true：形状を出力する false：形状を出力しない	trueを指定時にはshapes(ルート形状)が出力されます
shape_color		経路形状の色分け	文字列		railway_line：鉄道路線毎の線色を使用
datum		緯度経度の測地系	文字列	wgs84	wgs84：世界測地系 tokyo：旧日本測地系
coord_unit		出力データに含まれる緯度経度の単位	文字列	degree	degree：度表記の10進法 millisec：ミリ秒表記
lang		言語	文字列		ja: 日本語 en: 英語 ko: 韓国語 zh-CN: 中国語(簡体字) zh-TW: 中国語(繁体字) th: タイ語	出力する言語を指定します ※多言語オプション申込時のみ利用可能 (APIマーケットでは利用不可)
bound_section		徒歩距離に応じた移動手段の指定	JSON表現			出発地点〜出発地点の最寄駅間、および到着地点の最寄駅〜到着地点間において、指定した徒歩距離以上の場合に任意の移動手段を指定することができます。詳細はこちらをご覧ください

unuse（公共移動手段・利用しないもの）

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

文字列	概要	備考
domestic_flight	航空路線
ferry	フェリー	フェリーの情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可)
superexpress_train	新幹線
sleeper_ultraexpress	寝台特急	寝台料金を必要とする列車（例：サンライズ出雲）
ultraexpress_train	特急	特急料金を必要とする列車（例：ふじさん、スカイライナー）
express_train	急行	急行料金を必要とする列車（例：秩父路、もりよし）
rapid_train	快速	運賃のみで乗車可能な速達列車（例：エアポート、ＪＲ東海道本線快速[アクティー]）
semiexpress_train	有料列車	乗車整理券・ライナー券や座席整理券を必要とする列車または全席指定の快速/普通列車など、急行以上を除く料金を必須とする列車（例：ホームライナー、TJライナー（有料区間のみ））
local_train	普通列車	運賃のみで乗車可能な列車
shuttle_bus	長距離バス（空港連絡バスを指す）
local_bus	路線バス	路線バスの情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可)
highway_bus	高速バス	高速バスの情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可)

special_pass（特別企画乗車券）

'special_pass' は以下を指定することができます。

文字列	概要	備考
youth18_pass_basic	青春18きっぷ（通常）
youth18_pass_express	青春18きっぷ（急行）
tokyo_metro_24hour	東京メトロ24時間券
tokyo_one_day_ticket	東京フリーきっぷ
enoshima_kamakura	江の島・鎌倉フリーパス
hakone	箱根フリーパス

1対多、多対1ルート検索について

複数の経路を一度に求めることのできるルート検索です（複数地点を登録する際の上限数は10地点です）。
1対多ルート検索：1つの出発地点に対し、複数の到着地点を指定します。
多対1ルート検索：複数の出発地点に対し、1つの到着地点を指定します。

ノードID指定によるパラメータ指定例（1対多ルート検索）は以下の通りです。
start=00006668&goal=[{"node":"00005172"},{"node":"00000838"}]

※出発地点、到着地点の両方で複数の地点を登録することはできません（多対多ルート検索には対応していません）。
※演算負荷の高い検索を行うため、距離が長い検索を行う場合などリクエスト内容によってはエラーが発生することがあります。
また、時間当たりのリクエスト数制限についても、1対1のルート検索や他のAPIとは異なります。詳しくは営業担当までお問い合わせください。

ルート検索時の日付（時刻）指定について

ルート検索を行う際、日付（時刻）指定は必須となります。以下の4つのうち必ず1つを指定してください（2つ以上は指定できません）。
・start_time（日付時刻指定）：出発地からの出発時刻の指定
・goal_time（日付時刻指定）：目的地への到着時刻の指定
・first_operation（日付指定）：指定した日付の始発を検索
・last_operation（日付指定）：指定した日付の終発を検索

use_carの指定について

徒歩区間について車で移動する場合の経路を検索する際に指定します（指定なしの場合は、車を利用しない経路が検索されます）。
車のルートを出力する際は、下記の区間を考慮します。
・出発地から目的地
・出発地から出発駅
・目的駅から目的地
※経由地を指定した場合に本パラメータを指定するとtrue、falseいずれの場合もエラーとなります。

use_share_cycleの指定について

徒歩区間についてシェアサイクルで移動する場合の経路を検索する際に指定します。
シェアサイクルのルートを出力する際は、下記の区間を考慮します。
・出発地から目的地
・出発地から出発駅
・出発地から経由地
・経由駅から経由地
・経由地から経由駅
・経由地から目的地
・目的駅から目的地

orderの出力順について

time_optimizedを指定した場合の出力順は、日付の指定によって変化します。
・start_time：到着時刻が早い順
・goal_time：出発時刻が遅い順
・first_operation：到着時刻が早い順
・last_operation：出発時刻が遅い順

fare, またはcommuter_pass_priceを指定した場合の出力順は、単純な並び替えで出力するのではなく、より料金が安くなることを重視した検索を行い、その結果を出力します。

二酸化炭素排出量の注意点について

二酸化炭素排出量(g/m)は1人を1m運ぶ際の概算量です。
移動手段と移動距離による単純計算により算出しています。
渋滞や信号停止による加算、速度や車種等の細かな条件は考慮されていません。
出典元：「運輸・交通と環境　2018年版」
監修：「国土交通省総合政策局環境政策課」

混雑度情報について

混雑度情報の対象は、平日のみとなります。
下記の各路線(首都圏)に対応しています。
【JR】
川越線、京浜東北線、京葉線、埼京線、湘南新宿ライン、常磐線、総武線快速、総武線各停、外房線、高崎線、中央線、東海道線、東北本線、南武線、根岸線、武蔵野線、山手線、横須賀線、横浜線
【地下鉄】
銀座線、千代田線、東西線、南北線、半蔵門線、日比谷線、副都心線、丸ノ内線、有楽町線、都営浅草線、都営大江戸線、都営新宿線、都営三田線
【私鉄】
小田急小田原線、小田急多摩線、小田急江ノ島線、京王線、京王相模原線、京王井の頭線、京王新線、京急本線、京成本線、京成押上線、京成成田空港線、北総鉄道線、東葉高速線、埼玉高速鉄道、西武新宿線、西武池袋線、西武有楽町線、相鉄本線、相鉄いずみ野線、つくばエクスプレス、東急東横線、東急目黒線、東急田園都市線、東急大井町線、東急池上線、東急多摩川線、東京モノレール、東武伊勢崎線、東武東上線、日暮里舎人ライナー、みなとみらい線、ゆりかもめ、りんかい線、京急空港線

地点の JSON 表現

プロパティ名	必須	概要	型名	備考
lat	(✔)	緯度	数値
lon	(✔)	経度	数値
node	(✔)	駅/連絡バス停ID	文字列
name		地点名称	文字列
stay-time		経由地の滞在時間(単位：分)	数値	最小値：0 最大値：300 経由地を指定する場合のみ使用可能です

地点のJSON表現における必須項目の指定方法について

lat, lon, nodeがすべて指定されている場合は、nodeが優先されます。
latを指定した場合は、lonも必ず指定してください。
lonを指定した場合は、latも必ず指定してください。
lat, lonの指定がない場合は、nodeが必須となります。

経由地の指定方法について

経由地の数だけ地点のJSON表現を配列にして記述します。経由地が1点の場合でも配列表現が必要です。
経由地が1点の場合の記述例は以下の通りです。
緯度経度で指定する場合　via=[{"lat":35.654043,"lon":139.729466}]、ノードIDで指定する場合　via=[{"node":"00006668"}]

最適順ルートを求める場合、経由地は2地点以上登録する必要があります。

経由地指定の上限数は10地点です。出発地点、到着地点は含みません。10地点以上の経由地を指定するとエラーとなります。

定期区間の JSON 表現

プロパティ名	必須	概要	型名	備考
start	✔	定期区間の出発駅ID	文字列
goal	✔	定期区間の到着駅ID	文字列
link	✔	路線ID	文字列
direction	(✔)	進行方向	文字列	up：上り down：下り下記の表に記載がある環状線を用いる場合のみ必須パラメータとなります。

環状線における direction (進行方向) の指定方法について

環状線を定期券区間として指定する場合の進行方向パラメータは、当社が定義した区分に基づいて
指定していただく必要があります。具体的には以下の通りです。

link（路線ID）	路線名	directionにupを指定した場合	directionにdownを指定した場合	備考
00000082	ＪＲ大阪環状線	外回り	内回り
00000141	JR山手線	内回り	外回り
00000250	伊予鉄道１・２系統	左回り	右回り
00000668	札幌市電山鼻線	外回り	内回り
00000674	山万ユーカリが丘線		左回り	環状部のみ片方向
00000704	神戸新交通ポートアイランド線		左回り	環状部のみ片方向
00000792	都営大江戸線（環状部）	左回り	右回り
00000859	名古屋市営名城線	右回り	左回り
00000909	ディズニーリゾートライン		左回り	片方向
00001162	富山地方鉄道環状線	右回り	左回り

定期区間を指定した際の挙動について

【出力順】
・定期券区間を指定した場合は「定期券区間をより多く通っている経路」から出力されます
（その他の順番で出力したい場合はorderパラメータをご利用ください）

【制限】
・必ずしも定期区間を通る経路が出るわけではありません
・経由地を指定した場合「定期券を使用した場合の値段についての情報（faresオブジェクト）」は出力されますが、定期券区間を考慮したルートは出力されません
・300kmを超える定期券区間、新幹線を利用した定期券区間を指定した場合は指定した定期券区間が無効になります

進行方向（direction）の指定について

誤った進行方向を指定した場合、ルート検索時に定期券区間を正しく考慮することができません。
※特に環状線は進行方向により定期券区間が変わってしまう可能性があるため、意図しない定期券区間を考慮してしまうことがあります。

定期券区間指定パラメータ（commuter_pass）にて進行方向を指定する場合は正しい進行方向を指定した上で検索していただきますよう、お願い致します。

bound_sectionパラメータの JSON 表現

プロパティ名	必須	概要	型名	デフォルト値	備考
start	(✔)	出発地-出発駅区間の設定	BoundSectionInfoオブジェクト		start, goalのいずれかまたはBoundSectionInfoの直接指定が必須です
goal	(✔)	到着駅-到着地区間の設定	BoundSectionInfoオブジェクト		start, goalのいずれかまたはBoundSectionInfoの直接指定が必須です

・BoundSectionInfoオブジェクト

プロパティ名	必須	概要	型名	デフォルト値	備考
walk-distance	✔	基準となる徒歩距離(単位：m)	数値		最小値：1 最大値：99999
move-type	✔	指定する移動手段	文字列		local_bus：路線バス car：車

bound_sectionパラメータの指定方法について

start, goalに同じ条件を設定する場合、bound_sectionパラメータにBoundSectionInfoオブジェクトを直接指定することが可能です。
例）
以下は同じ条件設定となります。
bound_section={"walk-distance": 2000, "move-type": "local_bus"}
bound_section={"start": {"walk-distance": 2000, "move-type": "local_bus"}, "goal": {"walk-distance": 2000, "move-type": "local_bus"}}

bound_sectionパラメータの動作について

このパラメータを指定することで、
出発地点〜出発駅間、および到着駅〜到着地点間において、指定した徒歩距離以上の場合に任意の移動手段を用いたルート取得することができます。
例）
　出発地点〜出発地点の最寄駅までの徒歩での距離が1500mの場合、
　・bound_section={"walk-distance":1000, "move-type":"local_bus"} または bound_section={"start": {"walk-distance":1000, "move-type":"local_bus"}}
　　と指定すると、上記区間は基準となる徒歩距離（1000m）を超えているため、路線バスを利用したルートになります
　・bound_section={"walk-distance":1500, "move-type":"local_bus"} または bound_section={"start": {"walk-distance":1500, "move-type":"local_bus"}}
　　と指定すると、上記区間は基準となる徒歩距離（1500m）と等しいため、路線バスを利用したルートになります
　・bound_section={"walk-distance":2000, "move-type":"local_bus"} または bound_section={"start": {"walk-distance":2000, "move-type":"local_bus"}}
　　と指定すると、上記区間は基準となる徒歩距離（2000m）に満たないため、徒歩のルートになります

bound_section利用時の留意点

本パラメータを利用の際には、以下にご留意ください。
　・返却される経路数は１つのみとなります
　・1対多、多対1の検索にはご利用いただけません
　・移動手段に路線バスを指定した場合、バスが利用出来ない場合は徒歩ルートとなります
　・定期券区間（commuter_passパラメータ）の指定はできません
　・経由地（via）を指定した場合、巡回モードは指定順（via_type=specified）となります
　・通常のルート検索よりも、処理に時間がかかる場合があります

新幹線の経路を含む定期券運賃出力について

新幹線の経路を含む定期券運賃出力

・新幹線定期券で乗車することができない全車指定席の列車については、新幹線定期券運賃が出力されません。
　ただし、下記の場合はその限りではありません
　　郡山〜福島間でつばさ号を利用する場合
　　仙台〜新青森間ではやぶさ号を利用する場合

パラメータ構成例

・出発駅：豊島園、到着駅：千葉、経由駅：東京、出発時刻：2019年10月1日8時、乗換の途中駅情報を出力

/route_transit?start=00008247&goal=00005172&via=[{"node":"00006668"}]&start_time=2019-10-01T08:00:00&options=railway_calling_at

パラメータ構成例（1対多の乗換ルート検索）

・出発駅：東京駅、目的駅1：千葉駅、目的駅2：横浜駅、の2ルートを出力

/route_transit?start=00006668&goal=[{"node":"00005172"},{"node":"00000838"}]&start_time=2019-10-01T08:00:00

パラメータ構成例（定期券区間を考慮したルート検索）

・出発駅：大宮駅、目的駅：原宿駅、定期券区間：池袋駅 ~ 渋谷駅（山手線 / 内回り）のルートを出力

/route_transit?start=00005564&goal=00002128&commuter_pass=[{"link":"00000141","start":"00005947","goal":"00003544","direction":"up"}]&start_time=2019-10-01T08:00:00

パラメータ構成例（指定した駅の乗り降りを回避したルート検索）

・出発駅：新宿駅、目的駅：表参道駅、乗り降り回避駅：渋谷駅のルートを出力

/route_transit?start=00004254&goal=00007820&avoid_node=00003544&start_time=2020-12-01T10:00:00

JSON 表現は URL エンコードをした上でリクエストしてください

レスポンス

名称	レスポンス名	型名	配列	説明
ルート情報	items	Routeオブジェクト	〇	ルートに関する情報のまとまり
単位情報	unit	Unitオブジェクト		出力される単位の情報

Routeオブジェクト

名称	レスポンス名	型名	配列	説明
経路の概要	summary	RouteSummaryオブジェクト		経路の概要に関する情報のまとまり
地点間の移動方法	sections	RouteSectionItemオブジェクト	〇	地点間の移動に関する情報のまとまり
料金情報	fares	FareItemオブジェクト	〇	料金に関する情報のまとまり定期券区間を指定した場合のみ出力されます
ルート形状	shapes	FeatureCollectionオブジェクト		ルート形状に関する情報のまとまり shape=true指定時のみ出力 shapesは/shape_transitのGeoJSON形式のレスポンスと同様

faresが出力される条件について

faresはcommuter_passパラメータを指定した場合に出力されます。
経由地を指定した場合ルート検索において定期券区間は考慮されませんが、faresオブジェクトは出力されます。

RouteSummaryオブジェクト

名称	レスポンス名	型名	配列	説明
ルート結果内番号	no	文字列
出発地点	start	RouteSummaryItemオブジェクト地点情報		出発地点に関する情報
到着地点	goal	RouteSummaryItemオブジェクト地点情報		到着地点に関する情報
移動情報	move	RouteSummaryItemオブジェクト移動情報
経由地	via	RouteSummaryItemオブジェクト地点情報	〇	経由地指定時のみ出力

RouteSummaryItemオブジェクト（type=point：地点情報）

名称	レスポンス名	型名	配列	説明
タイプ	type	文字列		常に'point'が入る
緯度経度	coord	Coordinateオブジェクト
地点名称	name	文字列		'start'または'goal'という文字列、またはリクエストパラメータにて入力された地点情報のJSONにおけるnameの値ノードIDを指定した場合は駅/空港/バス停名 langパラメータを指定した場合、指定言語の翻訳値が出力される翻訳できない場合はリクエストパラメータにて入力された値または日本語の値が出力される
出発時間	from_time	日付時刻		経由地出発時間 'summary:via'のときのみ出力
到着時間	to_time	日付時刻		経由地到着時刻 'summary:via'のときのみ出力
駅/バス停ID	node_id	文字列		駅/空港/バス停を識別するID
交通機関タイプの一覧	node_types	文字列	〇	駅/空港/バス停を識別する種別

RouteSummaryItemオブジェクト（type=move：移動情報）

名称	レスポンス名	型名	配列	説明
乗換回数	transit_count	数値
徒歩の距離(単位：m)	walk_distance	数値		徒歩移動がある場合のみ出力電車乗り継ぎの徒歩移動は含まない
料金	fare	Fareオブジェクト		運賃がある場合のみ出力
種別	type	文字列		常に'move'が入る
出発時刻	from_time	日付時刻
到着時刻	to_time	日付時刻
総移動時間(単位：分)	time	数値
移動距離(単位：m)	distance	数値
特別企画乗車券	special_pass	SpecialPassオブジェクト		special_pass指定時のみ出力
その他料金	other_fare	OtherFareオブジェクト
二酸化炭素排出量(単位 : g/m)	co2	数値
ルート全体の混雑度	congestion_level	数値		1~6の値で出力大きいほど混雑度が高いことを示します検索結果に混雑度が存在しない路線が含まれる場合は、出力されません
移動手段の一覧	move_types	文字列	〇	RouteSectionItemオブジェクト(move)に存在するmoveを一覧で取得アルファベット順で重複なしで出力

通勤定期券運賃の総額について

通勤定期券運賃の総額が計算可能な場合はRouteSummaryItemオブジェクト(type=move)のfareに以下のレスポンスを出力します。
総額は各区間(RouteSectionItemオブジェクト)に出力されている料金を合算した値となります。
また、電車定期券運賃とバス定期券運賃の総額は分けて計算されます。
・unit_128_{train/bus}: 1ヶ月通勤定期券運賃の総額
・unit_130_{train/bus}: 3ヶ月通勤定期券運賃の総額
・unit_133_{train/bus}: 6ヶ月通勤定期券運賃の総額

※ルート全体に通勤定期券運賃が存在しない場合は、通勤定期券運賃の総額は出力しません。
※通勤定期券運賃の総額についての注意点・制限事項については、運賃計算結果の見方についてのページをご確認ください。
【例】下記2つの移動区間があるルートの場合
移動区間1 : 1ヶ月通勤定期券運賃と3ヶ月通勤定期券運賃が存在
移動区間2 : 1ヶ月通勤定期券運賃のみ存在
この例の場合は、ルート全体の総額が計算可能な通勤定期券運賃は1ヶ月通勤定期券運賃のみとなるため、1ヶ月通勤定期券運賃の総額のみ出力します。

定期券を考慮する運賃の内訳について

commuter_passパラメータを指定時、RouteSummaryItemオブジェクト(type=move)のfareに以下のレスポンスを追加で出力します。
・unit_112: 定期券考慮運賃(定期区間外)の総額
・unit_113: 定期券考慮運賃(定期区間内)の総額
・unit_114: 定期券考慮IC運賃の総額

RouteSectionItemオブジェクト（type=point：地点間の地点情報）

名称	レスポンス名	型名	配列	説明
タイプ	type	文字列		常に'point'が入る
地点の緯度経度	coord	Coordinateオブジェクト		出発地点または到着地点の緯度経度が出力される
地点の名称	name	文字列		'start'または'goal'という文字列、またはリクエストパラメータにて入力された地点情報のJSONにおけるnameの値ノードIDを指定した場合は駅/空港/バス停名 langパラメータを指定した場合、指定言語の翻訳値が出力される翻訳できない場合はリクエストパラメータにて入力された値または日本語の値が出力される
駅/バス停ID	node_id	文字列		駅/空港/バス停を識別するID
交通機関タイプの一覧	node_types	文字列	〇	駅/空港/バス停を識別する種別
経由地フラグ	with_via	真偽値		地点が指定した経由地である場合に出力
経由地点の滞在時間	stay_time	数値		地点が指定した経由地である場合に出力
出入口の名称	gateway	文字列		出入り口情報がある場合のみ出力 langパラメータを指定した場合、指定言語の翻訳値が出力される翻訳出来ない場合は日本語で出力される
出発プラットフォーム名	start_platform	文字列		電車時刻表データを利用する場合のみ出力 langパラメータを指定した場合、"en"指定時はホーム番号のみを出力し、"en"以外を指定した場合は日本語で出力
到着プラットフォーム名	goal_platform	文字列		電車時刻表データを利用する場合のみ出力 langパラメータを指定した場合、"en"指定時はホーム番号のみを出力し、"en"以外を指定した場合は日本語で出力
駅ナンバリング情報	numbering	RouteNodeNumberオブジェクト		駅ナンバリングに対応した駅のみ出力
スポットコード	spot_code	文字列		シェアサイクルルートの場合のみ出力
シェアサイクル情報	share_cycle	SpotShareCycleオブジェクト		シェアサイクルのポートに関する情報を出力しますシェアサイクルルートの場合のみ出力

RouteSectionItemオブジェクト（move：地点間の移動情報）

名称	レスポンス名	型名	説明
タイプ	type	文字列	常に'move'が入る
定期券の区間内であることを示すフラグ	use_commuter_pass	真偽値	定期券の区間内だった場合のみ「true」が出力される以下の場合は出力されない・経由地を指定した際に経由地巡回モードを最適順にして検索した場合・該当区間がcommuter_passで指定した定期券区間外だった場合
次の地点で乗換が必要かのフラグ	next_transit	真偽値	以下のケースでは出力されない乗換が不要な場合直通運転が存在する場合最後のRouteItem[type=move]の時
利用する公共交通機関の詳細情報	transport	Transportオブジェクト	公共交通機関を利用しない場合は出力されない
移動手段	move	文字列
出発時間	from_time	日付時刻	一つ上のpointからの出発時刻
到着時間	to_time	日付時刻	一つ下のpointへの到着時刻
総移動時間(単位：分)	time	数値	type=point間の移動時間
移動距離(単位：m)	distance	数値	type=point間の移動距離
区間の路線情報	line_name	文字列	電車/バスの場合は路線名、徒歩の場合は「"徒歩"」を出力 langパラメータを指定した場合、指定言語の翻訳値が出力される翻訳出来ない場合は日本語で出力される
乗換時間（単位：秒）	transfer_seconds	数値
特別企画乗車券	special_pass	SpecialPassオブジェクト	special_pass指定時のみ出力
フェリー利用状況	use_ferry	文字列	partial: 一部区間でフェリーを利用している entire: 全区間でフェリーを利用している車ルートでフェリー利用がある場合のみ出力
その他料金	other_fare	OtherFareオブジェクト
地点間の混雑度	congestion_level	数値	1~6の値で出力大きいほど混雑度が高いことを示します

use_commuter_passが出力される条件について

use_commuter_passはcommuter_passパラメータを指定した場合、対象経路が定期区間を通っていた場合のみ出力されます。
経由地を指定した場合ルート検索において定期券区間は考慮されませんが、経由地巡回モードを指定順にして検索した際定期券区間を通過している場合はuse_commuter_passが出力されます。

move（移動手段の一覧）

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

文字列	概要	備考
walk	徒歩
car	車
bicycle	自転車
domestic_flight	航空路線
ferry	フェリー	フェリー情報を利用時のみ出力フェリーの情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可)
superexpress_train	新幹線
sleeper_ultraexpress	寝台特急	寝台料金を必要とする列車（例：サンライズ出雲）
ultraexpress_train	特急	特急料金を必要とする列車（例：ふじさん、スカイライナー）
express_train	急行	急行料金を必要とする列車（例：秩父路、もりよし）
rapid_train	快速	運賃のみで乗車可能な速達列車（例：エアポート、ＪＲ東海道本線快速[アクティー]）
semiexpress_train	有料列車	乗車整理券・ライナー券や座席整理券を必要とする列車または全席指定の快速/普通列車など、急行以上を除く料金を必須とする列車（例：ホームライナー、TJライナー（有料区間のみ））
local_train	普通列車	運賃のみで乗車可能な列車
shuttle_bus	長距離バス（空港連絡バスを指す）
local_bus	路線バス	バスデータ利用時のみ出力路線バスの情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可)
highway_bus	高速バス	バスデータ利用時のみ出力高速バスの情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可)
unknown	不明

Coordinateオブジェクト

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

Fareオブジェクト

名称	レスポンス名	型名	配列	説明
料金	unit_{料金区分ID}	数値	〇	料金区分IDの数だけ料金が出力される

OtherFareオブジェクト

名称	レスポンス名	型名	配列	説明
タクシー料金(単位：円)	taxi	数値		各地域の初乗り料金/加算料金等を考慮した概算料金 'use_car=true'の場合のみ出力

タクシーの乗車時間と料金について

・タクシーの乗車時間と料金は目安です。
・乗車時間は道路事情により、実際と異なる場合がございます。タクシー料金は概算の金額です。走行距離で算出しており､信号や渋滞による停車などの時間は考慮しておりません
・料金は、出発地の初乗り料金と加算料金を基準としております。深夜料金は22時～5時の間に乗車した場合､全走行距離2割増で算出しています。また､有料道路の料金は含まれておりません。
・各タクシー会社や地域により料金は異なることがあります。あくまで参考としてご覧ください。

SpecialPassオブジェクト

名称	レスポンス名	型名	配列	説明
特別企画乗車券の詳細情報	details	SpecialPassDetailオブジェクト	〇
特別企画乗車券の適用区間であることを示すフラグ	entire_section	真偽値		区間全体をカバーする場合はtrueを出力

SpecialPassDetailオブジェクト

名称	レスポンス名	型名	配列	説明
特別企画乗車券名	name	文字列

SpotShareCycleオブジェクト

名称	レスポンス名	型名	説明
利用状況	available	真偽値	true: 利用可能 false: 利用不可
利用可能台数	available_unit	文字列
返却状況	retunable	真偽値	true: 利用可能 false: 利用不可
返却可能台数	retunable_unit	文字列
更新時刻	update_time	文字列
提供者情報	provider	Providerオブジェクト
エリアID	area_id	文字列
エリア名称	area_name	文字列

Providerオブジェクト

名称	レスポンス名	型名	配列	説明
提供者ID	id	文字列
提供者名	name	文字列

RouteNodeNumberオブジェクト

名称	レスポンス名	型名	配列	説明
到着ノード	arrival	NodeNumberオブジェクト
出発ノード	departure	NodeNumberオブジェクト

NodeNumberオブジェクト

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

Transportオブジェクト

名称	レスポンス名	型名	配列	説明
運賃情報	fare	Fareオブジェクト		運賃がある場合のみ出力
行き先駅情報	destination	NodeItemオブジェクト		langパラメータを指定した場合、指定言語の翻訳値が出力される翻訳出来ない場合は日本語の値が出力される
降車推奨位置	getoff	文字列		「後」や「１・２・３」のようなテキストデータで出力数字は車両番号を示す langパラメータを指定した場合、指定言語の翻訳値が出力される翻訳出来ない場合は日本語の値が出力される
途中駅情報	calling_at	CallingAtオブジェクト		「options=railway_calling_at」指定時のみ出力
運行路線の推奨色	color	文字列
運行路線の名称	name	文字列		langパラメータを指定した場合、指定言語の翻訳値が出力される翻訳出来ない場合は日本語の値が出力される
料金体系の時期	fare_season	文字列		normal：通常期 busy：繁忙期 slack：閑散期 'fare'が出力されない場合は出力されない
列車・バス自体の ID	self_id	文字列		電車時刻表データを利用する場合のみ出力
列車・バス自体の名称	self_name	文字列		運行路線の名称と異なる場合に出力 langパラメータを指定した場合、指定言語の翻訳値が出力される翻訳出来ない場合は日本語の値が出力される
交通機関会社情報	company	Companyオブジェクト
路線情報	links	Linkオブジェクト	〇
運行路線のID	id	文字列
運行路線種別	type	文字列		「普通」や「急行」のようなテキストデータで出力 langパラメータを指定した場合、指定言語の翻訳値が出力される翻訳出来ない場合は日本語の値が出力される
運賃・料金連続フラグ	fare_break	FareBreakオブジェクト
時刻表上の列車番号	train_id	文字列		電車時刻表データを利用する場合のみ出力
特別料金適応区間、特別料金情報	fare_detail	FareIntervalオブジェクト	〇

CallingAtオブジェクト

名称	レスポンス名	型名	配列	説明
駅のID	node_id	文字列
駅の名称	name	文字列		langパラメータを指定した場合、指定言語の翻訳値が出力される翻訳出来ない場合は日本語の値が出力される
交通機関タイプの一覧	node_types	文字列	〇
緯度経度	coord	Coordinateオブジェクト
駅に到着する時刻	from_time	文字列
駅を出発する時刻	to_time	文字列

Companyオブジェクト

名称	レスポンス名	型名	配列	説明
交通機関会社のID	id	文字列
交通機関会社の名称	name	文字列		langパラメータを指定した場合、指定言語の翻訳値が出力される翻訳出来ない場合は日本語の値が出力される

Linkオブジェクト

名称	レスポンス名	型名	説明
路線ID	id	文字列
路線名	name	文字列	langパラメータを指定した場合、指定言語の翻訳値が出力される翻訳出来ない場合は日本語の値が出力される
進行方向	direction	文字列	up：上り down：下り
方面駅情報	destination	NodeItemオブジェクト
区間開始駅情報	from	NodeItemオブジェクト
区間終端駅情報	to	NodeItemオブジェクト
時刻表データの利用有無	is_timetable	真偽値	true：時刻表データ利用あり false：時刻表データ利用なし

NodeItemオブジェクト

名称	レスポンス名	型名	配列	説明
駅のID	id	文字列
駅の名称	name	文字列		langパラメータを指定した場合、指定言語の翻訳値が出力される翻訳出来ない場合は日本語の値が出力される

FareBreakオブジェクト

名称	レスポンス名	型名	配列	説明
運賃・料金連続フラグ	unit_{料金区分ID}	真偽値	〇	false：運賃は次sectionで繰越計算する true：運賃は本sectionで計算する

運賃の出力について

fare_break は、運賃が出力される場合に'true'となります

例：経堂～下北沢～渋谷の経路における「乗継割引」適用の場合
当該経路の場合、対象駅となる小田急線「経堂」駅から京王線「下北沢」駅での乗り継ぎで、乗継割引 (異なる社局の特定の区間を相互に乗り継いだ際に適応される割引) が適用されます
この例における小田急線の fare_break オブジェクトは、次のように、unit_0 (普通運賃) と unit_48 (ICカード運賃) の fare_break が「false」となります

このとき、小田急線のセクションでは、運賃情報として「unit_0 (普通運賃)」と「unit_48 (ICカード運賃) 」は出力されません
運賃は、次の京王線のセクションにて乗継割引を含めた形で「unit_0 (普通運賃) 270 円」と「unit_48 (ICカード運賃)258 円」として出力されます

・fare_breakの例

    "fare_break": {
                "unit_130": true,
                "unit_141": true,
                "unit_0": false,
                "unit_48": false,
                "unit_133": true,
                "unit_138": true,
                "unit_136": true,
                "unit_128": true
            }

FareIntervalオブジェクト

名称	レスポンス名	型名	説明
特別料金開始ノード情報	start	FareNodeオブジェクト
特別料金終了ノード情報	goal	FareNodeオブジェクト
料金情報	fare	数値
料金区分	id	文字列	unit_{料金区分ID} 形式ではなく、{料金区分ID} 形式の料金区分で出力例：'unit_130'の場合は'130'と出力される
特別料金デフォルト合算フラグ	default_extra_fare	真偽値	デフォルトで合算すべき特別料金の場合に'true'となる

FareNodeオブジェクト

名称	レスポンス名	型名	配列	説明
地点名称	id	文字列
駅のID	node_id	文字列		以下を識別するID 駅空港バス停

Unitオブジェクト

名称	レスポンス名	型名
緯度経度の測地系	datum	文字列
緯度経度の出力形式	coord_unit	文字列
距離の単位	distance	文字列
所要時間の単位	time	文字列
通貨の単位	currency	文字列

レスポンス例

・ルートの概要（summary）

    "start": {
        "type": "point",
        "coord": {
            "lat": 35.665291,
            "lon": 139.712613
        },
        "name": "表参道",
        "node_id": "00007820",
        "node_types": [
            "station"
        ]
    },
    "goal": {
        "type": "point",
        "coord": {
            "lat": 35.671335,
            "lon": 139.76513
        },
        "name": "銀座",
        "node_id": "00001908",
        "node_types": [
            "station"
        ]
    },
    "move": {
        "transit_count": 0,
        "fare": {
            "unit_0": 170.0,
            "unit_48": 165.0
        },
        "type": "move",
        "from_time": "2019-10-01T08:01:00+09:00",
        "to_time": "2019-10-01T08:14:00+09:00",
        "time": 13,
        "distance": 5900
    }

・地点間の移動情報（鉄道）

    "sections": [
        {
            "type": "point",
            "coord": {
                "lat": 35.665291,
                "lon": 139.712613
            },
            "name": "表参道",
            "node_id": "00007820",
            "node_types": [
                "station"
            ],
            "numbering": {
                "departure": [
                    {
                        "symbol": "G",
                        "number": "02"
                    }
                ]
            }
        },
        {
            "transport": {
                "fare": {
                    "unit_130": 19900.0,
                    "unit_141": 20630.0,
                    "unit_0": 170.0,
                    "unit_48": 165.0,
                    "unit_133": 37700.0,
                    "unit_138": 10890.0,
                    "unit_136": 3820.0,
                    "unit_128": 6980.0
                },
                "color": "#FF9500",
                "name": "東京メトロ銀座線",
                "fare_season": "normal",
                "company": {
                    "id": "00000113",
                    "name": "東京地下鉄（メトロ）"
                },
                "links": [
                    {
                        "id": "00000768",
                        "name": "東京メトロ銀座線",
                        "direction": "up",
                        "destination": {
                            "name": "浅草",
                            "id": "00005270"
                        },
                        "from": {
                            "name": "表参道",
                            "id": "00007820"
                        },
                        "to": {
                            "name": "銀座",
                            "id": "00001908"
                        }
                    }
                ],
                "id": "00000559",
                "type": "普通",
                "fare_detail": [
                    {
                        ・・・
                    },
                    {
                        "start": {
                            "node_id": "00007820",
                            "name": "表参道"
                        },
                        "goal": {
                            "node_id": "00001908",
                            "name": "銀座"
                        },
                        "fare": 170.0,
                        "id": "0"
                    }
                ]
            },
            "type": "move",
            "move": "local_train",
            "from_time": "2019-10-01T08:01:00+09:00",
            "to_time": "2019-10-01T08:14:00+09:00",
            "time": 13,
            "distance": 5900,
            "line_name": "東京メトロ銀座線"
        }
    ]

・特急料金などが出力される場合の例

    "fare_detail": [
        {
            "start": {
                "node_id": "00006668",
                "name": "東京"
            },
            "goal": {
                "node_id": "00004305",
                "name": "新大阪"
            },
            "fare": 4870.0,
            "default_extra_fare": true,
            "id": "1"
        },
        {
            "start": {
                "node_id": "00006668",
                "name": "東京"
            },
            "goal": {
                "node_id": "00004305",
                "name": "新大阪"
            },
            "fare": 5700.0,
            "id": "2"
        },
        {
            ・・・
        }
    ]

・航空機利用の場合の例

    "transport": {
        "fare": {
            "unit_0": 43600.0,
            "unit_254": 0.0
        },
        "name": "空路（[東京]羽田空港-長崎空港）",
        "fare_season": "normal",
        "company": {
            "id": "00000051",
            "name": "航空各社"
        },
        "links": [
            {
                "id": "00000542",
                "name": "空路（[東京]羽田空港-長崎空港）",
                "direction": "down",
                "destination": {
                    "name": "長崎空港",
                    "id": "00006222"
                },
                "from": {
                    "name": "羽田空港（空路）",
                    "id": "00000592"
                },
                "to": {
                    "name": "長崎空港",
                    "id": "00006222"
                }
            }
        ],
        "id": "00001573",
        "type": "航空路線",
        "fare_break": {
            "unit_0": true,
            "unit_254": true
        },
        ・・・
    },
    "type": "move",
    "move": "domestic_flight",
    "from_time": "2019-10-01T09:35:00+09:00",
    "to_time": "2019-10-01T11:15:00+09:00",
    "time": 100,
    "distance": 980100,
    "line_name": "空路（[東京]羽田空港-長崎空港）"

レスポンス例(lang=en指定時)