Pioneer logo
API docs by Redocly

Piomatix LBS API 仕様書 (2.0.15)

Download OpenAPI specification:

Piomatix LBS APIは、パイオニア株式会社が提供する、日本の交通環境に最適化されたルート案内機能を備えたWeb APIです。
このAPIは地点検索やカーボンニュートラル対応などの機能も備えています。
本書では、このAPIの仕様についてOpenAPI仕様に基づいて説明します。

Note: ナビゲーションサイドバー上部の検索窓は 英字と数字のみ対応しています（2文字以上）。
※表題、概要説明、URL内に検索語が含まれている場合に結果をリスト表示します。

Introduction

本WebAPIを利用するにはAPIキーによる認証が必要です。
具体的なAPIキーについては営業窓口までお問い合わせ下さい。
APIキーの利用方法については Authentication を参照下さい。

第三者による不正利用を防ぐため、APIキーの管理には十分にご注意ください。
特にブラウザから直接APIを呼び出す場合、HTMLソースからAPIキーの読み取りが可能な状態となるため、第三者に漏洩するリスクがあります。
中間サーバー（プロキシサーバー）等を立てることによりAPIキーの露出を防ぎ、セキュリティを確保することを推奨します。

推奨システム構成

Recommended System Architecture

Sample Code

簡単な実装例を紹介します。

Python lbsapi_sample.py 
import requests
import json

url = "https://piomatixlbs.prd.pioneerapis.com/lbsapi/navicore/calcRoute"

headers = {
    "Content-Type": "application/json",
    "Authorization": "Your Authorization",
    "PEC-Traffic-ProviderKey": "Your PEC-Traffic-ProviderKey",
    "PEC-Traffic-ProviderUserID": "Your PEC-Traffic-ProviderUserID"
}

data = {
    "userID": "sample",
    "pointinfo": {
        "start": {
            "latitude": 35.9078038201525,
            "longitude": 139.4832576402253
        },
        "destination": {
            "latitude": 35.93241737968212,
            "longitude": 139.47167252901303
        }
    }
}

response = requests.post(url, headers = headers, data = json.dumps(data))

print(response.status_code)
print(response.json())

Definitions

API仕様に関する共通の定義および注意事項について列挙します。

  • 緯度・経度の形式
    世界測地系(WGS84)を採用しています。
    入出力パラメータはDEG形式です。

  • 文字列
    UTF-8を採用しています。

  • 日付時刻の形式
    ”時(hour)”の有効範囲は0～23になります。

  • ジャンルキー
    ジャンル分類は大ジャンル、中ジャンル、小ジャンル、詳細ジャンルの４種類です。
    各ジャンル情報は固有のジャンルキーを持っています(リンク)。

    ジャンル分類 ジャンルキーの桁数
    大ジャンル 1
    中ジャンル 3
    小ジャンル 5
    詳細ジャンル 6

    大ジャンルには以下のカテゴリーがあります。
    　・ 生活
    　・ 車・交通
    　・ 娯楽
    　・ 買い物
    　・ 食事
    　・ 宿泊

  • エリアキー
    エリア情報には階層構造があり、都道府県、市区町村の2階層から成り立っています。
    エリアキーは都道府県コード、または市区町村コード(都道府県コードを含む）のみ有効です（リンク）。

    エリア分類 エリアキー表記※ エリアキーの桁数
    都道府県 xx 2
    市区町村 xxyyy 5

    ※xx:都道府県を表す2桁の番号、yyy:市区町村を表す3桁の番号を示す

Api rate limits

制限は、認証キー（Authorization）毎に、API毎の1秒あたりのリクエスト数に対して適用されます。
制限については下記の説明をご確認ください。
こちらを超えての使用をご希望の場合は、営業窓口までお問い合わせください。

API リクエスト数制限
ルート探索 2[req/sec]
EVルート探索 2[req/sec]
到達可能範囲 2[req/sec]
タイムスタンプ 2[req/sec]
巡回最適化 4[req/min]（15sec毎に1req）
大規模巡回最適化 12[req/hour]（5min毎に1req）
大規模巡回最適化の結果取得 4[req/min]（15sec毎に1req）
ルートマトリクス 4[req/min]（15sec毎に1req）
スポット検索 2[req/sec]
住所検索 2[req/sec]
逆ジオコーディング 2[req/sec]
充電スポット検索 2[req/sec]
CO2排出量算出 20[req/min]（3sec毎に1req）

Authentication

ApiKeyAuth

認証キー
本WebAPIを利用する場合は提供されたAPIキー(文字列)を以下のHTTPヘッダに含めてリクエストする必要があります。

Security Scheme Type: API Key
Header parameter name: Authorization

PECTrafficProviderKey

交通情報プロバイダー向け認証キー
本WebAPIを利用する場合は提供された交通情報プロバイダー向け認証キー(文字列)を以下のHTTPヘッダに含めてリクエストする必要があります。
※VICS交通情報を利用する場合の具体的なキー(文字列)については営業窓口までお問い合わせください。
※VICS交通情報を利用しない場合でも、プローブ情報は利用可能です。
※また、契約状況により利用可能な情報は以下の表のように異なります。

契約状況 プローブ交通情報 VICS交通情報
プローブ交通情報利用（"none"を指定） ✓ -
VICS交通情報利用（認証キー） ✓ ✓

※VICS交通情報を利用するご契約の場合、全てのAPIで提供された認証キーをご使用ください。

Security Scheme Type: API Key
Header parameter name: PEC-Traffic-ProviderKey

PECTrafficProviderUserID

交通情報プロバイダー向けユーザー情報
本WebAPIを利用する場合は提供された交通情報プロバイダー向けユーザー情報(文字列)を以下のHTTPヘッダに含めてリクエストする必要があります。
※VICS交通情報を利用する場合は、VICS交通情報を利用するユーザーごとに異なる任意の文字列を入力してください。
※交通情報を利用しない場合でも、入力必須になります。その場合、「"none"」を入力してください。

Security Scheme Type: API Key
Header parameter name: PEC-Traffic-ProviderUserID

Routing API

ルート探索API

ルート探索

  • 指定された出発地から立寄地を経由して目的地へ至るルートを、リクエスト条件に基づいて探索し、その結果を返却します。
  • 探索条件が指定されない場合は、デフォルトの探索条件を適用します。
  • 立寄地は最大200地点まで指定可能です。但し、探索条件で探索基準が料金考慮に指定された場合の立寄地は最大5地点まで指定可能です。
  • 指定された探索条件はルート全区間に適用します（区間ごとに異なる探索条件は指定できません）。
  • 車両情報が指定された場合、車両規制を考慮したルート探索を行います。
  • ルート探索に使用する地図地域はリクエストに含まれる地点情報から自動的に判別します。
Authorizations:
(ApiKeyAuthPECTrafficProviderKeyPECTrafficProviderUserID)
Request Body schema: application/json
required
userID
required
string

ユーザID

required
object

出発地・立寄地・目的地

object

時刻指定

object

探索条件

object

車種情報

object

燃料/電力情報
エコ優先の探索を実施する場合、またはenergyPrice(推定燃料費/電力費)を算出する場合は指定が必要です
車種により指定が必要なパラメータが異なります
詳細は下表を参照してください

指定が必要なenergyInfoのパラメータと車種の関係

算出したい車種 ガソリン車
（軽貨物車）		 ガソリン車
（軽貨物車以外）		 ハイブリッド車
(ガソリンと電気)		 電気自動車
energyType 〇
（ガソリン）		 〇
（ガソリン）		 〇
（ガソリン・電気）		 〇
（電気）
width
height
weight		 〇 〇 〇 〇
displacement 〇
（0.66L以下）		 〇 〇 ✕
currentLoadCapacity
passengerNum		 〇 ✕ ✕ ✕

〇：指定必要、✕：指定不要
指定必要の場合、該当パラメータは全て指定してください

needRouteProfileInfo
boolean
Default: false

ルートプロフィール情報取得要否(true:取得する, false:取得しない)
true を指定した場合、レスポンスのrouteProfileInfoで下記情報等が返却されます（詳細はrouteProfileInfoを参照してください）

  1. サービスエリア情報・インターチェンジ情報・通過時間
  • サービスエリア情報:
    • 通過するサービスエリアの名称
  • インターチェンジ情報:
    • 乗り降りするICの名称（通過するIC名称は提供しない）
  • 通過時間:
    • IC, SA等の高速施設までの出発地からの所要時間
  1. 道路情報
  • 道路名称
  • 道路種別（高速道路, 有料道路, 国道, 一般道, フェリー）
  1. 施設情報 SA/PAで提供されているサービス情報
  2. 有料道路金額 料金区間ごとの料金
    （例：関越 -> 外環 -> 首都高であればそれぞれの区間ごとの料金）
needDrawData
boolean
Default: true

描画用情報取得要否(true:取得する, false:取得しない)
地図に描画するための点列情報が必要な場合はtrueを、レスポンスサイズを小さくしたい場合はfalseを指定してください

Responses

Request samples

Content type
application/json
{
  • "userID": "testUser",
  • "pointinfo": {
    },
  • "setTime": {
    },
  • "options": {
    },
  • "vehicleInfo": {
    },
  • "energyInfo": {
    },
  • "needRouteProfileInfo": true,
  • "needDrawData": true
}

Response samples

Content type
application/json
{
  • "userID": "testUser",
  • "errorCode": 0,
  • "errorSectionNo": 0,
  • "routeNo": 1,
  • "length": 1000,
  • "unit": "meter",
  • "ic": {
    },
  • "requireTime": 1000,
  • "etaInfo": [
    ],
  • "startTime": "2020-01-01T08:30+09:00",
  • "toll": 1200,
  • "unknownToll": false,
  • "energyConsumption": 0.1,
  • "energyPrice": 0.1,
  • "energySectionInfo": [
    ],
  • "CO2Emissions": 0.1,
  • "CO2SectionInfo": [
    ],
  • "options": {
    },
  • "unavoidableInfo": {
    },
  • "pathPointNum": 10,
  • "pathPointList": [
    ],
  • "pathPointInfo": {
    },
  • "routeProfileInfo": [
    ],
  • "unavoidableTurningPoints": [
    ],
  • "mapVersion": {
    }
}

EVルート探索

  • EV(電気自動車)専用です。充電を考慮したルートを探索します。
  • 指定された出発地から立寄地を経由して目的地へ至るルートを、リクエスト条件に基づいて探索し、その結果を返却します。
    • ルート途中で充電が必要になった場合は、立寄地として充電スポットを自動追加したルート探索を行います。
    • 自動追加される充電スポットは急速充電スポットのみが対象となり、充電時間は一律30分です。
    • 充電不足により目的地または立寄地へ到達できない場合は、各地点の到達不可情報として返却します。
  • 探索条件が指定されない場合は、デフォルトの探索条件を適用します。
  • 立寄地は最大50地点まで指定可能です。また、立寄地として自動追加される充電スポットは最大5地点です。
  • 指定された探索条件はルート全区間に適用します(区間ごとに異なる探索条件は指定できません)。
  • 車両情報が指定された場合、車両規制を考慮したルート探索を行います。
  • EVルート探索に使用する地図地域はリクエストに含まれる地点情報から自動的に判別します。
Authorizations:
(ApiKeyAuthPECTrafficProviderKeyPECTrafficProviderUserID)
Request Body schema: application/json
required
userID
required
string

ユーザID

required
object

出発地・立寄地・目的地

object

時刻指定

object

探索条件

object

車種情報

required
object

電力情報

needRouteProfileInfo
boolean
Default: false

ルートプロフィール情報取得要否(true:取得する, false:取得しない)
true を指定した場合、レスポンスのrouteProfileInfoで下記情報等が返却されます（詳細はrouteProfileInfoを参照してください）

  1. サービスエリア情報・インターチェンジ情報・通過時間
  • サービスエリア情報:
    • 通過するサービスエリアの名称
  • インターチェンジ情報:
    • 乗り降りするICの名称（通過するIC名称は提供しない）
  • 通過時間:
    • IC, SA等の高速施設までの出発地からの所要時間
  1. 道路情報
  • 道路名称
  • 道路種別（高速道路, 有料道路, 国道, 一般道, フェリー）
  1. 施設情報 SA/PAで提供されているサービス情報
  2. 有料道路金額 料金区間ごとの料金
    （例：関越 -> 外環 -> 首都高であればそれぞれの区間ごとの料金）
needDrawData
boolean
Default: true

描画用情報取得要否(true:取得する, false:取得しない)
地図に描画するための点列情報が必要な場合はtrueを、レスポンスサイズを小さくしたい場合はfalseを指定してください

Responses

Request samples

Content type
application/json
{
  • "userID": "testUser",
  • "pointinfo": {
    },
  • "setTime": {
    },
  • "options": {
    },
  • "vehicleInfo": {
    },
  • "energyInfo": {
    },
  • "needRouteProfileInfo": true,
  • "needDrawData": true
}

Response samples

Content type
application/json
{
  • "userID": "testUser",
  • "errorCode": 0,
  • "errorSectionNo": 0,
  • "routeNo": 1,
  • "length": 1000,
  • "unit": "meter",
  • "ic": {
    },
  • "requireTime": 1000,
  • "etaInfo": [
    ],
  • "pointinfo": {
    },
  • "startTime": "2020-01-01T08:30+09:00",
  • "toll": 1200,
  • "unknownToll": false,
  • "energyConsumption": 0.1,
  • "energyPrice": 0.1,
  • "energySectionInfo": [
    ],
  • "CO2Emissions": 0.1,
  • "CO2SectionInfo": [
    ],
  • "options": {
    },
  • "unavoidableInfo": {
    },
  • "pathPointNum": 10,
  • "pathPointList": [
    ],
  • "pathPointInfo": {
    },
  • "routeProfileInfo": [
    ],
  • "unavoidableTurningPoints": [
    ],
  • "mapVersion": {
    }
}

Cruising Area API

到達可能範囲API

到達可能範囲

  • 指定された緯度・経度と燃料/電力情報に基づき、到達可能なエリアを推定して、その範囲を構成する形状点列の緯度・経度を返却します。
    • 燃料種別はガソリン、または電気のいずれか一方を指定可能です。
    • 取得する到達可能範囲は残燃料または充電のパーセンテージを最大10個まで指定可能です。
  • 探索条件が指定されない場合は、デフォルトの探索条件を適用します。
  • 時間規制は考慮しません。
  • フェリー航路は使用しません。
  • 標準で渋滞考慮します（VICS契約状況により考慮する渋滞情報は異なります）。
    (「PECTrafficProviderKey」の項をご参照ください)
Authorizations:
(ApiKeyAuthPECTrafficProviderKeyPECTrafficProviderUserID)
Request Body schema: application/json
required
userID
required
string

ユーザID

required
object

出発地

setTime
string

指定出発時刻
ISO8601形式 (YYYY-MM-DDThh:mm±hh:mm)

object

探索条件

required
object

燃料/電力情報
車種により指定が必要なenergyInfo(燃料/電力情報)が異なります
詳細は下表を参照してください

指定が必要なenergyInfoのパラメータと車種の関係

算出したい車種 ガソリン車
（軽貨物車）		 ガソリン車
（軽貨物車以外）		 電気自動車
energyType 〇
（ガソリン）		 〇
（ガソリン）		 〇
（電気）
width
height
weight		 〇 〇 〇
displacement 〇
（0.66L以下）		 〇 ✕
currentLoadCapacity
passengerNum		 〇 ✕ ✕
battery
chargingRate		 ✕ ✕ 〇
gasoline
refuelingRate		 〇 〇 ✕

〇：指定必要、✕：指定不要
指定必要の場合、該当パラメータは全て指定してください

Responses

Request samples

Content type
application/json
{
  • "userID": "testUser",
  • "start": {
    },
  • "setTime": "2020-01-02T13:59+09:00",
  • "options": {
    },
  • "energyInfo": {
    }
}

Response samples

Content type
application/json
{
  • "userID": "testUser",
  • "errorCode": 0,
  • "createTime": "2020-01-02T13:59+09:00",
  • "range": {
    },
  • "cruisingArea": {
    },
  • "usedVehicleInfo": {
    },
  • "mapVersion": {
    }
}

Traffic Timestamp API

交通情報タイムスタンプAPI

タイムスタンプ取得

  • 他APIで交通情報を利用する場合は必須となるAPIです。
  • 指定された緯度・経度に基づいて、渋滞、規制、駐車場などの交通情報から最新のタイムスタンプを取得し、返却します。
  • 緯度・経度は、交通情報を利用するAPIで指定された出発地または目的地のものを指定してください。
  • 日本国内の緯度・経度以外を指定した場合、本APIは正常に動作しません。
Authorizations:
(ApiKeyAuthPECTrafficProviderKeyPECTrafficProviderUserID)
Request Body schema: application/json
required
userID
required
string

ユーザID

required
object

対象位置

Responses

Request samples

Content type
application/json
{
  • "userID": "testUser",
  • "position": {
    }
}

Response samples

Content type
application/json
{
  • "userID": "testUser",
  • "errorCode": 0,
  • "type": "",
  • "validity": true,
  • "timestamp": "23:35",
  • "timestampDetails": {
    }
}

Vehicle Routing API

巡回最適化API

巡回最適化

  • 指定された地点すべてを巡る最適な巡回順を返却します。
  • 各配送地点での配達時間指定や推定作業時間、ドライバーの休憩時間等が設定できます。
  • 探索条件が指定されない場合は、デフォルトの探索条件を適用します。
  • 出発地点として、配送拠点または配送拠点以外の開始地点のいずれか一方を指定できます。
  • 配送地点は最大25地点まで指定可能です。
    　※拡張が必要な場合は、営業窓口までお問い合わせください。
  • 指定された条件を満たさない配送地点が存在する場合、その地点を処理対象から除外し、スキップ地点のリストとして返却します。
Authorizations:
(ApiKeyAuthPECTrafficProviderKeyPECTrafficProviderUserID)
Request Body schema: application/json
required
required
object

配送拠点の位置情報
出発地点、かつ、終着地点として扱われます
※出発地点を別途、指定したい場合は、startLocation(開始地点(=現在位置))を設定してください

object

開始地点(=現在位置)
出発地点がdepot(配送拠点の位置情報)と異なる場合に指定します
※depotからの巡回順を算出したい場合は指定しないで下さい

required
Array of objects [ 1 .. 25 ] items

配送リスト
指定できる配送地点の上限は25地点です
※拡張が必要な場合は、営業窓口までお問い合わせください

deliveryStartTime
required
string

配送開始時刻 ISO8601形式 (YYYY-MM-DDThh:mm±hh:mm)

deliveryEndTime
required
string

配送終了時刻 ISO8601形式 (YYYY-MM-DDThh:mm±hh:mm)
depotに戻る時間も含めて、指定時刻までに配送が完了するか否かの判定に使用されます

object

探索条件

Array of objects

休憩時間
休憩時間の条件を指定します
※複数指定可

object

車両情報

object

燃料/電力情報
エコ優先の探索を実施する場合、またはenergyPrice(推定燃料費/電力費)を算出する場合は指定が必要です
車種により指定が必要なパラメータが異なります
詳細は下表を参照してください

指定が必要なenergyInfoのパラメータと車種の関係

算出したい車種 ガソリン車
（軽貨物車）		 ガソリン車
（軽貨物車以外）		 ハイブリッド車
(ガソリンと電気)		 電気自動車
energyType 〇
（ガソリン）		 〇
（ガソリン）		 〇
（ガソリン・電気）		 〇
（電気）
width
height
weight		 〇 〇 〇 〇
displacement 〇
（0.66L以下）		 〇 〇 ✕
currentLoadCapacity
passengerNum		 〇 ✕ ✕ ✕

〇：指定必要、✕：指定不要
指定必要の場合、該当パラメータは全て指定してください

needDrawData
boolean
Default: false

描画用情報取得要否(true:取得する, false:取得しない)
地図に描画するための点列情報が必要な場合はtrueを、レスポンスサイズを小さくしたい場合はfalseを指定してください

Responses

Request samples

Content type
application/json
{
  • "depot": {
    },
  • "startLocation": {
    },
  • "locations": [
    ],
  • "deliveryStartTime": "2020-01-01T08:30+09:00",
  • "deliveryEndTime": "2020-01-01T12:00+09:00",
  • "options": {
    },
  • "breakTime": [
    ],
  • "vehicleInfo": {
    },
  • "energyInfo": {
    },
  • "needDrawData": true
}

Response samples

Content type
application/json
{
  • "skipped": true,
  • "skippedLocation": [
    ],
  • "length": 8491,
  • "requireTime": 5630,
  • "breakTime": [
    ],
  • "vehicleRouting": [
    ],
  • "toll": 0,
  • "energyConsumption": 0.6162301898002625,
  • "energyPrice": 92.43453216552734,
  • "energySectionInfo": [
    ],
  • "CO2Emissions": 1.4296540403366087,
  • "CO2SectionInfo": [
    ],
  • "pathPointNum": 190,
  • "pathPointList": [
    ],
  • "pathPointInfo": {
    },
  • "etaInfo": [
    ]
}

大規模巡回最適化

  • 指定された地点すべてを巡る最適な巡回順の計算リクエストを送り、そのリクエストに対応するユニークなタスクIDを返却します。
  • タスクIDはリクエストに対する計算結果取得の際に使用します。計算結果の保存期間は24時間です。計算時間は最長で約400秒（6分40秒）です。
  • 各配送地点での配達時間指定や推定作業時間、ドライバーの休憩時間等が設定できます。
  • 探索条件が指定されない場合は、デフォルトの探索条件を適用します。
  • 出発地点として、配送拠点または配送拠点以外の開始地点のいずれか一方を指定できます。
  • 配送地点は最大200地点まで指定可能です。

504 Gateway timeoutが発生する場合は営業窓口までお問い合わせ下さい。

Authorizations:
(ApiKeyAuthPECTrafficProviderKeyPECTrafficProviderUserID)
Request Body schema: application/json
required
required
object

配送拠点の位置情報
出発地点、かつ、終着地点として扱われます
※出発地点を別途、指定したい場合は、startLocation(開始地点(=現在位置))を設定してください。

object

開始地点(=現在位置)
出発地点がdepot(配送拠点の位置情報)と異なる場合に指定します
※depotからの巡回順を算出したい場合は指定しないで下さい

required
Array of objects [ 1 .. 200 ] items

配送リスト
指定できる配送地点の上限は200地点です

deliveryStartTime
required
string

配送開始時刻 ISO8601形式 (YYYY-MM-DDThh:mm±hh:mm)

deliveryEndTime
required
string

配送終了時刻 ISO8601形式 (YYYY-MM-DDThh:mm±hh:mm)
depotに戻る時間も含めて、指定時刻までに配送が完了するか否かの判定に使用されます

object

探索条件

Array of objects

休憩時間
休憩時間の条件を指定します
※複数指定可

object

車両情報

object

燃料/電力情報
エコ優先の探索を実施する場合、またはenergyPrice(推定燃料費/電力費)を算出する場合は指定が必要です
車種により指定が必要なパラメータが異なります
詳細は下表を参照してください

指定が必要なenergyInfoのパラメータと車種の関係

算出したい車種 ガソリン車
（軽貨物車）		 ガソリン車
（軽貨物車以外）		 ハイブリッド車
(ガソリンと電気)		 電気自動車
energyType 〇
（ガソリン）		 〇
（ガソリン）		 〇
（ガソリン・電気）		 〇
（電気）
width
height
weight		 〇 〇 〇 〇
displacement 〇
（0.66L以下）		 〇 〇 ✕
currentLoadCapacity
passengerNum		 〇 ✕ ✕ ✕

〇：指定必要、✕：指定不要
指定必要の場合、該当パラメータは全て指定してください

needDrawData
boolean
Default: false

描画用情報取得要否(true:取得する, false:取得しない)
地図に描画するための点列情報が必要な場合はtrueを、レスポンスサイズを小さくしたい場合はfalseを指定してください

Responses

Request samples

Content type
application/json
{
  • "depot": {
    },
  • "startLocation": {
    },
  • "locations": [
    ],
  • "deliveryStartTime": "2020-01-01T08:30+09:00",
  • "deliveryEndTime": "2020-01-01T12:00+09:00",
  • "options": {
    },
  • "breakTime": [
    ],
  • "vehicleInfo": {
    },
  • "energyInfo": {
    },
  • "needDrawData": true
}

Response samples

Content type
application/json
{
  • "taskId": "a12c048a-85ea-4dbc-8df3-921395e8fd0e"
}

大規模巡回最適化の結果取得

巡回順計算リクエストのタスクIDに対応する計算結果を取得します。
200OK(RUNNING)が返ってきた場合、計算結果を取得する為に約1分経過以降に再度呼出しすることを推奨します。

Authorizations:
(ApiKeyAuthPECTrafficProviderKeyPECTrafficProviderUserID)
Request Body schema: application/json
required
taskId
required
string

巡回順計算リクエストに対応するタスクID

Responses

Request samples

Content type
application/json
{
  • "taskId": "a12c048a-85ea-4dbc-8df3-921395e8fd0e"
}

Response samples

Content type
application/json
{
  • "matchTaskId": true,
  • "taskId": "a12c048a-85ea-4dbc-8df3-921395e8fd0e",
  • "calcState": "FINISHED",
  • "result": {
    }
}

Route Matrix API

ルートマトリクスAPI

ルートマトリクス

各地点間のルーティングマトリクスを計算します。

Authorizations:
(ApiKeyAuthPECTrafficProviderKeyPECTrafficProviderUserID)
Request Body schema: application/json
required
required
Array of objects [ 1 .. 625 ] items

出発地点のリスト
最大地点数:625（※ただし、startPointsとdestinationPointsの数の積が625以下であること）

startPointsの数 destinationPointsの数 積 可否
25 25 625 可能
30 30 900 不可能
1 625 625 可能
required
Array of objects [ 1 .. 625 ] items

目的地点のリスト
最大地点数:625（※ただし、startPointsとdestinationPointsの数の積が625以下であること）

object

探索条件

object

車両情報

departureTime
string

出発時刻 ISO8601形式 (YYYY-MM-DDThh:mm±hh:mm)

  • 時刻を指定した場合はその時刻を出発時刻としてルート探索されます。
  • 時刻を指定しない場合は現在時刻を出発時刻としてルート探索されます。

Responses

Request samples

Content type
application/json
{
  • "startPoints": [
    ],
  • "destinationPoints": [
    ],
  • "options": {
    },
  • "vehicleInfo": {
    },
  • "departureTime": "2020-01-01T08:30+09:00"
}

Response samples

Content type
application/json
{
  • "matrix": [
    ]
}

Freeword Search API

スポット検索API

スポット検索

入力されたキーワードに一致する施設を検索します。
キーワード or ジャンルキーのどちらかは必須です。

条件が複数指定された場合はAND検索となります。
例) 埼玉県川越市のセブンイレブンを検索する場合
　ジャンルキー：[セブンイレブンのジャンルキー]
　エリアキー　：[埼玉県川越市のエリアキー]
例) 埼玉県川越市のパイオニアを検索する場合
　キーワード　：パイオニア
　エリアキー　：[埼玉県川越市のエリアキー]

Authorizations:
(ApiKeyAuthPECTrafficProviderKeyPECTrafficProviderUserID)
Request Body schema: application/json
required
resource
Array of strings

z_poi 固定

keyword
string

検索条件
検索キーワードを指定します
半角スペース区切りでAND検索が可能です
ジャンルキーかキーワードのどちらかは必須となります

latitude
required
number <double> [ -90 .. 90 ]

緯度 WGS84,DEG形式

longitude
required
number <double> [ -180 .. 180 ]

経度 WGS84,DEG形式

genreKey
Array of integers

検索条件
ジャンルキー（リンク先参照）を指定します
ジャンルキーを複数指定した場合はOR検索を行います
キーワードとはAND検索を行います
ジャンルキーかキーワードのどちらかは必須となります

areaKey
Array of strings

検索条件
エリアキー（リンク先参照）を指定する
エリアキーを複数指定した場合はOR検索
他検索条件とはAND検索を行う
都道府県コード(2桁),都道府県コード＋市区町村コード(5桁)のみ有効です

radius
integer [ 1 .. 3000000 ]

検索条件
検索半径を指定する(単位：メートル)
指定された緯度経度から指定された半径内の施設を検索します
最大3,000,000m

sortType
integer

ソート種別
1:おすすめ順 2:距離順
距離順を指定する場合は検索半径の指定は必須

num
integer [ 1 .. 999 ]
Default: 30

データ出力の最大件数
最大値以上の値を指定した場合は最大値として処理されます

Responses

Request samples

Content type
application/json
Example
{
  • "resource": [
    ],
  • "keyword": "アトレヴィ",
  • "latitude": 35.729879,
  • "longitude": 139.747226,
  • "areaKey": [
    ],
  • "radius": 20000,
  • "sortType": 2,
  • "num": 2
}

Response samples

Content type
application/json
Example
{
  • "resultNum": 2,
  • "placeList": [
    ]
}

Geocoding API

住所検索API

住所検索

指定された住所を検索して、指定住所に所属する住所リストを返却します。

Authorizations:
(ApiKeyAuthPECTrafficProviderKeyPECTrafficProviderUserID)
Request Body schema: application/json
required
keyword
required
string

検索条件
都道府県名から始まる住所を指定します
入力された住所が見つからない場合は一つ上の住所階層で検索し結果を返します
住所階層はレスポンスの"level"で確認できます

Responses

Request samples

Content type
application/json
{
  • "keyword": "東京都文京区本駒込2-28-8"
}

Response samples

Content type
application/json
{
  • "resultNum": 1,
  • "placeList": [
    ]
}

Reverse Geocoding API

逆ジオコーディングAPI

逆ジオコーディング

指定された緯度経度周辺のPOIと一番近い住所を返却します。
POIも住所も見つからない場合はresultをfalseで返却します。
検索範囲は指定された緯度経度の周辺1km範囲を検索し住所の代表地点までの直線距離が一番近い住所を返却します。

Authorizations:
(ApiKeyAuthPECTrafficProviderKeyPECTrafficProviderUserID)
Request Body schema: application/json
required
latitude
required
number <double> [ -90 .. 90 ]

緯度 WGS84,DEG形式

longitude
required
number <double> [ -180 .. 180 ]

経度 WGS84,DEG形式

num
integer
Default: 1

取得するplaceListの最大数を指定します

Responses

Request samples

Content type
application/json
{
  • "latitude": 35.7298788,
  • "longitude": 139.7472259
}

Response samples

Content type
application/json
{
  • "result": true,
  • "nearestAddress": {
    },
  • "placeList": [
    ]
}

EV Charging Station Search API

充電スポット検索API

充電スポット検索

充電スポットを検索します。
複数の検索条件を指定し、条件に該当する充電スポットを返却します。各条件項目はANDとします。
指定した条件の順に並べ替えて返却します。

Authorizations:
(ApiKeyAuthPECTrafficProviderKeyPECTrafficProviderUserID)
Request Body schema: application/json
required
keyword
string

検索条件
検索キーワードを指定します
検索可能な項目は以下となります

  • 施設名称
  • 施設ジャンル
  • 住所
latitude
required
number <double> [ -90 .. 90 ]

検索の基準となる緯度
WGS84,DEG形式

longitude
required
number <double> [ -180 .. 180 ]

検索の基準となる経度
WGS84,DEG形式

genreKey
Array of integers

検索条件
ジャンルキー（リンク先参照）を指定します
ジャンルキーを複数指定した場合はOR検索を行います
他検索条件とはAND検索を行います

areaKey
Array of strings

検索条件
エリアキー（リンク先参照）を指定します
エリアキーを複数指定した場合はOR検索を行います
他検索条件とはAND検索を行います
都道府県コード(2桁),都道府県コード＋市区町村コード(5桁)のみ有効です

rangeType
integer

検索条件
検索範囲の形状を指定します
1:周辺(円形) 2:ポリゴン 3:ルート沿い defaultは1
1:周辺(円形) を選択した場合は、latitude,longitudeは必須
2:ポリゴン を選択した場合は、polygonのouterRingは必須
3:ルート沿い を選択した場合は、pathPointListは必須

radius
integer [ 1 .. 100000 ]

検索条件
rangeTypeが1(円形)の場合のみ有効
検索半径を指定する(単位：メートル)
指定された緯度経度から指定された半径内の施設を検索します
最大100,000m

Array of objects

検索条件
rangeTypeが3(ルート沿い)の場合にのみ有効です。 ルートを構成する形状点列を指定します
指定された形状点からpathWidthで指定された範囲内を検索します

pathWidth
integer
Default: 200

ルートに対して左右それぞれ何メートルまで検索範囲とするかを指定します
単位：メートル
最大500m (defaultは200m)

object

ポリゴンデータ
rangeTypeが2(ポリゴン)の場合のみ有効です

WKT（Well-known text）フォーマットでポリゴンを表現します
WKTの詳細はリンク(Wikipedia記事)を参照 。以下の点に注意してください
・outerRingの点列は反時計回りで格納する
・innerRingListの点列は時計回りで格納する
・点列の始点と終点は同じ座標に設定する

通常のポリゴンで検索する場合はouterRingのみポリゴンデータを格納します
穴あきポリゴンで検索する場合はouterRingに加えて穴部分相当のinnerRingListにもポリゴンデータを格納します
上記の記載方法に則っていない場合は検索結果は保証しません

object

拡張機能。充電スポット検索に関する条件を指定します

num
integer [ 1 .. 999 ]
Default: 30

データ出力の最大件数
最大値以上の値を指定した場合は最大値として処理されます

Responses

Request samples

Content type
application/json
Example
{
  • "latitude": 35.7298788,
  • "longitude": 139.7472259,
  • "genreKey": [
    ],
  • "rangeType": 1,
  • "radius": 15000,
  • "num": 1
}

Response samples

Content type
application/json
Example
{
  • "resultNum": 1,
  • "placeList": [
    ]
}

CO2 Emissions API

CO2排出量算出API

License: 国土地理院数値標高モデルデータ使用

CO2排出量算出

パラメータで指定される車種で入力軌跡を走行した場合のCO2排出量推定値と燃料または電力消費量推定値を計算して返却します。

Authorizations:
(ApiKeyAuthPECTrafficProviderKeyPECTrafficProviderUserID)
Request Body schema: application/json
required
filetype
required
string

csv.gzのみ対応

engine_type
required
number <int32>
Default: 6

Engine type
1:Gasoline
2:Diesel
4:HV
5:PHEV
6:EV
ディーゼルはトラック(積載量2-10tクラス)のみ対応。EVは普通車以外に軽貨物クラスにも対応。

co2gas
number <float>
Default: 2.322

co2 Emissions per gasoline(petrol). kg-CO2/kl

co2die
number <float>
Default: 2.6391

co2 Emissions per diesel. kg-CO2/kl

co2eb
number <float>
Default: 0.000447

基礎排出係数 t-CO2/kWh

co2ea
number <float>
Default: 0.000447

調整後排出係数 t-CO2/kWh

ac
boolean
Default: true

true:エアコン使用
false:エアコン不使用

idlstop
boolean
Default: true

アイドリングストップの有無
True：アイドリングストップあり
False：アイドリングストップなし
EVの場合には不要です。

displacement
number <float> [ 0 .. 30 ]
Default: 1.797

排気量[L]
EVの場合には不要です。

width
required
number <int32> [ 20 .. 300 ]
Default: 175

車幅[cm]

height
required
number <int32> [ 20 .. 400 ]
Default: 145

車高[cm]

weight
required
number <int32> [ 100 .. 20000 ]
Default: 1300

車両重量[kg]

maxLoadCapacity
number <int32> [ 0 .. 20000 ]

最大積載量[kg]
貨物車の場合挿入

currentLoadCapacity
number <int32> [ 0 .. 20000 ]

積載量[kg]
貨物車の場合挿入

wltc
number <float> [ 0 .. 99999 ]

wltc燃費
EVの場合[Wh/km]
ICEの場合[km/L]
本項目を入力することにより、計算の補正を行うことができる。補正を行わない場合は入力不要である。
ただし、engine_typeを5:PHEVとしたときは本項目の代わりにphev_wltc_evとphev_wltc_gasolineを入力する(EV走行とガソリン走行を別々に計算するため)。
ディーゼルトラックでは対象外。

ambient_temperature
number <float> [ -50 .. 50 ]

外気温補正を行う場合に挿入[℃]

passengerNum
number <int32> [ 1 .. 100 ]

ドライバーを含めた乗員人数[人]

ac_temperature_setting
number <float> [ 10 .. 40 ]

エアコン設定温度[℃]
EVのみ適応

equivalent_ev_range
number <float> [ 0 .. 99999 ]
Default: 66

等価EVレンジ[km]
engine_typeを5:PHEVとしたときに有効。

phev_wltc_ev
number <float> [ 0 .. 99999 ]

PHEVのWLTCモード燃費(EV走行) [Wh/km]
engine_typeを5:PHEVとしたとき、wltcを用いた補正を行う場合に挿入する。補正を行わない場合は入力不要である。

phev_wltc_gasoline
number <float> [ 0 .. 99999 ]

PHEVのWLTCモード燃費(ガソリン走行) [km/L]
engine_typeを5:PHEVとしたとき、wltcを用いた補正を行う場合に挿入する。補正を行わない場合は入力不要である。

trajectory
required
string

csv形式データをgzip圧縮しbase64エンコードしたデータ
走行軌跡はcsv形式{年月日,時刻(UTC),緯度,経度}。走行軌跡は時系列順になっています。
軌跡周期は0.1-1.0Hz(周期が長いほど低精度)。最低6レコード必要です。上限は4時間です。

csvサンプル

  • 文字コード：UTF-8
  • 区切り文字：カンマ(,)
  • 改行コード：LF

2022-11-08,01:13:30.728,35.93758372,139.42243257
2022-11-08,01:13:31.728,35.93759137,139.42246023
2022-11-08,01:13:32.728,35.93760771,139.42248248
2022-11-08,01:13:33.728,35.93761126,139.42249369
2022-11-08,01:13:34.728,35.93761269,139.422499
2022-11-08,01:13:35.728,35.93762086,139.42251738
2022-11-08,01:13:36.728,35.93764744,139.4225492
2022-11-08,01:13:37.728,35.93766728,139.42257683
2022-11-08,01:13:38.728,35.93768285,139.42260543
2022-11-08,01:13:39.728,35.93770009,139.42263273

Responses

Request samples

Content type
application/json
{
  • "filetype": "csv.gz",
  • "engine_type": 6,
  • "co2gas": 2.322,
  • "co2die": 2.6391,
  • "co2eb": 0.000447,
  • "co2ea": 0.000447,
  • "ac": true,
  • "idlstop": true,
  • "displacement": 1.797,
  • "width": 175,
  • "height": 145,
  • "weight": 1300,
  • "maxLoadCapacity": 100,
  • "currentLoadCapacity": 100,
  • "wltc": 20,
  • "ambient_temperature": 20,
  • "passengerNum": 2,
  • "ac_temperature_setting": 25,
  • "equivalent_ev_range": 66,
  • "phev_wltc_ev": 130,
  • "phev_wltc_gasoline": 20,
  • "trajectory": "H4sICMTQzWkAA3RlbXAuY3N2AG3QOQ7DUAgE0D5SbmJbMOy+/8HsFP4hChIFxTyxgICdeafciE+WU+gI5CZ2lISlBDaWOhRQgcX7hT/BXRRLLOEEmQSacIrgJfKuSUgXzPAlSrwmoT8CXl8x5q3nQbkmGIeMO3kXGqpLaGEC0YF/+geE5/io7CKR9ggn01FUE0FE62wXxC0uhxtYEfEBAAA="
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "startDateUtc": "2022-11-08",
  • "startTimeUtc": "01:13:33.000",
  • "startLat": 35.9376086756,
  • "startLon": 139.42248552912002,
  • "endDateUtc": "2022-11-08",
  • "endTimeUtc": "01:13:39.000",
  • "endLat": 35.93768753928,
  • "endLon": 139.4226128556,
  • "travelDistance": 17.099,
  • "stopCount": 0,
  • "result": [
    ]
}

API Guides

FAQ

クイックスタート・導入

実装・Tips

エラー・トラブルシューティング

仕様の補足・制限



クイックスタート・導入

LBS APIで取得した結果を他社の地図サービス上に表示する際に注意点はありますか？

LBS APIで探索したルートを他社地図サービス上で表示する場合、緯度・経度の取り扱いや地図データの内容や更新タイミングが異なるため、以下の注意点があります。

  • 測地系や表記法の違いにより、変換が必要になる場合がある(LBS APIは世界測地系で表記は10進法です)。
  • 道路の整備状況の違いにより、地図上に道路がないのにルートが引かれたり、道路があるのにルートが引かれない場合がある。

【関連API】LBS API共通



ブラウザから直接、APIを利用することはできますか？

ブラウザアプリからの直接アクセスはセキュリティ上の問題があるため、商用利用時はバックエンドからのアクセスを強く推奨しています。
トライアル利用に限りアクセスを許可していますが、その場合、ローカル環境からテストする際は、http://localhost:8080またはhttps://localhost:8080をご利用ください。
その他のドメインを利用する際は、当社側でホワイトリストに登録する必要があるため、ドメインをお知らせください。

【関連API】LBS API共通



APIリクエストの結果がエラーでも課金対象のリクエスト数にカウントされますか？

課金対象となるレスポンスは「200：正常」のみで、エラーの場合は課金対象になりません。

【関連API】LBS API共通



LBS APIはリファラ設定によるアクセスが可能ですか？

未対応です。リファラ設定(referer認証)によるアクセスには対応していません。

【関連API】LBS API共通



APIの仕様変更の際、事前に通知されますか？

利用規約上では当社判断基準としているため明確な日数は定めていません。おおよその目安としては以下のとおりで、仕様変更の判断をした時点で開示します。

  • メンテナンス等でのサーバー停止：5日前
  • 大規模な修正がある場合：1か月～6か月程度前
  • 軽微かつ緊急性のあるもの：数日から数週間程度前

【関連API】LBS API共通



VICSオプション利用時のMAU(月間アクティブユーザー)の考え方を教えてください。

原則として当月内にVICSオプションを利用するユーザーの総数がMAUになります。ご利用には日本道路交通情報センター(JARTIC)の許諾が必要なため、ご相談ください。

【関連API】LBS API共通



冬季などに一定期間通行規制がかかる道路で、その通行規制を考慮したい場合、VICSオプションは必要ですか？

不要です。冬季通行止めのような一定期間の通行規制の考慮にVICSオプションは不要で、地図データの収録状況により考慮可能です。なお、天候や事故など突発的な通行止めを考慮する場合は、VICSオプションが必要です。

【関連API】LBS API共通



大規模巡回最適化の結果取得APIは課金対象外ですか？

大規模巡回最適化の結果取得APIは、課金対象外です。大規模巡回最適化 + 大規模巡回最適化の結果取得はセットで利用されますが、課金対象は「大規模巡回最適化」のリクエストのみです。

【関連API】巡回最適化、大規模巡回最適化



実装・Tips

vehicleInfo(車種情報)のtype(車種)パラメーターでは何が考慮されますか？

車種情報の車種パラメーターにより交通規制(車種規制)が考慮されます。また、旋回難易度考慮で料金区分が未設定の場合に使用します。

【関連API】ルート探索、EVルート探索、巡回最適化、大規模巡回最適化、ルートマトリクス



通行料金が出力できる有料道路の一覧を提供できますか？

担当営業までお問い合わせください。

【関連API】ルート探索



特定の訪問先を必ず通る(スキップされない)指定はできますか？

できません。

【関連API】巡回最適化、大規模巡回最適化



VICS交通情報を利用せず、プローブ交通情報のみを使用する場合、タイムスタンプの取得、表記は必要ですか？

プローブ交通情報のみを使用する場合も必要です。

【関連API】タイムスタンプ取得



タイムスタンプはどのように表示したら良いですか？

表示方法に指定はありません。
交通情報を提供する場合(渋滞情報、旅行時間情報、など)は、国家公安委員会が告示する 交通情報の提供に関する指針(*1)に従い、提供情報の作成または更新した日時(タイムスタンプ)を分かりやすく表示してください。
※交通情報を提供しない場合(交通情報タイムスタンプAPIのレスポンスパラメータValidityが"false")は、タイムスタンプの表示は不要です。

表示方法は下記情報を参考にしてください。

　参考として、弊社アプリケーション(COCCHi)での表示例を示します。

　　提供する交通情報の更新時刻を表示しています。
　　　V:オンデマンドVICS(*2)
　　　S:スマートループ(*3)

*1 特に関連する項番：第3章 情報の作成、第4章 情報の提供
*2 VICSの情報は公益財団法人日本道路交通情報センターから提供される道路交通情報データを利用して作成しています。また、道路交通情報データの作成には、一般財団法人道路交通情報通信システムセンターの技術が用いられています。
*3 スマートループは渋滞予測データと現在の道路状況・交通情報を分析し、ドライバーに最適な情報を提供するパイオニアの情報ネットワークサービスです。

【キーワード】タイムスタンプ取得



CO2排出量算出APIはディーゼル車に対応していますか？

ディーゼルトラック(中型・大型車)にのみ対応しています。

【関連API】CO2排出量算出



エラー・トラブルシューティング

APIでネットワーク(通信)が切れたとき、どのような動作になりますか？

リクエスト時、レスポンス時いずれの場合もステータスコードは返りません。ネットワーク復帰後に再リクエスト、データを再取得します。

【関連API】LBS API共通



APIリクエスト時、403「User is not authorized to access this resource with an explicit deny」エラーが出ました。どのような原因が考えられますか？

認証キーの記述が正しくない可能性があります。ヘッダー部Authorizationの「Signature」の直前は「,」(カンマ)ではなく、半角スペースとなっていることをご確認ください。

【関連API】LBS API共通



ルート探索APIの「エラー7：つながる道路がないため探索不可」の発生条件にはどのようなものがありますか？

以下のような場合に同エラーとなります。

  • フェリー航路のない離島など、出発地から目的地まで道路がつながっていない場合
  • 出発地および目的地の近傍には通行可能な道路が存在するものの、その間に規制が存在し、目的地までたどり着けない場合

【関連API】ルート探索、EVルート探索、ルートマトリクス



離島へのルート探索をした場合、探索条件のフェリー利用のON/OFFいずれでもルートが引けてしまうのはなぜですか？

離島への移動手段がカーフェリーに限られる場合は探索条件ON/OFFに関わらず、ルートは出力されます(その場合、フェリー回避不可がtrueで出力されます)。なお、フェリー航路があっても車両を載せられないものでは、ルートを引かずエラーを返します。

【関連API】ルート探索、EVルート探索、巡回最適化、大規模巡回最適化、ルートマトリクス



指定した緯度・経度から離れたスポットが抽出されてしまいました。どのようなアルゴリズムですか？

検索のアルゴリズムとして、指定したキーワードの文字列をキーに、下記1～3を検索し、かつ1～3のデータを複合したスポット情報を取得します。このため、必ずしも指定した緯度・経度近くのスポットだけが抽出されるものではありません。

  1. ジャンルから検索
  2. スポット名称から検索
  3. 住所情報から検索

【関連API】スポット検索



到達可能範囲APIのリクエストで、「request setTime is invalid」が返却されます。どのような原因が考えられますか？

時刻指定の記述に誤りがある可能性があります。例えば、時刻指定の記述が次の場合、同事象が発生します。
　誤）"setTime":"2024-10-02T13:59 09:00"
　正）"setTime":"2024-10-02T13:59+09:00"
「+」と記述すべきところ、「 」(スペース)で記述されているため、エラーが発生します。

【関連API】到達可能範囲



仕様の補足・制限

どの程度の国内道路をカバーしていますか？

約156万kmです(2025年秋時点)。ただし、本数値には道路法管理外の私道、農道等も含まれています。
　※一方で国土交通省統計の約122万kmという数値は上記が含まれていません。
　上記比較では約128%のカバー率となりますが、私道等含む実際に国内に存在する全ての道路に対するカバー率は算出できません。

【関連API】ルート探索



時間帯規制のある道路に進入するタイミングで規制は考慮されますか？

道路に進入するタイミングで時間帯規制は考慮できません。時間帯規制は出発時刻で考慮されます。

【関連API】ルート探索、EVルート探索、巡回最適化、大規模巡回最適化、ルートマトリクス



ルート探索の道幅考慮で、車幅に対してどのくらいクリアランスが必要ですか？

道路の最小幅員が車幅に対して、下記のクリアランスが必要です。

  • 一方通行の場合は50cm
  • 両方向通行可の場合は100cm

【関連API】ルート探索、EVルート探索



ルート探索の旋回難易度考慮において、vehicleInfo(車種情報)のratesClass(料金区分)を指定しない場合、vehicleInfoのtype(車種)はどのratesClassとして扱われますか？

typeごとに、適用されるratesClassは以下の通りです。
なお、意図した車両の種別を明確に反映するため、ratesClassを明示的に指定することを推奨します。

type(車種) ratesClass(料金区分)
普通乗用 普通車
普通貨物 普通車
大型乗用 特大車
大型貨物 大型車
大型特殊 特大車
中型乗用 中型車
中型貨物 中型車
特定中型乗用 大型車
特定中型貨物 大型車

【関連API】ルート探索、EVルート探索



ルート探索APIでスマートICの利用に際して考慮される規制条件はありますか？

スマートICに車種規制や時間規制が整備されている場合は、その規制に従って利用可否を決定します。ただし、車長規制については対応していません。

【関連API】ルート探索、EVルート探索



高速道路等の料金はETC割引に対応していますか？また、休日割引や深夜割引に対応していますか？

対応しています。ただし、ETCの深夜割引および休日割引は、適用時間内に入口ICおよび出口ICの両方を通過する場合に適用されます。また、ETCの休日割引は、交通混雑期や3連休などの適用除外日には対応していません。

【関連API】ルート探索、EVルート探索、巡回最適化、大規模巡回最適化



現金支払いのみの区間を含むルートの場合、etc(ETC接続)で1または2を指定した際の料金はどのように計算されますか？

現金支払いのみ対応の区間については、ETC接続を指定していても現金支払い時の料金で算出します。他の区間についてはETC利用時の料金で算出します。

【関連API】ルート探索、EVルート探索、巡回最適化、大規模巡回最適化



「推定電力費」は、どのように計算されますか？

推定電力費は (推定電力消費量) × (インプットされた電力単価) で計算します。

【関連API】EVルート探索



EVルート探索で自動追加される充電スポットは急速充電のみ30分固定ですが、各スポットの出力は加味されていますか？

自動追加される充電スポットは急速充電のみで充電時間は30分固定です。その際、充電スポットの充電器の出力を加味しています。自動追加する充電スポットで充電される電力は「その充電スポットに設置してある充電器の最大出力で30分充電した場合」で計算します。

【関連API】EVルート探索



仕様書に巡回最適化のRate Limitは15秒となっていますが、25地点までの最適化であれば必ず15秒以内に出力されますか？

概ね15秒以内で出力しますが、15秒以内を保証するものではありません。

【関連API】巡回最適化



仕様書に大規模巡回最適化の計算時間は最長400秒とありますが、200地点の大規模巡回最適化であっても必ず400秒以内に結果が出力されますか？

概ね400秒以内で結果を出力しますが、400秒以内を保証するものではありません。

【関連API】大規模巡回最適化



住所検索APIでは過去の旧住所に対応していますか？

対応していません。合併等により住所表記が新しくなった場合、地図データを更新するまでは旧住所が利用可能ですが、更新後は旧住所が使えません。

【関連API】住所検索



CO2排出量算出APIで考慮されているエアコン利用のロジックは、EVルート探索API、到達可能範囲APIへ反映されていますか？

現在のEVルート探索、到達可能APIにはエアコン予測ロジックが組み込まれており、計算結果に反映されています。
ただし、CO2排出量算出APIとはロジックが若干異なり、CO2排出量算出APIはエアコン設定温度の指定が可能になっていますが、EVルート探索APIおよび到達可能APIでは外気温予測ロジックを組み込みその値を使用しています。これらロジックの差異により、結果に大きな差が出るものではありません。

【関連API】EVルート探索、到達可能範囲、CO2排出量算出

改訂履歴

仕様書版数 改訂日 改訂対象 改訂内容
2.0.15 2026/6/30 巡回最適化 ・リクエストパラメータ nextToLocationsを削除
大規模巡回最適化 ・リクエストパラメータ nextToLocationsを削除
・APIのエンドポイントURLを変更
2.0.14 2026/6/1 仕様書構成 ・API GuidesにFAQを追加(Tipsの説明文はFAQに統合)
ルート探索 ・旋回難易度考慮に関するパラメータについて、対応予定の注記を削除
・リクエストパラメータ(string型)のデータサイズ上限追加、エラー情報の返却形式変更、ETCのデフォルト値変更について、対応予定の注記を削除
・APIのパラメータ説明文を一部修正
EVルート探索 ・旋回難易度考慮に関するパラメータについて、対応予定の注記を削除
・リクエストパラメータ(string型)のデータサイズ上限追加、エラー情報の返却形式変更、ETCのデフォルト値変更について、対応予定の注記を削除
・APIのパラメータ説明文を一部修正
到達可能範囲 ・リクエストパラメータ(string型)のデータサイズ上限追加、エラー情報の返却形式変更について、対応予定の注記を削除
タイムスタンプ取得 ・リクエストパラメータ(string型)のデータサイズ上限追加、エラー情報の返却形式変更について、対応予定の注記を削除
・APIの概要およびパラメータ説明文を一部修正
巡回最適化 ・レスポンスパラメータ tollに関する誤記を削除(海外における出力値)
・ETCのデフォルト値変更について、対応予定の注記を削除
・APIのパラメータ説明文を一部修正
大規模巡回最適化 ・ETCのデフォルト値変更について、対応予定の注記を削除
大規模巡回最適化の
結果取得		 ・レスポンスパラメータ tollに関する誤記を削除(海外における出力値)
・APIのパラメータ説明文を一部修正
2.0.13 2026/3/31 仕様書構成 ・巻末にAPI Guides(Tips、改訂履歴)とLegal Guideline(Licensing and Copyright)を追加
ルート探索 ・旋回難易度考慮に関するパラメータを追加
・出発地からの出発方向を指定するパラメータを追加
・レスポンスパラメータ routeProfileInfo.distance の存在条件に関する誤記を修正(立寄地に関する条件)
・APIの概要およびパラメータ説明文の表現を一部修正
EVルート探索 ・旋回難易度考慮に関するパラメータを追加
・出発地からの出発方向を指定するパラメータを追加
・リクエストパラメータ energyInfo.batteryLevelOnArrival の下限値を変更
・リクエストパラメータ energyInfo.batteryLevelOnArrival, energyInfo.batteryLevelAtSupply における10%刻みの制限を削除
・レスポンスパラメータ pointInfo.wayPoints, routeProfileInfo が自動追加された充電スポットの場合に、info に設定されるキーを追加
・レスポンスパラメータ routeProfileInfo.distance の存在条件に関する誤記を修正(立寄地に関する条件)
・APIの概要およびパラメータ説明文の表現を一部修正
到達可能範囲 ・APIの概要およびパラメータ説明文の表現を一部修正
巡回最適化 ・APIの概要およびパラメータ説明文の表現を一部修正
・サンプルコードを改訂
大規模巡回最適化 ・APIの概要およびパラメータ説明文の表現を一部修正
・サンプルコードを改訂
タイムスタンプ取得 ・パラメータ説明文の表現を一部修正
・タイムスタンプ表示に関する説明を追加(Tips)
スポット検索 ・サンプルコードを改訂
CO2排出量算出 ・リクエストパラメータ trajectory で指定される走行軌跡データについて、以下の変更を実施
　◦軌跡周期の制約を緩和し、0.1～1.0Hzのデータに対応できるように変更
　◦CSV形式に関する詳細仕様を追記
　◦CSVサンプルの誤記を修正(各行の末尾にあったカンマ(,)を削除)
・サンプルコードを改訂

地図データのライセンス

(1)地図データ及び配信データについての著作権表示
　©ZENRIN.Co, Ltd.

(2)国土地理院の許諾番号
　測量法に基づく国土地理院長承認(使用) R 5JHs 167－B3号
　測量法に基づく国土地理院長承認(使用) R 5JHs 171－B3号

本仕様書の著作権

パイオニア株式会社 © Pioneer Corporation. All Rights Reserved.
本仕様書の内容は、パイオニア株式会社の著作物であり、著作権法により保護されています。
本仕様書の全部または一部を、パイオニア株式会社の事前の書面による同意なしに複写、複製、送信又は改変その他当社又は当該第三者の著作権を侵害する行為等を行うことを禁じます。