Pioneer logo
API docs by Redocly

Piomatix LBS API 仕様書 (2.0.0)

Download OpenAPI specification:Download

(1)地図データ及び配信データについての著作権表示
©ZENRIN.Co, Ltd.
(2)国土地理院の許諾番号
測量法に基づく国土地理院長承認（使用) R 5JHs 167－B3号
測量法に基づく国土地理院長承認（使用) R 5JHs 171－B3号

本文書はPioneerサーバーが提供するWebAPIについて説明するものです。
本文書で定義するWebAPI仕様は OpenAPI format に従って記載しています。

パイオニア株式会社 © Pioneer Corporation. All Rights Reserved.

Introduction

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

Definitions

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

  • 緯度・経度は世界測地系(WGS84)になります。
  • 文字列はUTF-8を前提としています。
  • 時刻の定義では、"時(hour)"の有効範囲は[0,23]になります。

Authentication

ApiKeyAuth

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

Security Scheme Type: API Key
Header parameter name: Authorization

PECTrafficProviderKey

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

契約状況 プローブ交通情報 VICS交通情報
プローブ交通情報利用（"none"を指定） ✓ -
VICS交通情報利用（認証キー） ✓ ✓
Security Scheme Type: API Key
Header parameter name: PEC-Traffic-ProviderKey

PECTrafficProviderUserID

交通情報プロバイダー向けユーザー情報
本WebAPIを利用する場合は提供された交通情報プロバイダー向けユーザー情報(文字列)を以下のHTTPヘッダに含めてリクエストする必要があります。
※VICS交通情報を利用する場合は、VICS交通情報を利用するユーザーごとに異なる任意の文字列を入力してください。(VICS交通情報利用者数が把握できれば各APIのuserIDと同じ文字列にしていただいても構いません。)
※交通情報を利用しない場合でも、入力必須になります。その場合、「"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

燃料/電力情報
エコ優先の探索を実施する場合および推定燃料費/電力費を算出する場合は指定必要
指定必要な燃料/電力情報は燃料種別によって異なり下表の通り

燃料費推定種別 必須 任意
ガソリン(貨物車) 燃料種別, 車幅, 車高, 車重, 排気量, 現在の積載容量, ドライバーを含めた乗員人数 アイドリングストップのON/OFF
ガソリン(貨物車除く) 燃料種別, 車幅, 車高, 車重, 排気量 アイドリングストップのON/OFF
ガソリン・電気 燃料種別, 車幅, 車高, 車重, 排気量 アイドリングストップのON/OFF
電気 燃料種別, 車幅, 車高, 車重 アイドリングストップのON/OFF

ガソリン（貨物車）は排気量0.66L未満、かつ、現在の積載容量とドライバーを含めた乗員人数の指定がある場合。

needDrawData
boolean
Default: true

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

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "userID": "testUser",
  • "errorCode": 0,
  • "errorSectionNo": 0,
  • "routeNo": 1,
  • "routeKindId": 6,
  • "routeKind": "お勧めルート",
  • "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": [
    ],
  • "unavoidableInfo": {
    },
  • "pathPointNum": 10,
  • "pathPointList": [
    ],
  • "pathPointInfo": {
    },
  • "mapVersion": {
    }
}

EVルート探索

  • 本APIはEV専用です。
  • 指定したユーザの、指定した出発地から立寄地を経由し目的地までのルートを指定した条件で探索し、ルートの形状点列の緯度経度を取得します
    • ルート途中で充電が必要になった場合立寄地として充電スポットを自動追加したルート探索を行います。
    • 自動追加される充電スポットは急速充電スポットのみ対象となります。
      • 急速充電スポットでの充電時間は30分固定です。
    • 充電不足による到達可否情報は、目的地や立寄地等の各地点情報に到達不可情報として提供します。
  • 指定しない探索条件はデフォルト設定です。
  • 立寄地は最大50地点まで指定可能です。また自動追加される立寄地としての充電スポットは最大5地点です。
  • 区間毎の探索条件は指定できない。指定した探索条件が全ての区間に反映されます。
  • 車両情報を指定した場合、車両に該当する時間規制を考慮したルート探索を行います。
Authorizations:
(ApiKeyAuthPECTrafficProviderKeyPECTrafficProviderUserID)
Request Body schema: application/json
required
userID
required
string

ユーザID

required
object

出発地・立寄地・目的地

object

時刻指定

object

探索条件

object

車種情報

required
object

電力情報
指定必要な電力情報は下表の通り

必須 任意
車幅, 車高, 車重, 電池総電力量, 電池残存電力量
needDrawData
boolean
Default: true

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

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "userID": "testUser",
  • "errorCode": 0,
  • "errorSectionNo": 0,
  • "routeNo": 1,
  • "routeKindId": 6,
  • "routeKind": "お勧めルート",
  • "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": [
    ],
  • "unavoidableInfo": {
    },
  • "pathPointNum": 10,
  • "pathPointList": [
    ],
  • "pathPointInfo": {
    },
  • "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

燃料/電力情報
指定必要な燃料/電力情報は燃料種別によって異なり下表の通り

燃料費推定種別 必須 任意
ガソリン(貨物車) 燃料種別, 車幅, 車高, 車重, 排気量, 現在の積載容量, ドライバーを含めた乗員人数 アイドリングストップのON/OFF
ガソリン(貨物車除く) 燃料種別, 車幅, 車高, 車重, 排気量 アイドリングストップのON/OFF
電気 燃料種別, 車幅, 車高, 車重 アイドリングストップのON/OFF

ガソリン（貨物車）は排気量0.66L未満、かつ、現在の積載容量とドライバーを含めた乗員人数の指定がある場合。

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は正常に動作しません。

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": "VICS",
  • "validity": true,
  • "timestamp": "23:35",
  • "timestampDetails": {
    }
}

Vehicle Routing API

巡回最適化API

巡回最適化

指定された地点すべてを巡る最適な巡回順を返却します。
※2024年夏頃提供開始予定
※本APIは開発中のため、商用サービスインに際して仕様が変更される可能性があることをご了承願います。

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

配送拠点の位置情報

object

開始地点(=現在位置)
配送拠点(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)
※指定時刻までに配送完了するかどうかの判定に使用。
※配送拠点に戻ってくるまでの時間も含めて判定。

object

探索条件

Array of objects

休憩時間
指定された時間範囲で指定された時間分の休憩を取る ※複数指定可

object

車両情報

object

燃料/電力情報
エコ優先の探索を実施する場合および推定燃料費/電力費を算出する場合は指定必要
指定必要な燃料/電力情報は燃料種別によって異なり下表の通り

燃料費推定種別 必須 任意
ガソリン(貨物車) 燃料種別, 車幅, 車高, 車重, 排気量, 現在の積載容量, ドライバーを含めた乗員人数 アイドリングストップのON/OFF
ガソリン(貨物車除く) 燃料種別, 車幅, 車高, 車重, 排気量 アイドリングストップのON/OFF
ガソリン・電気 燃料種別, 車幅, 車高, 車重, 排気量 アイドリングストップのON/OFF
電気 燃料種別, 車幅, 車高, 車重 アイドリングストップのON/OFF

ガソリン（貨物車）は排気量0.66L未満、かつ、現在の積載容量とドライバーを含めた乗員人数の指定がある場合。

nextToLocations
Array of strings non-empty [ items >= 2 items ]

計算の結果、順番が隣り合ってほしい地点をリスト形式で指定します。 ※複数指定可
順番が隣り合ってほしい地点は'uniqueId'を使って指定します。
使用する'uniqueId'は'locations'の中で指定したものと同じものです。
リスト内の順番は考慮されず、リスト内で指定された地点が連続して隣り合うような順番を返却します。

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-01T17:30+09:00",
  • "options": {
    },
  • "breakTime": [
    ],
  • "vehicleInfo": {
    },
  • "energyInfo": {
    },
  • "nextToLocations": [
    ],
  • "needDrawData": false
}

Response samples

Content type
application/json
{
  • "skipped": false,
  • "skippedLocation": [
    ],
  • "length": 1000,
  • "requireTime": 1000,
  • "breakTime": [
    ],
  • "vehicleRouting": [
    ],
  • "toll": 1200,
  • "energyConsumption": 0.1,
  • "energyPrice": 0.1,
  • "energySectionInfo": [
    ],
  • "CO2Emissions": 0.1,
  • "CO2SectionInfo": [
    ],
  • "pathPointNum": 10,
  • "pathPointList": [
    ],
  • "pathPointInfo": {
    },
  • "etaInfo": [
    ]
}

大規模巡回最適化

指定された地点すべてを巡る最適な巡回順の計算リクエストを送り、そのリクエストに対応するユニークなタスクIDを返却します。
タスクIDはリクエストに対する計算結果取得の際に使用します。 計算結果の保存期間は24時間です。計算時間は最長で約400秒（6分40秒）となります。

※2024年夏頃提供開始予定
※本APIは開発中のため、商用サービスインに際して計算時間の目安や仕様が変更される可能性があることをご了承願います。

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

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

配送拠点の位置情報

object

開始地点(=現在位置)
配送拠点(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)
※指定時刻までに配送完了するかどうかの判定に使用。
※配送拠点に戻ってくるまでの時間も含めて判定。

object

探索条件

Array of objects

休憩時間
指定された時間範囲で指定された時間分の休憩を取る ※複数指定可

object

車両情報

object

燃料/電力情報
エコ優先の探索を実施する場合および推定燃料費/電力費を算出する場合は指定必要
指定必要な燃料/電力情報は燃料種別によって異なり下表の通り

燃料費推定種別 必須 任意
ガソリン(貨物車) 燃料種別, 車幅, 車高, 車重, 排気量, 現在の積載容量, ドライバーを含めた乗員人数 アイドリングストップのON/OFF
ガソリン(貨物車除く) 燃料種別, 車幅, 車高, 車重, 排気量 アイドリングストップのON/OFF
ガソリン・電気 燃料種別, 車幅, 車高, 車重, 排気量 アイドリングストップのON/OFF
電気 燃料種別, 車幅, 車高, 車重 アイドリングストップのON/OFF

ガソリン（貨物車）は排気量0.66L未満、かつ、現在の積載容量とドライバーを含めた乗員人数の指定がある場合。

nextToLocations
Array of strings non-empty [ items >= 2 items ]

計算の結果、順番が隣り合ってほしい地点をリスト形式で指定します。 ※複数指定可
順番が隣り合ってほしい地点は'uniqueId'を使って指定します。
使用する'uniqueId'は'locations'の中で指定したものと同じものです。
リスト内の順番は考慮されず、リスト内で指定された地点が連続して隣り合うような順番を返却します。

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-01T17:30+09:00",
  • "options": {
    },
  • "breakTime": [
    ],
  • "vehicleInfo": {
    },
  • "energyInfo": {
    },
  • "nextToLocations": [
    ],
  • "needDrawData": false
}

Response samples

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

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

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

※2024年夏頃提供開始予定
※本APIは開発中のため、商用サービスインに際して仕様が変更される可能性があることをご了承願います。

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

ルートマトリクス

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

※2024年夏頃提供開始予定
※本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 ]

緯度 WGS,DEG形式

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

経度 WGS,DEG形式

genreKey
Array of integers

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

areaKey
Array of strings

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

radius
interger [ 1 .. 3000000 ]

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

sortType
integer

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

num
integer [ 1 .. 999 ]
Default: 30

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

object

拡張機能。各種拡張機能の利用を指定します
指定が無い場合は各キー毎のデフォルト動作となります

Responses

Request samples

Content type
application/json
{
  • "resource": [
    ],
  • "keyword": "コンビニ",
  • "latitude": 35.730156,
  • "longitude": 139.748024,
  • "genreKey": [
    ],
  • "areaKey": [
    ],
  • "radius": 10000,
  • "sortType": 1,
  • "num": 30,
  • "extensions": {
    }
}

Response samples

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

Geocoding API

住所検索API

住所検索

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

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

z_address 固定

keyword
required
string

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

Responses

Request samples

Content type
application/json
{
  • "resource": "z_address",
  • "keyword": "埼玉県川越市元町1-3-1"
}

Response samples

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

EV Charging Station Search API

充電スポット検索API

充電スポット検索

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

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

z_ev 固定

keyword
string

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

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

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

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

検索の基準となる緯度経度
WGS,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
{
  • "resource": "z_ev",
  • "keyword": "string",
  • "latitude": 35.730156,
  • "longitude": 139.748024,
  • "genreKey": [
    ],
  • "areaKey": [
    ],
  • "rangeType": 1,
  • "radius": 15000,
  • "pathPointList": [
    ],
  • "pathWidth": 200,
  • "polygon": {
    },
  • "extensions": {
    },
  • "num": 30
}

Response samples

Content type
application/json
{
  • "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
4:HV
6:EV

co2gas
number <float>
Default: 2.322

co2 Emissions per fuel. 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
number <int32> [ 20 .. 300 ]
Default: 175

車幅[cm]

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

車高[cm]

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

車両重量[kg]

trajectory
required
string

csv形式データをgzip圧縮しbase64エンコードしたデータ
走行軌跡はcsv形式{年月日,時刻(UTC),緯度,経度}。走行軌跡は1秒に1レコードで時系列順になっています。
最低6レコード必要です。上限は4時間です。
csvサンプル
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,
  • "co2eb": 0.000447,
  • "co2ea": 0.000447,
  • "ac": true,
  • "idlstop": true,
  • "displacement": 1.797,
  • "width": 175,
  • "height": 145,
  • "weight": 1300,
  • "trajectory": "H4sIAAAAAAAAA3XUSY7CQAwF0H2fJSDPA/c/WBeLmN9qI2VBJJ7K9ndFSOTB/KC6iF+sL6VnSl3qz9b00pSLtZ8mYiqeF/3IP8JImjWHBImuRIAEZfKQOs9KFAmzxJDW6JXYHyLnX0N24AiEas5wTt3LCiSWZkOsZRWJIt6/b5FR+7gKSUn5TYLcdtJAkoim91DJlRhGn0L6IUF7L4bRn959coy23AlGn2fKtzgD3kdsmHx9Gsk87yvA3MuqZ8IlZHtVmHyVnwndJEljJZh8S/KE0tyxF4bRd1LPKf0leYPki85C3t0rSX+pq5HE2ckhZ9tW4pB8McUIPnd+zcQZhZtMXdwW64gdgj856HwmVMJoJ4rEcz5Gqsq1twLZlxLlfR/VqGq99e5IPKKGnPXcCWRfxjytuFXwKhJF6FwuDfk2Y8zeuWVaibNf+ymY/ZmXDsnIepNfgznPzfEFAAA="
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "startDateUtc": "2022-11-08",
  • "startTimeUtc": "01:13:35.000",
  • "startLat": 35.93761491224,
  • "startLon": 139.42250399935998,
  • "endDateUtc": "2022-11-08",
  • "endTimeUtc": "01:13:59.000",
  • "endLat": 35.9385350432,
  • "endLon": 139.4237160492,
  • "travelDistance": 0,
  • "stopCount": 3,
  • "result": [
    ]
}