Directions 5

Prev Next

VPC環境で利用できます。

入力した情報(出発地、経由地、目的地など)をもとに、車のルートと通行情報(所要時間、距離、予想ガソリン代、通行料金情報、分岐点案内)を照会します。

注意

すべてのルートはリアルタイムの交通情報を反映しているため、出発地、目的地、オプションが同じでも同じルートを保証するものではありません。

参考

Directions 5 APIは、経由地を最大5個まで入力できます。より多くの経由地を入力するには、Directions 15 APIをご参照ください。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /driving

リクエストヘッダ

Maps APIで共通して使用されるヘッダの詳細は、Mapsの共通ヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
start String Required 出発地(経度,緯度)
  • <例> start=127.12345,37.12345
goal String Required 目的地(経度,緯度)
  • 「:」で区切って最大10個の目的地を入力可能
  • 入力した目的地のうち、最も少ない費用で到達できる目的地へのルートを検索
  • <例> goal=123.45678,34.56789:124.56789,35.67890
waypoints String Optional 経由地(経度,緯度)
  • 「| (Pipe char)」で区切って最大5個の経由地を入力可能
  • 同じ経由地の座標が2つある場合、「:」で区切って入力
  • <例> waypoints=127.12345,37.12345:127.23456,37.23456\|128.12345,38.12345:128.23456,38.23456
option String Optional ルート検索オプション
  • 「:」で区切って最大3個のオプションを入力可能
  • trafast | tracomfort | traoptimal(デフォルト) | traavoidtoll | traavoidcaronly
    • trafast: リアルタイム最短ルート
    • tracomfort: リアルタイム最も快適なルート
    • traoptimal: リアルタイム最適
    • traavoidtoll: 無料優先
    • traavoidcaronly: 自動車専用道路回避優先
cartype Integer Optional 車両のタイプ
  • 1(デフォルト) | 2 | 3 | 4 | 5 | 6
    • 1: 1種の小型車2軸車(輪幅279.4mm以下の乗用車、小型ワゴン車、小型貨物車)
    • 2: 2種の2軸車(輪幅279.4mm超え、輪距1,800mm以下の中型ワゴン車、中型貨物車)
    • 3: 3種の大型車2軸車(輪幅279.4mm超え、輪距1,800mm超えの大型ワゴン車、2軸大型貨物車)
    • 4: 4種の3軸大型貨物車
    • 5: 5種の4軸以上の特殊貨物車
    • 6: 1種の軽自動車(排気量1000cc未満で長さ3.6m、幅1.6m、高さ2.0m以下)
  • 一般的な乗用車はすべて1を入力
  • 料金所の料金計算に使用され、車種による重量や大きさは判断しない
fueltype String Optional 燃料のタイプ
  • gasoline(デフォルト) | highgradegasoline | diesel | lpg
    • gasoline: レギュラー
    • highgradegasoline: ハイオク
    • diesel: 軽油
    • lpg: LPG
  • ガソリン代の計算に使用
mileage Double Optional 燃費
  • 使用する車の燃費を直接設定する場合に入力
  • 14(デフォルト)
lang String Optional レスポンス結果の言語
  • ko(デフォルト) | en | ja | zh
    • ko: 韓国語
    • en: 英語
    • ja: 日本語
    • zh: 中国語簡体字

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-direction/v1/driving?goal=129.075986%2C35.179470&start=127.1058342%2C37.359708' \
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
code Integer - レスポンスコード
message String - レスポンスメッセージ
currentDateTime String - ルート検索日時(yyyy-MM-ddTHH:mm:ss)
route Object - ルート検索の結果
route.{option} Array - リクエストしたオプションによるルート情報
  • trafast | tracomfort | traoptimal | traavoidtoll | traavoidcaronly
    • trafast: リアルタイム最短ルート
    • tracomfort: リアルタイム最も快適なルート
    • traoptimal: リアルタイム最適
    • traavoidtoll: 無料優先
    • traavoidcaronly: 自動車専用道路回避優先

route.{option}

route.{option}の説明は次の通りです。

フィールド タイプ 必須の有無 説明
summary Object - ルートのサマリー情報
summary.start Object - 出発地情報
summary.start.location Array - 出発地座標(経度,緯度)
summary.goal Object - 目的地情報
summary.goal.location Array - 目的地座標(経度,緯度)
summary.goal.dir Integer - ルート上でlocationに向かう方向
  • ルート上の進行方向を中心に、実際の経由地/到着地として指定した地点の方向を示す
  • 0 | 1 | 2
    • 0: 前方
    • 1: 左
    • 2: 右
summary.distance Integer - ルートの総距離(m)
summary.duration Integer - ルート全体の所要時間(ミリ秒)
summary.departureTime String - 予想到着日時(yyyy-MM-ddTHH:mm:ss)
summary.bbox Array - 全ルートの境界領域(Left Bottom Point, Right Top Point)
summary.tollFare Integer - 通行(料金所)料金
summary.taxiFare Integer - タクシー料金
  • タクシー料金に影響する要素(地域、割増(深夜、市界外、複合)、迎車料金)を考慮して計算
summary.fuelPrice Integer - ガソリン代
  • ルート検索時の全国平均のガソリン代と燃費を考慮して計算
path Array - ルートを構成する座標
  • 座標には0からスタートするpointIndexが存在
  • ルートを構成する全座標を表示
section Array - 主要道路情報
  • 全ルートのうち走行距離が長い一部のルートの情報を道路名で表示
guide Array - 分岐点案内情報

section

sectionの説明は次の通りです。

フィールド タイプ 必須の有無 説明
pointIndex Integer - ルートを構成する座標のインデックス
pointCount Integer - 形状点数
distance Integer - 距離(m)
name String - 道路名
congestion - 混雑度分類コード
  • 0 | 1 | 2 | 3
    • 0: 値なし
    • 1: 順調
    • 2: 混雑
    • 3: 渋滞
  • 混雑度の基準は混雑度の基準を参照
speed Integer - 平均速度(km/h)

混雑度の基準
混雑度の基準は次の通りです。

参考

道路別リアルタイムの通行速度を基準にしたもので、速度単位は km/hです。

コード 一般道路 国道 都市高速 高速道路
順調 30以上 40以上 60以上 70以上
混雑 15~30 20~40 30~60 40~70
渋滞 15未満 20未満 30未満 40未満

guide

guideの説明は次の通りです。

フィールド タイプ 必須の有無 説明
pointIndex Integer - ルートを構成する座標のインデックス
type Integer - 分岐点案内のタイプ
instructions String - ルート案内メッセージ
distance Integer - 以前の分岐点のルート構成座標インデックスからこの分岐点のルート構成座標インデックスまでの距離(m)
duration Integer - 以前の分岐点のルート構成座標インデックスからこの分岐点のルート構成座標インデックスまでの所要時間(ミリ秒)

分岐点案内コード
分岐点案内コードの説明は次の通りです。

コード 説明
1 直進方向
2 左折
3 右折
4 左方向
5 右方向
6 Uターン
8 非保護の左折
11 左8時方向
12 左9時方向
13 左11時方向
14 右1時方向
15 右3時方向
16 右4時方向
21 ロータリーから直進方向
22 ロータリーから Uターン
23 ロータリーから左7時方向
24 ロータリーから左8時方向
25 ロータリーから左9時方向
26 ロータリーから左10時方向
27 ロータリーから左11時方向
28 ロータリーから12時方向
29 ロータリーから右1時方向
30 ロータリーから右2時方向
31 ロータリーから右3時方向
32 ロータリーから右4時方向
33 ロータリーから右5時方向
34 ロータリーから6時方向
41 左側道路入口
42 右側道路入口
47 SA入口
48 フェリー航路入口
49 フェリー航路出口
50 前方に高速道路入口
51 前方に高速道路出口
52 前方に都市高速道路入口
53 前方に都市高速道路出口
54 前方に分岐道路入口
55 前方に高架道路入口
56 前方に地下車道入口
57 左に高速道路入口
58 左に高速道路出口
59 左に都市高速道路入口
60 左に都市高速道路出口
62 左に高架道路入口
63 左に高架道路路肩
64 左に地下車道入口
65 左に地下車道路肩
66 右に高速道路入口
67 右に高速道路出口
68 右に都市高速道路入口
69 右に都市高速道路出口
71 右に高架道路入口
72 右に高架道路路肩
73 右に地下車道入口
74 右に地下車道路肩
75 前方に自動車専用道路入口
76 左に自動車専用道路入口
77 右に自動車専用道路入口
78 前方に自動車専用道路出口
79 左に自動車専用道路出口
80 右に自動車専用道路出口
81 左に本レーンに合流
82 右に本レーンに合流
87 経由地
88 到着地
91 ラウンドアバウトから直進方向
92 ラウンドアバウトから Uターン
93 ラウンドアバウトから左7時方向
94 ラウンドアバウトから左8時方向
95 ラウンドアバウトから左9時方向
96 ラウンドアバウトから左10時方向
97 ラウンドアバウトから左11時方向
98 ラウンドアバウトから12時方向
99 ラウンドアバウトから右1時方向
100 ラウンドアバウトから右2時方向
101 ラウンドアバウトから右3時方向
102 ラウンドアバウトから右4時方向
103 ラウンドアバウトから右5時方向
104 ラウンドアバウトから6時方向
121 料金所
122 ハイパス専用の料金所
123 ワントゥーリング料金所

レスポンスステータスコード

レスポンスステータスコードの説明は次の通りです。

HTTPステータスコード コード メッセージ 説明
200 0 - リクエスト処理成功。ルート探し成功
200 1 - リクエスト処理失敗。出発地と到着地が同じ
200 2 - リクエスト処理失敗。出発地または到着地が道路周辺ではない
200 3 - リクエスト処理失敗。車のルート探し結果を提供できない
200 4 - リクエスト処理失敗。経由地が道路周辺ではない
200 5 - リクエスト処理失敗。経由地を含む直線距離の合計が1500km以上のルートがリクエストされる
参考

Maps APIで共通して使用されるレスポンスステータスコードの詳細は、Mapsの共通レスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "code": 0,
    "message": "ルートが見つかりました。",
    "currentDateTime": "2024-09-03T14:39:25",
    "route": {
        "traoptimal": [
            {
                "summary": {
                    "start": {
                        "location": [
                            127.1058342,
                            37.3597080
                        ]
                    },
                    "goal": {
                        "location": [
                            129.0759854,
                            35.1794698
                        ],
                        "dir": 2
                    },
                    "distance": 380044,
                    "duration": 15856847,
                    "departureTime": "2024-09-03T14:39:24",
                    "bbox": [
                        [
                            127.0833901,
                            35.1793190
                        ],
                        [
                            129.1969372,
                            37.3597094
                        ]
                    ],
                    "tollFare": 21000,
                    "taxiFare": 352360,
                    "fuelPrice": 45056
                },
                "path": [
                    [
                        127.1059979,
                        37.3597094
                    ],
                    // (省略)
                    [
                        129.0762855,
                        35.1793190
                    ]
                ],
                "section": [
                    {
                        "pointIndex": 315,
                        "pointCount": 1018,
                        "distance": 95575,
                        "name": "京釜高速道路",
                        "congestion": 1,
                        "speed": 83
                    },
                    {
                        "pointIndex": 2157,
                        "pointCount": 812,
                        "distance": 92508,
                        "name": "尚州永川高速道路",
                        "congestion": 1,
                        "speed": 108
                    },
                    {
                        "pointIndex": 2968,
                        "pointCount": 833,
                        "distance": 89391,
                        "name": "京釜高速道路",
                        "congestion": 1,
                        "speed": 106
                    }
                ],
                "guide": [
                    {
                        "pointIndex": 50,
                        "type": 3,
                        "instructions": "モネ公園交差点で「西盆唐(高基) IC」方面に右折",
                        "distance": 1075,
                        "duration": 262406
                    },
                    // (省略)
                    {
                        "pointIndex": 4065,
                        "type": 88,
                        "instructions": "目的地",
                        "distance": 904,
                        "duration": 147960
                    }
                ]
            }
        ]
    }
}