ルート形状取得(自転車)

/shape_bicycle [GET]

基本情報

概要

自転車を移動手段として2地点間のルートを検索し、その結果を形状で取得します。

URL

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

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

出力形式

  • GeoJSON
  • JSON

対応言語

  • ja

パラメータ

  • 「ルート検索(自転車) /route_bicycle」と同等のパラメータを受け付けます
  • 本API独自のパラメータは以下の通りです
パラメータ名 必須 概要 型名 デフォルト値 上下限/選択値 備考
format 出力形式 文字列 geojson geojson:GeoJSON 形式
json:JSON 形式

フォーマットについて

GeoJSON は地理形状を表現する一般的なフォーマットです。
GeoJSON形式の出力結果は、/map_script で利用できます。
JSON形式の出力結果は、/map_image で利用できます。

パラメータ構成例

・出発地:表参道ヒルズ、到着地:調布駅、出発時刻:2019年10月1日8時、ターンバイターン情報付きの自転車ルート形状をGeoJSONで取得

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

 

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

レスポンス(GeoJSON)

  • パラメータ「format=geojson」と指定した場合に出力されるGeoJSONオブジェクトを以下に記載します

FeatureCollectionオブジェクト

名称 レスポンス名 型名 配列 説明
種別 type 文字列 FeatureCollection を表すタイプ名'FeatureCollection'を出力
形状に関する情報 features Featureオブジェクト
形状全体のバウンディングボックス bbox 数値

Featureオブジェクト

名称 レスポンス名 型名 配列 説明
種別 type 文字列 Feature を表すタイプ名'Feature'を出力
形状全体のバウンディングボックス bbox 数値
形状の緯度経度情報 geometry Geometryオブジェクト
形状のメタ情報 properties Propertyオブジェクト ガイダンスポイント情報や線の属性などを保存

Geometryオブジェクト

名称 レスポンス名 型名 配列 説明
種別 type 文字列 Geometry を表すタイプ名'LineString'を出力
緯度/経度/標高 coordinates カンマ区切りの緯度/経度/標高の配列

Propertyオブジェクト

名称 レスポンス名 型名 配列 説明
移動情報 ways 文字列 常に 'bicycle'が入る
区間区分群 section 文字列 出発地/経由地/目的地のまとまりを示す
線(内側) inline Lineオブジェクト
線(外側) outline Lineオブジェクト
屋内ルートフラグ indoor 真偽値
規制突破フラグ restriction 真偽値

Lineオブジェクト

名称 レスポンス名 型名 配列 説明
線種 line_style 文字列 次のいずれかの文字列
- solid:実線
- dashed:破線
- dotted:点線
- auxiliary:補助線
線の幅(単位:px) width 文字列
線の色 color 文字列 色(RGB形式)
透過度 opacity 数値 透過度(0.0~1.0)
線端の形状 strokelinecap 文字列 線の両端の形状
常に'round'が入る
- round:丸い線端
角の形状 strokelinejoin 文字列 コーナーポイントの形状
常に'round'が入る
- round:丸い角

bbox(バウンディングボックス)について

GeoJSON形式のレスポンスに含まれるはバウンディングボックスとは、形状全体を包み込む四角形の緯度経度を最高値から最低値に向かって記述したものです。
これを利用すると、形状全体が描画される尺度を/map_scriptに与えることができます。

auxiliary(補助線)について

補助線(引き出し線)は、ルート線の端点から出発地と目的地に向けて直線で結んだ線です。
河川や線路など、実際には通行できない箇所をまたぐ線となることがあります。

レスポンス(JSON)

  • パラメータ「format=json」と指定した場合に出力されるJSONオブジェクトを以下に記載します
名称 レスポンス名 型名 配列 説明
検索結果一覧 items RouteShapeオブジェクト
単位情報 unit Unitオブジェクト

RouteShapeオブジェクト

名称 レスポンス名 型名 配列 説明
マーカー一覧 marker Markerオブジェクト
パス一覧 path Pathオブジェクト

Markerオブジェクト

名称 レスポンス名 型名 配列 説明
画像の起点場所 position 文字列 次のいずれかの文字列
bottom:下
bottom_left:左下
bottom_right:右下
left:左
center:中央
right:右
top:上
top_left:左上
top_right:右上
default:デフォルト
中心緯度経度列 centers Coordinateオブジェクト

Coordinateオブジェクト

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

Pathオブジェクト

名称 レスポンス名 型名 配列 説明
緯度経度列 coords カンマ区切りの緯度経度の配列
線の幅 width 数値
線の色 color 文字列
透過度 opacity 数値
道路種別 road_type 文字列 次のいずれかの文字列
highway:高速道路
local:一般道路
ferry:フェリー

Unitオブジェクト

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

レスポンス例

・GeoJSON形式

{
    "type": "FeatureCollection",
    "features": [
        {
            "type": "Feature",
            "bbox": [
                139.712258,
                35.663836,
                139.712274,
                35.663851
            ],
            "geometry": {
                "type": "LineString",
                "coordinates": [
                    [
                        139.712258,
                        35.663836,
                        33.0
                    ],
                    [
                        ・・・
                    ],
                    [
                        139.712274,
                        35.663851,
                        33.0
                    ]
                ]
            },
            "properties": {
                "ways": "bicycle",
                "section": "0001,0002,0003・・・",
                "inline": {
                    "line_style": "auxiliary",
                    "color": "#BFBFBF",
                    "width": 7,
                    "opacity": 0.76,
                    "strokelinecap": "round",
                    "strokelinejoin": "round"
                },
                "outline": {
                    "line_style": "dashed",
                    "color": "#0A6400",
                    "width": 10,
                    "opacity": 0.5,
                    "strokelinecap": "round",
                    "strokelinejoin": "round"
                }
            }
        },
        {
            ・・・
        }
    ],
    "bbox": [
        139.545269,
        35.649649,
        139.712274,
        35.664196
    ]
}

・JSON形式

{
    "items": [
        {
            "marker": [ ],
            "path": [
                {
                    "coords": [
                        [
                            35.663836,
                            139.712258
                        ],
                        [
                            ・・・
                        ],
                        [
                            35.663851,
                            139.712274
                        ]
                    ],
                    "width": 7,
                    "color": "#BFBFBF",
                    "opacity": 0.76
                },
                {
                    ・・・
                }
            ]
        }
    ],
    "unit": {

        "datum": "wgs84",
        "coord_unit": "degree"
    }
}