ルート検索(バイク)
/route_motorcycle [GET]
基本情報
概要
バイクを移動手段として、2地点間のルートを検索します。経由地の指定も可能です。
URL
https://{HOST}/{CID}/v1/route_motorcycle
※Rakuten RapidAPIの場合はURL体系が異なります
出力形式
- JSON
対応言語
- ja
出力順
- orderパラメータで指定した項目で並び替えを行った順
パラメータ
パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
---|---|---|---|---|---|---|
start | ✔ | 出発地点 | 地点のJSON表現 文字列(ノードID) カンマ区切りの数値(緯度,経度) |
緯度経度の指定例:35.689457,139.691935(東京都庁) | ||
goal | ✔ | 到着地点 | 地点のJSON表現 文字列(ノードID) カンマ区切りの数値(緯度,経度) |
|||
start_time | 出発時刻 | 文字列(日付時刻) YYYY-MM-DDThh:mm:ss |
時刻の指定例 2019-10-01T08:00:00 | |||
goal_time | 到着時刻 | 文字列(日付時刻) YYYY-MM-DDThh:mm:ss |
時刻の指定例 2019-10-01T08:00:00 | |||
via | 経由地 | 地点のJSON表現(配列) | 経由地指定の上限数は10地点です | |||
via_type | 経由地指定検索モード | 文字列 | specified | specified: 指定順 optimal: 巡回(最適)順 |
指定した経由地をどのように巡回するかを指定します | |
condition | 経路検索条件 | 文字列 | recommend | recommend:推奨 toll_time:有料道路利用、時間優先 toll_distance:有料道路利用、距離優先 toll_gas:有料道路利用、ガソリン節約優先 free_time:無料道路利用、時間優先 free_distance:無料道路利用、距離優先 free_gas:無料道路利用、ガソリン節約優先 |
||
order | 出力順 | 文字列 | time | total_distance: 総移動距離 time: 所要時間 |
1対多、または多対1ルート検索の場合のみ有効です | |
use_traffic | 渋滞情報の考慮 | 文字列 | vics:VICS提供の道路交通情報 probe:プローブから生成された道路交通情報 |
ピリオド区切りで複数指定が可能です ※VICS / プローブのご利用は、オプション機能のため、別途契約が必要となります (Rakuten RapidAPIでは利用不可) ※vicsを指定した場合は、リクエストヘッダー「x-ntj-uid」、または、パラメータ「uid」を必ず設定してください |
||
uid | (✔) | VICS使用時のユーザー識別子 | 文字列 | 1文字以上50文字以内 | ※VICS / プローブのご利用は、オプション機能のため、別途契約が必要となります (Rakuten RapidAPIでは利用不可) ※パラメータ「use_traffic」で「vics」を指定した場合は、リクエストヘッダー「x-ntj-uid」、または、パラメータ「uid」を必ず設定してください |
|
options | 追加出力情報 | 文字列 | turn_by_turn:ターンバイターン情報 | 交差点等、進行情報を案内するための地点情報を取得します | ||
smart_ic | スマートIC考慮 | 文字列 | unuse | unuse : スマートICを考慮しない use : スマートICを考慮する |
||
ferry | フェリー優先検索 | 文字列 | use | unuse : フェリーを使わない use : フェリーを使う more_use : フェリーを優先して使う |
||
displacement | 排気量(単位:cc) | 数値 | 最小値 : 1 最大値 : 3000 |
バイクの排気量を指定します 125未満の場合は地点JSONでicを指定することができません |
||
fuel | 燃費 | 数値 | 最小値: 1 最大値: 200 |
1ℓ当たりの走行可能距離を示します | ||
datum | 緯度経度の測地系 | 文字列 | wgs84 | wgs84:世界測地系 tokyo:旧日本測地系 |
||
coord_unit | 出力データに含まれる緯度経度の単位 | 文字列 | degree | degree:度表記の10進法 millisec:ミリ秒表記 |
1対多、多対1ルート検索について
複数の経路を一度に求めることのできるルート検索です。
1対多ルート検索:1つの出発地点に対し、複数の到着地点を指定します。
多対1ルート検索:複数の出発地点に対し、1つの到着地点を指定します。
これらのルート検索を行う場合、経由地を指定することはできません。
緯度経度指定によるパラメータ指定例(1対多ルート検索)は以下の通りです。
start=35.439582,139.380180&goal=[{"lat":35.706822,"lon":139.813956},{"lat":35.655392,"lon":139.748642}]
※出発地点、到着地点の両方で複数の地点を登録することはできません(多対多ルート検索には対応していません)。
複数地点を登録する際の上限数は、出発地点と到着地点それぞれについて10地点です。
複数地点の中に「ic」と「node」を含めることはできません。
車両区分について
独自の基準に基づき、排気量によって車両区分が決定されます。
1 ~ 49 : 原付二輪自動車
50 ~ 124 : 小型二輪自動車
125 ~ 249 : 普通二輪自動車
250 ~ : 大型二輪自動車
地点の JSON 表現
プロパティ名 | 必須 | 概要 | 型名 | デフォルト値 | 備考 |
---|---|---|---|---|---|
lat | (✔) | 緯度 | 数値 | ||
lon | (✔) | 経度 | 数値 | ||
node | (✔) | 駅/連絡バス停ID | 文字列 | 経由地の場合は駅/連絡バス停IDは指定できません 緯度経度で指定してください |
|
ic | (✔) | IC(インターチェンジ)のID | 文字列 | 経由地の場合はパラメータ「ic-passing-type」と合わせて指定してください パラメータ「displacement」の値が125以上の場合のみ使用可能です |
|
ic-passing-type | (✔) | IC(インターチェンジ)の通過区分 | 文字列 | entrance:入口 exit:出口 経由地でパラメータ「ic」を指定する場合のみ使用可能です |
|
name | 地点名称 | 文字列 | |||
road-type | 地点の道路種別 | 文字列 | free | free:無料道路 toll:有料道路 any:有料無料全ての道路が対象 |
|
angle | 方位 | 数値 | 0~360度 出発地を指定する場合のみ使用可能です |
||
park-side | 横付け | 数値 | always_along:常に同一車線側に横付け along:狭い道路以外は同一車線側に横付け |
||
stay-time | 経由地の滞在時間(単位:分) | 数値 | 最小値:0 最大値:300 経由地を指定する場合のみ使用可能です |
出発地点と到着地点のJSON表現における必須項目の指定方法について
lat/lon、node、icの内いずれか一つの指定が必須となります(複数指定はエラー)。
latを指定した場合は、lonも必ず指定してください。
lonを指定した場合は、latも必ず指定してください。
経由地点のJSON表現における必須項目の指定方法について
lat/lon、icの内いずれか一つの指定が必須となります(複数指定はエラー)。
latを指定した場合は、lonも必ず指定してください。
lonを指定した場合は、latも必ず指定してください。
icを指定した場合は、ic-passing-typeも必ず指定してください。
経由地の指定方法について
経由地の数だけ地点のJSON表現を配列にして記述します。経由地が1点の場合でも配列表現が必要です。
経由地が1点の場合の記述例は以下の通りです。
via=[{"lat":35.706822,"lon":139.813956}]
最適な巡回ルートを求める場合、経由地は2地点以上登録する必要があります。
経由地指定の上限数は10地点です。出発地点、到着地点は含みません。10地点以上の経由地を指定するとエラーとなります。
※オプション契約により最大100地点の経由地指定が可能です。
経由地にIC(インターチェンジ)を指定する場合の指定方法について
パラメータ「ic」に指定するIDは乗降IC検索APIにて取得することができます。
ICは経由地の数に含まれます。
ICを経由地にした場合の記述例は以下の通りです。
【横浜青葉IC入口と横浜町田IC出口を経由する場合】
via=[{"ic":"23040","ic-passing-type":"entrance","name":"横浜青葉IC入口"},{"ic":"23050","ic-passing-type":"exit","name":"横浜町田IC出口"}]
※経由地にICを指定する際、指定可能なvia_typeはspecified(指定順)のみとなります。
※optimal(巡回順)が指定された場合はエラーを返します。
パラメータ構成例(1対1ルート検索)
・出発地:東京都庁、目的地:柏駅、排気量:250cc、検索条件:有料道路利用、時間優先、出発時刻:2019年10月1日8時、ターンバイターン情報を出力
/route_motorcycle?start={"lat":35.689457,"lon":139.691935,"name":"東京都庁"}&goal=00007423&displacement=250&condition=toll_time&start_time=2019-10-01T08:00:00&options=turn_by_turn
パラメータ構成例(1対多ルート検索)
・出発地:東京都庁、目的地1:墨田区錦糸町付近、目的地2:港区芝公園付近、排気量:50cc の2ルートを出力
/route_motorcycle?start=35.689457,139.691935&goal=[{"lat":35.706822,"lon":139.813956},{"lat":35.655392,"lon":139.748642}]&displacement=50cc&condition=toll_time&start_time=2019-10-01T08:00:00
JSON 表現は URL エンコードをした上でリクエストしてください
レスポンス
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
ルート情報 | items | Routeオブジェクト | 〇 | ルートに関する情報のまとまり |
単位情報 | unit | Unitオブジェクト | 出力される単位の情報 |
Routeオブジェクト
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
経路の概要 | summary | RouteSummaryオブジェクト | 経路の概要に関する情報のまとまり | |
地点間の移動方法 | sections | RouteSectionItemオブジェクト | 〇 | 地点間の移動に関する情報のまとまり |
料金情報 | fares | FareItemオブジェクト | 〇 | 地点間の移動に関する情報のまとまり 有料道路利用時のみ出力 |
RouteSummaryオブジェクト
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
ルート結果内番号 | no | 文字列 | ルート結果内番号 | |
出発地点 | start | RouteSummaryItemオブジェクト 地点情報 |
出発地点に関する情報 | |
到着地点 | goal | RouteSummaryItemオブジェクト 地点情報 |
到着地点に関する情報 | |
移動情報 | move | RouteSummaryItemオブジェクト 移動情報 |
移動情報 | |
経由地 | via | RouteSummaryItemオブジェクト 地点情報 |
〇 | 経由地設定時のみ出力 |
RouteSummaryItemオブジェクト(type=point:地点情報)
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
タイプ | type | 文字列 | 常に'point'が入る | |
緯度経度 | coord | Coordinateオブジェクト | ||
地点名称 | name | 文字列 | 'start'または'goal'という文字列、または リクエストパラメータにて入力された地点情報のJSONにおけるnameの値 ノードIDを指定した場合は駅/空港/バス停名 |
|
出発時間 | from_time | 日付時刻 | 経由地出発時間 'summary:via'のときのみ出力 |
|
到着時間 | to_time | 日付時刻 | 経由地到着時刻 'summary:via'のときのみ出力 |
RouteSummaryItemオブジェクト(type=move:移動情報)
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
料金 | fare | Fareオブジェクト | ||
有料道路走行距離(単位:m) | toll_road_distance | 数値 | ||
タイプ | type | 文字列 | 常に'move'が入る | |
出発時刻 | from_time | 日付時刻 | ||
到着時刻 | to_time | 日付時刻 | ||
総移動時間(単位:分) | time | 数値 | ||
移動距離(単位:m) | distance | 数値 | ||
規制情報 | notations | 文字列 | regulation:規制突破 | |
燃費 | fuel | Fuelオブジェクト |
Fuelオブジェクト
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
1ℓ当たりの走行可能距離 | per1L | 数値 | ||
消費ガソリン量 | consumption | 数値 |
RouteSectionItemオブジェクト(type=point:地点間の地点情報)
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
タイプ | type | 文字列 | 常に'point'が入る | |
緯度経度 | coord | Coordinateオブジェクト | 出発地点または到着地点の緯度経度が出力される | |
地点名称 | name | 文字列 | 'start'または'goal'という文字列、または リクエストパラメータにて入力された地点情報のJSONにおけるnameの値 ターンバイターン情報つき指定時は交差点名が出力される |
|
フェリー乗降 | ferry | 文字列 | on:フェリー乗り場 off:フェリー降り場 ターンバイターン情報つき指定時、かつフェリーを利用する場合に出力 |
|
前区間からの角度 | direction | 数値 | 右回りに16分割した角度 1の場合は22.5度 ターンバイターン情報つき指定時に出力 |
|
高速道路情報 | highway | 文字列 | on:IC乗り口 off:IC降り口 junction:ジャンクション connection:高速接続(用賀等) |
|
経由地フラグ | with_via | 真偽値 | 経由地かどうかのフラグ | |
経由地点の滞在時間 | stay_time | 数値 | 経由地の場合のみ出力 |
RouteSectionItemオブジェクト(type=move:地点間の移動情報)
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
タイプ | type | 文字列 | 常に'move'が入る | |
移動手段 | move | 文字列 | ||
出発時間 | from_time | 日付時刻 | 一つ上のpointからの出発時刻 | |
到着時間 | to_time | 日付時刻 | 一つ下のpointへの到着時刻 | |
移動時間(単位:分) | time | 数値 | type=point間の移動時間 | |
移動距離(単位:m) | distance | 数値 | type=point間の移動距離 | |
道路名 | line_name | 文字列 | ターンバイターン情報つき指定時は道路名を出力 道路名がない場合は出力されない |
|
規制情報 | restrictions | Restrictionオブジェクト | 〇 |
Restrictionオブジェクト
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
緯度経度 | coord | Coordinateオブジェクト | ||
リンクの長さ | link_length | 数値 | ||
規制内容 | matter | 文字列 | closed:通行止め ingress:進入禁止 closed_one_way:一方通行逆走 closed_before_opening:開通前道路走行 closed_dangerous_goods:危険物積載車両 closed_zone30:ゾーン30情報 closed_tandem:タンデム規制 closed_speed:速度規制 closed_lane:車線規制 closed_one_side:片側規制 closed_chain:チェーン規制 closed_moving:移動規制 closed_on_ramp:オンランプ規制 closed_off_ramp:オフランプ規制 closed_others:その他規制 limit_car_width:車幅規制[cm] limit_car_height:車高規制[kg] limit_car_weight:重量規制[kg] limit_car_length:車長規制[cm] limit_car_max_load:最大積載量規制[kg] limit_displacement:排気量規制[cc] car_type_closed:車種別通行止め car_type_ingress:車種別進入禁止 |
FareItemオブジェクト(type=point:地点の料金情報)
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
タイプ | type | 文字列 | 常に'point'が入る | |
緯度経度 | coord | Coordinateオブジェクト | ||
地点名称 | name | 文字列 |
FareItemオブジェクト(type=move:地点間の料金情報)
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
種別 | type | 文字列 | 常に'move'が入る | |
料金詳細情報 | detail | FareDetailオブジェクト | ||
出発時間 | from_time | 日付時刻 | 一つ上のpointからの出発時刻 | |
到着時間 | to_time | 日付時刻 | 一つ下のpointへの到着時刻 | |
移動時間(単位:分) | time | 数値 | type=point間の移動時間 | |
道路名 | line_name | 文字列 | 区間の道路名 |
FareDetailオブジェクト
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
料金シーズン | fare_season | 文字列 | normal:通常期 busy:繁忙期 slack:閑散期 |
|
料金 | fare | Fareオブジェクト | 〇 |
Fareオブジェクト
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
料金 | unit_{料金区分ID}_{車種ID} | 数値 | 〇 |
Coordinateオブジェクト
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
地点の緯度 | lat | 数値 | ||
地点の経度 | lon | 数値 |
Unitオブジェクト
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
緯度経度の測地系 | datum | 文字列 | ||
緯度経度の出力形式 | coord_unit | 文字列 | ||
距離の単位 | distance | 文字列 | ||
所要時間の単位 | time | 文字列 | ||
通貨の単位 | currency | 文字列 |
レスポンス例
・ルートの概要
{ "items": [ { "summary": { "no": "1", "start": { "type": "point", "coord": { "lat": 35.689457, "lon": 139.691935 }, "name": "東京都庁" }, "goal": { "type": "point", "coord": { "lat": 35.862207, "lon": 139.970879 }, "name": "柏" }, "move": { "fare": { "unit_1025_5": 3390.0, "unit_1024_5": 3780.0, "unit_1025_4": 2520.0, "unit_1024_4": 2820.0, "unit_1025_3": 1800.0, "unit_1024_3": 2000.0, "unit_1025_2": 1670.0, "unit_1024_2": 1840.0, "unit_1025_1": 1370.0, "unit_1024_1": 1510.0 }, "toll_road_distance": 40809, "type": "move", "from_time": "2019-10-01T08:00:00+09:00", "to_time": "2019-10-01T09:05:17+09:00", "time": 65, "distance": 49168 } }, }, ・・・ ], "unit": { "datum": "wgs84", "coord_unit": "degree", "distance": "metre", "time": "minute", "currency": "JPY" } }
・ルート内の移動情報
"sections": [ { "type": "point", "coord": { "lat": 35.689457, "lon": 139.691935 }, "name": "東京都庁" }, { "type": "move", "move": "car", "from_time": "2019-10-01T08:00:00+09:00", "to_time": "2019-10-01T08:00:37+09:00", "time": 0, "distance": 300 }, { "type": "point", "coord": { "lat": 35.692171, "lon": 139.691681 }, "name": "都庁北", "direction": 12 }, { "type": "move", "move": "car", "from_time": "2019-10-01T08:00:37+09:00", "to_time": "2019-10-01T08:03:49+09:00", "time": 3, "distance": 926, "line_name": "方南通り" }, { ・・・ }, { "type": "point", "coord": { "lat": 35.862808, "lon": 139.972082 }, "name": "交差点", "direction": 14 }, { "from_time": "2019-10-01T09:04:36+09:00", "to_time": "2019-10-01T09:05:17+09:00", "time": 0, "distance": 100 }, { "type": "point", "coord": { "lat": 35.862207, "lon": 139.970879 }, "name": "柏" } ],
・案内地点情報の概要(高速道路利用の場合)
{ "type": "point", "coord": { "lat": 35.691791, "lon": 139.68175 }, "name": "中野長者橋出入口", "direction": 2, "highway": "on" }, { "type": "move", "move": "car", "from_time": "2019-10-01T08:05:24+09:00", "to_time": "2019-10-01T08:13:08+09:00", "time": 7, "distance": 6881, "line_name": "首都中央環状線" },
・高速道路料金の概要
"fares": [ { "type": "point", "coord": { "lat": 35.693911, "lon": 139.682273 }, "name": "中野長者橋" }, { "detail": { "fare_season": "normal", "fare": { "unit_1024_1": 1090.0, "unit_1025_1": 950.0, "unit_1024_2": 1320.0, "unit_1025_2": 1150.0, "unit_1024_3": 1410.0, "unit_1025_3": 1210.0, "unit_1024_4": 2080.0, "unit_1025_4": 1780.0, "unit_1024_5": 2650.0, "unit_1025_5": 2260.0 } }, "type": "move", "from_time": "2019-10-01T08:05:46+09:00", "to_time": "2019-10-01T08:36:56+09:00", "time": 31, "line_name": "首都中央環状線" }, { "type": "point", "coord": { "lat": 35.832687, "lon": 139.855979 }, "name": "三郷" }, { "detail": { "fare_season": "normal", "fare": { "unit_1024_1": 420.0, "unit_1025_1": 420.0, "unit_1026_1": 420.0, "unit_1039_1": 290.0, "unit_1024_2": 520.0, "unit_1025_2": 520.0, "unit_1026_2": 520.0, "unit_1039_2": 360.0, "unit_1024_3": 590.0, "unit_1025_3": 590.0, "unit_1026_3": 590.0, "unit_1039_3": 410.0, "unit_1024_4": 740.0, "unit_1025_4": 740.0, "unit_1026_4": 740.0, "unit_1039_4": 520.0, "unit_1024_5": 1130.0, "unit_1025_5": 1130.0, "unit_1026_5": 1130.0, "unit_1039_5": 790.0 } }, "type": "move", "from_time": "2019-10-01T08:36:56+09:00", "to_time": "2019-10-01T08:46:02+09:00", "time": 9, "line_name": "常磐自動車道" }, { "type": "point", "coord": { "lat": 35.907829, "lon": 139.937401 }, "name": "柏" } ]