route-overview
Generate routing data between multiple locations, including travel time, distance, and encoded polyline, in JSON format. Supports various travel methods and distance units for accurate route planning.
Instructions
Get high-level routing information between two or more locations. Includes travel time, distance, and an encoded polyline of the route. The result is JSON.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| costing | Yes | The method of travel to use when routing (auto = automobile). | |
| locations | Yes | ||
| units | Yes | The unit to report distances in. |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"costing": {
"description": "The method of travel to use when routing (auto = automobile).",
"enum": [
"auto",
"bus",
"taxi",
"truck",
"bicycle",
"bikeshare",
"motor_scooter",
"motorcycle",
"pedestrian",
"low_speed_vehicle"
],
"type": "string"
},
"locations": {
"items": {
"additionalProperties": false,
"description": "A geographic coordinate pair.",
"properties": {
"lat": {
"description": "The latitude of the point.",
"maximum": 90,
"minimum": -90,
"type": "number"
},
"lon": {
"description": "The longitude of the point.",
"maximum": 180,
"minimum": -180,
"type": "number"
}
},
"required": [
"lat",
"lon"
],
"type": "object"
},
"minItems": 2,
"type": "array"
},
"units": {
"description": "The unit to report distances in.",
"enum": [
"km",
"mi"
],
"type": "string"
}
},
"required": [
"locations",
"costing",
"units"
],
"type": "object"
}