ルート検索(自転車)

/route_bicycle [GET]

基本情報

概要

自転車を移動手段として、2地点間のルートを検索します。経由地の指定も可能です。

URL

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

※Rakuten RapidAPIの場合はURL体系が異なります

出力形式

  • JSON

対応言語

  • ja

出力順

  • 検索条件を考慮した最適な経路の順

パラメータ

パラメータ名 必須 概要 型名 デフォルト値 上下限/選択値 備考
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: 巡回(最適)順
指定した経由地をどのように巡回するかを指定します
speed 自転車の速度(単位:km/h) 整数値 15 最小値:5
最大値:132
自転車の速度を設定する場合は整数で時速を指定してください
condition 自転車ルート検索の優先考慮事項 文字列 recommend recommend:推奨ルート
total_distance:総距離が短い
low_pitched:坂道が少ない
high_pitched:坂道が多い
main_street:大通り優先
back_street:裏通り優先
cycling_road:サイクリングロード優先
options 追加出力情報 文字列 turn_by_turn:ターンバイターン情報 交差点等、進行情報を案内するための地点情報を取得します
datum 緯度経度の測地系 文字列 wgs84 wgs84:世界測地系
tokyo:旧日本測地系
coord_unit 出力データに含まれる緯度経度の単位 文字列 degree degree:度表記の10進法
millisec:ミリ秒表記

自転車の速度指定について

所要時間の精度向上のため、指定された速度を基準にルートの諸条件を考慮したものが利用されます。
必ずしも指定した速度の通りの所要時間にはならないことがありますので、予めご了承ください。

地点の JSON 表現

プロパティ名 必須 概要 型名 デフォルト値 備考
lat (✔) 緯度 数値
lon (✔) 経度 数値
node (✔) 駅/連絡バス停ID 文字列 経由地の場合、駅/連絡バス停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}]

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

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

パラメータ構成例

・出発地:表参道ヒルズ、到着地:調布駅、出発時刻:2019年10月1日8時、ターンバイターン情報付き

/route_bicycle?start={"lat":35.663836,"lon":139.712258,"name":"表参道ヒルズ"}&goal=00006197&start_time=2019-10-01T08:00:00&options=turn_by_turn

パラメータ構成例(複数経由地を最適な順序で巡回するルート検索)

・出発地と目的地は同一座標とし、経由地を3ヶ所指定する

/route_bicycle?start=35.656410,139.726470&goal=35.656410,139.726470&via_type=optimal&via=[{"lat":35.654043,"lon":139.729466},{"lat":35.657228,"lon":139.727767},{"lat":35.659499,"lon":139.730031}]&goal_time=2019-10-01T15:00:00

 

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

レスポンス

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

Routeオブジェクト

名称 レスポンス名 型名 配列 説明
経路の概要 summary RouteSummaryオブジェクト 経路の概要に関する情報のまとまり
地点間の移動方法 sections RouteSectionItemオブジェクト 地点間の移動に関する情報のまとまり

RouteSummaryオブジェクト

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

RouteItemオブジェクト(start/goal)

名称 レスポンス名 型名 配列 説明
タイプ type 文字列 常に'point'が入る
地点の緯度経度 coord Coordinateオブジェクト 出発地点または到着地点の緯度経度が出力される
地点の名称 name 文字列 'start'または'goal'という文字列
リクエストパラメータにて入力された地点情報のJSONにおけるnameの値のどちらかが出力される

Coordinateオブジェクト(start/goal/via/point)

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

RouteItemオブジェクト(move:移動情報)

名称 レスポンス名 型名 配列 説明
消費カロリー(単位:cal) calorie 数値
タイプ type 文字列 常に'move'が入る
出発時間 from_time 文字列
到着時間 to_time 文字列
総移動時間(単位:分) time 数値
移動距離(単位:m) distance 数値

RouteItemオブジェクト(via:経由地)

名称 レスポンス名 型名 配列 説明
経由地出発時刻 from_time 文字列
経由地到着時刻 to_time 文字列
タイプ type 文字列 常に'point'が入る
経由地の緯度経度 coord Coordinateオブジェクト
経由地名称 name 文字列 具体的には'経由地'という文字列または
リクエストパラメータにて入力された地点情報のJSONにおけるnameの値のどちらかが出力される

 

viaオブジェクトは経由地指定時のみ出力され、経由地の数だけ存在します。

RouteSectionItemオブジェクト(type=point:地点間の地点情報)

名称 レスポンス名 型名 配列 説明
タイプ type 文字列 常に'point'が入る
地点の緯度経度 coord Coordinateオブジェクト
地点名称 name 文字列 デフォルトの名称または
リクエストで入力した名称のどちらかが出力される
経由地かどうかのフラグ with_via 真偽値 常に'true'が入る
経由地点の滞在時間 stay_time 数値 前後の移動情報から算出

RouteSectionItemオブジェクト(type=move:地点間の移動情報)

名称 レスポンス名 型名 配列 説明
タイプ type 文字列 常に'move'が入る
移動手段 move 文字列 常に'bicycle'が入る
一つ上のpointからの出発時刻 from_time 文字列
一つ下のpointへの到着時刻 to_time 文字列  
point間の移動時間(単位:分) time 数値
point間の移動距離(単位:m) distance 数値

Unitオブジェクト

名称 レスポンス名 型名 配列 説明
緯度経度の測地系 datum 文字列
緯度経度の出力形式 coord_unit 文字列
距離の単位 distance 文字列 常に 'metre'が入る
所要時間の単位 time 文字列 常に 'minute'が入る

レスポンス例

・出発地:表参道ヒルズ、到着地:調布駅、出発時刻:2019年10月1日8時、ターンバイターン情報付き

{
    "items": [
        {
            "summary": {
                "no": "1",
                "start": {
                    "type": "point",
                    "coord": {
                        "lat": 35.663836,
                        "lon": 139.712258,
                        "alt": 33.0
                    },
                    "name": "表参道ヒルズ"
                },
                "goal": {
                    "type": "point",
                    "coord": {
                        "lat": 35.65162,
                        "lon": 139.54531,
                        "alt": 35.0
                    },
                    "name": "調布"
                },
                "move": {
                    "type": "move",
                    "from_time": "2019-10-01T08:00:00+09:00",
                    "to_time": "2019-10-01T09:14:30+09:00",
                    "time": 74,
                    "distance": 16467
                }
            },
            "sections": [
                {
                    "type": "point",
                    "coord": {
                        "lat": 35.663836,
                        "lon": 139.712258
                    },
                    "name": "表参道ヒルズ"
                },
                {
                    "type": "move",
                    "move": "bicycle",
                    "from_time": "2019-10-01T08:00:00+09:00",
                    "to_time": "2019-10-01T08:00:13+09:00",
                    "time": 0,
                    "distance": 58
                },
                {
                    "type": "point",
                    "coord": {
                        "lat": 35.664196,
                        "lon": 139.711788
                    },
                    "name": "交差点"
                },
                {
                    "type": "move",
                    "move": "bicycle",
                    "from_time": "2019-10-01T08:00:13+09:00",
                    "to_time": "2019-10-01T08:03:14+09:00",
                    "time": 3,
                    "distance": 692
                },
                {
          ・・・
                },
                {
                    "type": "point",
                    "coord": {
                        "lat": 35.651165,
                        "lon": 139.546576
                    },
                    "name": "交差点"
                },
                {
                    "type": "move",
                    "move": "bicycle",
                    "from_time": "2019-10-01T09:13:52+09:00",
                    "to_time": "2019-10-01T09:14:30+09:00",
                    "time": 0,
                    "distance": 124
                },
                {
                    "type": "point",
                    "coord": {
                        "lat": 35.65162,
                        "lon": 139.54531
                    },
                    "name": "調布"
                }
            ]
        }
    ],
    "unit": {
        "datum": "wgs84",
        "coord_unit": "degree",
        "distance": "metre",
        "time": "minute"
    }
}