> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/user-api/backend-api/resources/tracking/route/route_progorod.md).

# Getting route with Progorod

API call for getting the route to destination point using [Progorod router](https://giswiki.tmcrussia.com/index.php?title=%D0%9C%D0%B0%D1%80%D1%88%D1%80%D1%83%D1%82%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F).

## API actions

API path: `/route/progorod`.

### get

Gets route points using Progorod router.

#### Parameters

| name         | description                                                                                                                                                    | type                  |
| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
| start        | Location JSON object. Start of route.                                                                                                                          | JSON object           |
| end          | Location JSON object. End of route.                                                                                                                            | JSON object           |
| waypoints    | Optional. List of transitional points. `[{locationA},{locationN}]`.                                                                                            | array of JSON objects |
| point\_limit | Optional. If specified, the returned route will be simplified to contain this number of points (or less). Min=2.                                               | int                   |
| minsize      | Optional. Default=5. Smoothing parameter in conventional meters. Not recommended to set it less than distance between two neighbouring pixels on current zoom. | double                |
| use\_traffic | Optional. Default=`false` If it is `false` then use `mode=optimal` and use traffic=0, else `mode=comfort` and use traffic=1.                                   | boolean               |

Where **location** described in [data types description section](/docs/navixy-api/user-api/backend-api.md#data-types). Order of waypoints may be changed.

#### Response

```json
{
  "success": true,
  "distance": 1340584,
  "time": 43500,
  "list": [
    {
      "lat": 34.178868,
      "lng": -118.599672
    },
    {
      "lat": 31.738386,
      "lng": -106.453854
    }
  ],
  "key_points": [
    {
      "id": 123,
      "lat": 35.365948,
      "lng": -108.112104
    }
  ]
}
```

* `distance` - int. Length in meters.
* `time` - int. Duration in seconds.
* `list` - list of route points. Location objects.
* `key_points` - list of points corresponding to `start` point, `waypoints` and `end` point (in that sequence).
  * `id` - int. index in points `list`.
  * `lat` - float. Latitude.
  * `lng` - float. Longitude.

#### Errors

* 215 - External service error.
* 218 - Malformed external service parameters – Contains info about error:

```json
{
  "success": false,
  "status": {
    "code": 218,
    "description": "Malformed external service parameters"
  },
  "errors": [
    {
      "type": "malformed",
      "point": "start",
      "index": 3
    }
  ]
}
```

* `type` - [enum](/docs/navixy-api/user-api/backend-api.md#data-types). Type of error. One of: "not\_set", "malformed" and "isolated".
* `point` - [enum](/docs/navixy-api/user-api/backend-api.md#data-types). Error point. One of: "start", "end", "waypoint" and "all".
* `index` - int. Passed only for a waypoint. Index of bad point in waypoints array.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://navixy.com/docs/navixy-api/user-api/backend-api/resources/tracking/route/route_progorod.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.