GuidesAPI Reference
Guides

Instructions for turn-by-turn navigation

Turn-by-turn guidance allows users to be guided to their destination in a step-by-step approach.

Guidance comprises of verbal and visual components. Verbal components refer to the voice instructions about one or more upcoming maneuvers. Visual components refer to user interface elements supporting the current or upcoming maneuvers, such as direction arrows, current or upcoming street names.

The sections are broken down into a sequence of guidance-oriented turn-by-turn actions and can be obtained by specifying return=polyline,turnbyturnactions when requesting a route.

curl -gX GET 'https://router.hereapi.com/v8/routes?'\
'transportMode=car&'\
'origin=52.5308,13.3847&'\
'destination=52.5323,13.3789&'\
'return=polyline,turnbyturnactions&'\
'apiKey=YOUR_API_KEY'
{
  "routes": [
    {
      "id": "a514bfa3-e97c-407b-aa13-615a9e4244c3",
      "sections": [
        {
          "id": "d71cc8f3-76a1-4ad0-a67f-56895aecc187",
          "type": "vehicle",
          "turnByTurnActions": [
            {
              "action": "depart",
              "duration": 24,
              "length": 113,
              "offset": 0,
              "nextRoad": {
                "name": [
                  {
                    "value": "Invalidenstraße",
                    "language": "de"
                  }
                ]
              }
            },
            {
              "action": "turn",
              "duration": 53,
              "length": 321,
              "offset": 4,
              "direction": "right",
              "severity": "quite",
              "currentRoad": {
                "name": [
                  {
                    "value": "Invalidenstraße",
                    "language": "de"
                  }
                ]
              },
              "nextRoad": {
                "name": [
                  {
                    "value": "Chausseestraße",
                    "language": "de"
                  }
                ]
              }
            },
            {
              "action": "turn",
              "duration": 15,
              "length": 105,
              "offset": 18,
              "direction": "left",
              "severity": "quite",
              "currentRoad": {
                "name": [
                  {
                    "value": "Chausseestraße",
                    "language": "de"
                  }
                ]
              },
              "nextRoad": {
                "name": [
                  {
                    "value": "Habersaathstraße",
                    "language": "de"
                  }
                ]
              }
            },
            {
              "action": "arrive",
              "duration": 0,
              "length": 0,
              "offset": 21,
              "currentRoad": {
                "name": [
                  {
                    "value": "Habersaathstraße",
                    "language": "de"
                  }
                ]
              }
            }
          ],
          "departure": {
            "time": "2020-09-11T13:29:22+02:00",
            "place": {
              "type": "place",
              "location": {
                "lat": 52.5309837,
                "lng": 13.384567
              },
              "originalLocation": {
                "lat": 52.5307999,
                "lng": 13.3847
              }
            }
          },
          "arrival": {
            "time": "2020-09-11T13:30:54+02:00",
            "place": {
              "type": "place",
              "location": {
                "lat": 52.5323264,
                "lng": 13.378874
              },
              "originalLocation": {
                "lat": 52.5323,
                "lng": 13.3789
              }
            }
          },
          "polyline": "BGwynmkDu39wZvBtF3InfvHrdvHvboGzF0FnGoGvHsOvR8L3NkSnVoGjIsEzFgFvHkDrJwHrJwHrJ4NjS0ezoBjInV3N_iBzJ_Z",
          "transport": {
            "mode": "car"
          }
        }
      ]
    }
  ]
}