経路マトリクスAPI (v1.1)

Download OpenAPI specification:Download

リクエストされた出発地および目的地の緯度経度地点(最大50点)に対し、自動車向け道路ネットワークとの経路マトリクスを行い、所要時間・距離のリストを返却します。

経路マトリクスAPI

リクエストされた出発地リスト・目的地リストに対して、以下を提供します。

  • 各出発地から各目的地までの経路のサマリー情報(所要時間および道のり距離)のリスト

以下のような利用用途を想定しています。

  • 各出発地から各目的地までの経路のサマリー情報(所要時間および道のり距離)の一括取得



本APIのご利用に際しては、以下をご留意ください。

  • 本APIで入力可能な緯度経度の範囲は、日本国内に限定されます。
  • 空路でのみアクセス可能、または、弊社データにてフェリー航路が未整備の一部離島(※)の地点がリクエストに含まれている場合、status_code=400 のリクエストエラーとなる場合があります。
    (※)八丈島(東京都)、青ヶ島(東京都)、宮古島(沖縄県)、石垣島(沖縄県)など
  • 出発地から目的地までの経路が見つからない場合、その出発地と目的地の組み合わせの distancetimenull となります。
  • 経路探索の対象車種(costing)が auto の場合は最大幅1.6 m 未満、truck の場合は最大幅2.6 m 未満の車幅制限がある道路は通行しません。
  • 経路形状および右左折案内情報は返却されません。
  • 本APIの応答タイムアウトは30秒です。経路距離や出発地・目的地の地点数によってはリクエストがタイムアウトする場合がございますので、その場合は地点数を減らすなどしてお試しください。
  • 本APIは秒間1リクエストのレート制限をかけています。また本APIを連続実行する場合は、前回リクエスト分のレスポンスが返却されてから次のリクエストを実行するようにしてください。

Authorizations:
api_key
header Parameters
x-api-key
required
string

APIキーによる認証を行います。
弊社より提供されたAPIキーを記述してください。

content-type
required
string

content-typeに下記を設定してください。
application/json

Request Body schema: application/json
required
Array of objects[ items [ 1 .. 50 ] ]
入力する出発地の緯度経度リスト

形式

"sources":[{"lon":<経度1>,"lat":<緯度1>},{"lon":<経度2>,"lat":<緯度2>},...,{"lon":<経度n>,"lat":<緯度n>}]

地点は1地点以上50地点以下を設定してください。

入力例

"sources":[
  {"lon":139.703360,"lat":35.69363}
],
required
Array of objects[ items [ 1 .. 50 ] ]
入力する目的地の緯度経度リスト

形式

"targets":[{"lon":<経度1>,"lat":<緯度1>},{"lon":<経度2>,"lat":<緯度2>},...,{"lon":<経度n>,"lat":<緯度n>}]

地点は1地点以上50地点以下を設定してください。

入力例

"targets":[
  {"lon":139.703460,"lat":35.69368}
],
costing
required
string
経路探索の対象車種
意味
auto 普通自動車
truck トラック

形式

"costing":<車種>

車種は auto または truck を設定してください。

入力例

"costing":"auto"
object
経路探索のオプション

形式

"costing_options":{<車種>:{"use_ferry":<フェリー利用優先度>,"use_tolls":<有料道利用優先度>}}

costing で指定する対象車種の、経路探索のオプションを設定してください。

入力例

"costing_options":{"auto":
  {"use_ferry":0.0,"use_tolls":0.0}
},
"costing_options":{"truck":
  {"use_ferry":0.0,"use_tolls":0.0}
},

Responses

Request samples

Content type
application/json
{
  • "sources": [
    ],
  • "targets": [
    ],
  • "costing": "truck",
  • "costing_options": {
    }
}

Response samples

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