Directions 5 API
- 印刷する
- PDF
Directions 5 API
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
VPC環境で利用できます。
入力した情報(出発地、経由地、目的地など)をもとに、車のルートと通行情報(所要時間、距離、予想ガソリン代、通行料金情報、分岐点案内)を照会します。
注意
すべてのルートはリアルタイムの交通情報を反映しているため、出発地、目的地、オプションが同じでも同じルートを保証するものではありません。
参考
Directions 5 APIは、経由地を最大5個まで入力できます。より多くの経由地を入力するには、Directions 15 APIをご参照ください。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET | /driving |
リクエストヘッダ
Maps APIで共通して使用されるヘッダの詳細は、Mapsの共通ヘッダをご参照ください。
リクエストクエリパラメータ
リクエストクエリパラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
start | String | Required | 出発地(経度,緯度)
|
goal | String | Required | 目的地(経度,緯度)
|
waypoints | String | Optional | 経由地(経度,緯度)
|
option | String | Optional | ルート検索オプション
|
cartype | Integer | Optional | 車両のタイプ
|
fueltype | String | Optional | 燃料のタイプ
|
mileage | Double | Optional | 燃費
|
lang | String | Optional | レスポンス結果の言語
|
リクエスト例
リクエストのサンプルコードは次の通りです。
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 | - | リクエストしたオプションによるルート情報
|
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 に向かう方向
|
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 | - | ルートを構成する座標
|
section | Array | - | 主要道路情報
|
guide | Array | - | 分岐点案内情報 |
section
section
の説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
pointIndex | Integer | - | ルートを構成する座標のインデックス |
pointCount | Integer | - | 形状点数 |
distance | Integer | - | 距離(m) |
name | String | - | 道路名 |
congestion | - | 混雑度分類コード
| |
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
}
]
}
]
}
}
この記事は役に立ちましたか?