About this endpoint
What it does
Builds a recommended travel tour from a set of geo-coordinates, starting from the point ID you supply and optionally running additional optimization iterations. The response returns the chosen start point, the ordered tour of point IDs, and the total tour cost.
Query Parameter(s)
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| start | String | Yes | Start point ID. Pattern: ^[a-zA-Z0-9_:-]{1,40}$. |
| iterations | Integer | No | Number of additional probabilistic optimization iterations. Default: 0. Range: 0-5000. |
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| geo-coordinates | Object | Yes | Map of point id to its coordinates. Each key is a point id, 1-40 characters long and containing only letters, digits, underscores, colons, and hyphens (^[a-zA-Z0-9_:-]{1,40}$). At most 1000 points are accepted per request. |
| geo-coordinates[].lat | Number | Yes | Point latitude, from -90.0 (S) to 90.0 (N). |
| geo-coordinates[].lon | Number | Yes | Point longitude, from -180.0 (W) to 180.0 (E). |
Response
Returns a JSON object with required start string, tour array of strings, and cost number fields. The start field is the start point ID carried over from the query parameters, tour is the recommended visit order, and cost is the total tour cost in kilometers.
| Parameter | Type | Description |
|---|---|---|
| cost | Number | Total tour cost: sum of all distances from previous to the next points (in kilometers). |
| start | String | Start point ID (carried over from the query parameters). Pattern: ^[a-zA-Z0-9_:-]{1,40}$. |
| tour | String Array | The list of point IDs in the recommended visit order. Each item matches ^[a-zA-Z0-9_:-]{1,40}$. |



