Directions 15 API
    • PDF

    Directions 15 API

    • PDF

    記事の要約

    VPC環境で利用できます。

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

    注意

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

    リクエスト

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

    メソッドURI
    GET/driving

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    startStringRequired出発地(経度,緯度)
    • <例> start=127.12345,37.12345
    goalStringRequired目的地(経度,緯度)
    • 「:」で区切って最大10個の目的地を入力可能
    • 入力した目的地のうち、最も少ない費用で到達できる目的地へのルートを検索
    • <例> goal=123.45678,34.56789:124.56789,35.67890
    waypointsStringOptional経由地(経度,緯度)
    • 「| (Pipe char)」で区切って最大5個の経由地を入力可能
    • 同じ経由地の座標が2つある場合、「:」で区切って入力
    • <例> waypoints=127.12345,37.12345:127.23456,37.23456\|128.12345,38.12345:128.23456,38.23456
    optionStringOptionalルート検索オプション
    • 「:」で区切って最大3個のオプションを入力可能
    • trafast | tracomfort | traoptimal(デフォルト) | traavoidtoll | traavoidcaronly
      • trafast: リアルタイム最短ルート
      • tracomfort: リアルタイム最も快適なルート
      • traoptimal: リアルタイム最適
      • traavoidtoll: 無料優先
      • traavoidcaronly: 自動車専用道路回避優先
    cartypeIntegerOptional車両のタイプ
    • 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を入力
    • 料金所の料金計算に使用され、車種による重量や大きさは判断しない
    fueltypeStringOptional燃料のタイプ
    • gasoline(デフォルト) | highgradegasoline | diesel | lpg
      • gasoline: レギュラー
      • highgradegasoline: ハイオク
      • diesel: 軽油
      • lpg: LPG
    • ガソリン代の計算に使用
    mileageDoubleOptional燃費
    • 使用する車の燃費を直接設定する場合に入力
    • 14(デフォルト)
    langStringOptionalレスポンス結果の言語
    • ko(デフォルト) | en | ja | zh
      • ko: 韓国語
      • en: 英語
      • ja: 日本語
      • zh: 中国語簡体字

    リクエスト例

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

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

    レスポンス

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

    レスポンスボディ

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

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

    route.{option}

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

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

    section

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

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

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

    参考

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

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

    guide

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

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

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

    コード説明
    1直進方向
    2左折
    3右折
    4左方向
    5右方向
    6Uターン
    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右側道路入口
    47SA入口
    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ステータスコードコードメッセージ説明
    2000-リクエスト処理成功。ルート探し成功
    2001-リクエスト処理失敗。出発地と到着地が同じ
    2002-リクエスト処理失敗。出発地または到着地が道路周辺ではない
    2003-リクエスト処理失敗。車のルート探し結果を提供できない
    2004-リクエスト処理失敗。経由地が道路周辺ではない
    2005-リクエスト処理失敗。経由地を含む直線距離の合計が1500km以上のルートがリクエストされる
    参考

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

    レスポンス例

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

    {
        "code": 0,
        "message": "ルートが見つかりました。",
        "currentDateTime": "2024-08-27T17:17:21",
        "route": {
            "traoptimal": [
                {
                    "summary": {
                        "start": {
                            "location": [
                                127.1058342,
                                37.3597080
                            ]
                        },
                        "goal": {
                            "location": [
                                129.0759854,
                                35.1794698
                            ],
                            "dir": 2
                        },
                        "distance": 378984,
                        "duration": 15213293,
                        "departureTime": "2024-08-27T17:17:20",
                        "bbox": [
                            [
                                127.0999824,
                                35.1793190
                            ],
                            [
                                129.0817364,
                                37.3940298
                            ]
                        ],
                        "tollFare": 19300,
                        "taxiFare": 348820,
                        "fuelPrice": 45283
                    },
                    "path": [
                        [
                            127.1059979,
                            37.3597094
                        ],
                        // (省略)
                        [
                            129.0762855,
                            35.1793190
                        ]
                    ],
                    "section": [
                        {
                            "pointIndex": 826,
                            "pointCount": 1430,
                            "distance": 151091,
                            "name": "中部内陸高速道路",
                            "congestion": 1,
                            "speed": 99
                        },
                        {
                            "pointIndex": 2255,
                            "pointCount": 564,
                            "distance": 61004,
                            "name": "京釜高速道路",
                            "congestion": 1,
                            "speed": 104
                        },
                        {
                            "pointIndex": 2818,
                            "pointCount": 827,
                            "distance": 82790,
                            "name": "中央高速道路(釜山-大邱)",
                            "congestion": 1,
                            "speed": 102
                        }
                    ],
                    "guide": [
                        {
                            "pointIndex": 50,
                            "type": 3,
                            "instructions": "モネ公園交差点で「西盆唐(高基) IC」方面に右折",
                            "distance": 1075,
                            "duration": 284218
                        },
                        // (省略)
                        {
                            "pointIndex": 4054,
                            "type": 88,
                            "instructions": "目的地",
                            "distance": 904,
                            "duration": 107763
                        }
                    ]
                }
            ]
        }
    }
    

    この記事は役に立ちましたか?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.