Routing

Overview

Route calculation between two locations with possible multiple waypoints (stop-overs) and calculation of alternative routes. Configurable combination of real-time traffic conditions, planned closures, incidents and traffic flow prediction used in route planning. Returning distance, driving time to destination, estimated time of arrival and routing directions.
Routing API can work with traffic prediction data as well as with real time traffic data. Including these parameters will influence the ETA calculation resulting in much more precise ETA.

Default output format is JSON and there is no need to specify it anywhere in the URL request.

Route is returned in JSON as Google Encrypted Polyline with additional information.

Live Example

This example demonstrates the use of the Routing service. Click on icons to see code on Github or play with it in JSFiddle:

Request

API Reference

https://routing.api.sygic.com/v2/api/directions?key=yourAPIkey

Request authentication is done via parameter key, which must be included in the request URL.

Methods

Parameters

Required parameters

To create a valid request all above parameters must be included in the URL request.

Optional parameters

Vehicle types

Depending on the vehicle type special constraints, speed attributes and weights are taken into account during route calculation.

Route calculation for truck and camper takes into account default values described below.

Truck

Garbage truck

Camper

If defined, the vehicle parameters will influence the route calculation results based on the vehicle's attributes. Length, width and height is defined in "mm", weight is defined in "kg". Complete list of supported attributes:

Response

GET

GET https://routing.api.sygic.com/v0/api/directions?origin=54.321697,10.121991&destination=54.307322,9.661965&key=yourAPIkey

POST

POST https://routing.api.sygic.com/v0/api/directions?key=yourAPIkey
Content-Type: application/json

{ 
    "origin": "54.321697,10.121991", 
    "destination": "54.307322,9.661965", 
    "vehicle_type": "truck",
    "total_weight": 8000, 
    "trailers": 1, 
    "vehicle_axles": 2, 
    "trailer_axles": 1
}

Response body

Both GET and POST method produce the same response body:
The text attribute of the distance property is provided in units (imperial or metric) as specified in the input. The value attribute is always in meters.
If calculating route with traffic parameter enabled, it is necessary to add all traffic delays (provided in seconds) to eta and duration in order to get to realistic estimatation. Traffic delays are provided separately and therefore excluded from eta and duration results.

{
    "routes": [
        {
            "route": "oupjIa}w|@^ErCUPELEf@@`A[nAjGlBnFfBtERl@~DdNdA~DdBjG|BhKfArELbAd@`EJdFKxF?rBVfKF~BFjH@jEChJC`DMtLCzEApB@bIRdOZlGdAtLr@tErAxGnIj\\fBnIrBxMr@|Gh@fHf@jJPvFDvAHxBBf@X|EA`Br@zLd@|Dz@hF`AzElBhIvClMnA|Ib@dGd@bKb@rYBbBJ|CDxGFjEx@tm@N`ID|CF`PStMI|B[`Hi@vIcA`KkC|PcBtIoBlIaF`RgN~c@oGpTqGrWaFtWyEd\\mAlKcBpQkBbX{@~PcAlYG`CClAEdBAj@KdEe@z`@AlBCjDC|XJ~WTrTh@rWZ`Pf@tUTfK`@fQ|@d]v@|O|BpYhBpOrE`\\bC`RDZf@fEvBlULtBZfFJhBNxCBZn@xQ\\~TZb`@JxQ@jNO~PeAfa@mDzdAo@jOsArSmDx_@eAnK}AlRs@zNg@rRChUB|ENzKZnR~B~tAvBthAv@nUtAdWbCl\\p[zbDrFhh@nDvZdB`Mb@~C|@xGrJ~n@fIzb@pBlJv@lDzAxGrDtOzEnQ|Rdr@|FzU|ArH|DfU~ArLx@xG^dDtBbQb@nDhAtIFf@\\`CZvBDXbAbHDXbBvKv@`E|BfJd@~BVlAJh@tA~Gb@tB\\~AtDbPrB~IxB~IzB`JvCdLzAdGjAvELb@Nn@|@xDR~@r@jDzAjI`@hCT~AhDbVF\\fAjIlBbOrAlKjAtIr@lFz@nG@JJv@v@`G`@|Cd@jDDhAJp@D^TzB@ZBpCStEYfB_@pAeAlCINo@~@oBbBoCrAaFfB_H`BsGhA}Ch@gMrB}Bd@oAR_APyOlCwAV}EdASF]JcErA_BXe@G]w@EsBNu@l@yBZe@j@]f@GjBTx@JXF@kApAc]ImEO_AWq@uAkAgAe@eCyA_CoDm@s@cA[eCM?mIYiBsAcEy@uBcA}A]MeAGu@?e@VsEVw@Ho@JiBHwAEa@SaAKy@Cs@PuAlAc@r@sChE{CjFkA`D}AbGIj@y@bEW`Ai@rAw@tA",
            "eta": 1531834797,
            "duration": {
                "value": 1713,
                "text": "28 minutes 33 seconds"
            },
            "distance": {
                "value": 36430,
                "text": "36.43 km"
            },
            "legs": [
                {
                    "distance": {
                        "value": 36430,
                        "text": "36.43 km"
                    },
                    "duration": {
                        "value": 1713,
                        "text": "28 minutes 33 seconds"
                    },
                    "start_location": {
                        "latitude": 54.32168,
                        "longitude": 10.12193
                    },
                    "end_location": {
                        "latitude": 54.30731,
                        "longitude": 9.66195
                    },
                    "route": "oupjIa}w|@^ErCUPELEf@@`A[nAjGlBnFfBtERl@~DdNdA~DdBjG|BhKfArELbAd@`EJdFKxF?rBVfKF~BFjH@jEChJC`DMtLCzEApB@bIRdOZlGdAtLr@tErAxGnIj\\fBnIrBxMr@|Gh@fHf@jJPvFDvAHxBBf@X|EA`Br@zLd@|Dz@hF`AzElBhIvClMnA|Ib@dGd@bKb@rYBbBJ|CDxGFjEx@tm@N`ID|CF`PStMI|B[`Hi@vIcA`KkC|PcBtIoBlIaF`RgN~c@oGpTqGrWaFtWyEd\\mAlKcBpQkBbX{@~PcAlYG`CClAEdBAj@KdEe@z`@AlBCjDC|XJ~WTrTh@rWZ`Pf@tUTfK`@fQ|@d]v@|O|BpYhBpOrE`\\bC`RDZf@fEvBlULtBZfFJhBNxCBZn@xQ\\~TZb`@JxQ@jNO~PeAfa@mDzdAo@jOsArSmDx_@eAnK}AlRs@zNg@rRChUB|ENzKZnR~B~tAvBthAv@nUtAdWbCl\\p[zbDrFhh@nDvZdB`Mb@~C|@xGrJ~n@fIzb@pBlJv@lDzAxGrDtOzEnQ|Rdr@|FzU|ArH|DfU~ArLx@xG^dDtBbQb@nDhAtIFf@\\`CZvBDXbAbHDXbBvKv@`E|BfJd@~BVlAJh@tA~Gb@tB\\~AtDbPrB~IxB~IzB`JvCdLzAdGjAvELb@Nn@|@xDR~@r@jDzAjI`@hCT~AhDbVF\\fAjIlBbOrAlKjAtIr@lFz@nG@JJv@v@`G`@|Cd@jDDhAJp@D^TzB@ZBpCStEYfB_@pAeAlCINo@~@oBbBoCrAaFfB_H`BsGhA}Ch@gMrB}Bd@oAR_APyOlCwAV}EdASF]JcErA_BXe@G]w@EsBNu@l@yBZe@j@]f@GjBTx@JXF@kApAc]ImEO_AWq@uAkAgAe@eCyA_CoDm@s@cA[eCM?mIYiBsAcEy@uBcA}A]MeAGu@?e@VsEVw@Ho@JiBHwAEa@SaAKy@Cs@PuAlAc@r@sChE{CjFkA`D}AbGIj@y@bEW`Ai@rAw@tA",
                    "eta": 1531834797
                }
            ]
        }
    ],
    "status": "OK",
    "copyright": "© 2018 Sygic a.s."
}

Response with avoids

GET https://routing.api.sygic.com/v0/api/directions?origin=51.51168,-0.11819&destination=51.49368,-0.09390&avoid=congestioncharges&key=yourAPIkey

{
    "routes": [{
            "route": "wzkyHpaVv@|CPNN@XSJK`EcDPMLKjBaBvBiBNMhFoEXUbA}@vDeDb@_@dBwA\\_@LSN}@Na@ZOX@V?NLHT@r@ALEZBXJn@LXDJb@r@DFNNVZb@`@^\\JJx@v@bC`Cn@j@bAx@jAn@VBJKf@oCHe@Vq@VGT@PFRVBLBJNd@N\\^lACXUIXOJBJ?LBh@FPBj@H\\DPsBHK~A^z@aEZaBd@iAzAmFz@nAv@jAnAvApAv@ZN~@Lt@@QkAIk@[sBc@sCfA}@TSRMRq@^AN\\^LZIP[n@E~@xAfEaKVAdADfAsDRe@JWlA}CmCoEa@mA[mBKgANu@hBcAnAm@~DgBGe@i@cFIs@O{@WeAq@{@W]CEGEmA}BSYUe@i@aAEIY_@q@_@k@U[GEs@@Wj@wB@M@c@VqADOHOHQNOvA{@lAs@^WkAmIyAqKK{ASKa@Au@Rc@HUD",
            "eta": 1531818531,
            "duration": {
                "value": 1092,
                "text": "18 minutes 12 seconds"
            },
            "distance": {
                "value": 4715,
                "text": "4.72 km"
            },
            "legs": [{
                    "distance": {
                        "value": 4715,
                        "text": "4.72 km"
                    },
                    "duration": {
                        "value": 1092,
                        "text": "18 minutes 12 seconds"
                    },
                    "start_location": {
                        "latitude": 51.51164,
                        "longitude": -0.11817
                    },
                    "end_location": {
                        "latitude": 51.49363,
                        "longitude": -0.09402
                    },
                    "route": "wzkyHpaVv@|CPNN@XSJK`EcDPMLKjBaBvBiBNMhFoEXUbA}@vDeDb@_@dBwA\\_@LSN}@Na@ZOX@V?NLHT@r@ALEZBXJn@LXDJb@r@DFNNVZb@`@^\\JJx@v@bC`Cn@j@bAx@jAn@VBJKf@oCHe@Vq@VGT@PFRVBLBJNd@N\\^lACXUIXOJBJ?LBh@FPBj@H\\DPsBHK~A^z@aEZaBd@iAzAmFz@nAv@jAnAvApAv@ZN~@Lt@@QkAIk@[sBc@sCfA}@TSRMRq@^AN\\^LZIP[n@E~@xAfEaKVAdADfAsDRe@JWlA}CmCoEa@mA[mBKgANu@hBcAnAm@~DgBGe@i@cFIs@O{@WeAq@{@W]CEGEmA}BSYUe@i@aAEIY_@q@_@k@U[GEs@@Wj@wB@M@c@VqADOHOHQNOvA{@lAs@^WkAmIyAqKK{ASKa@Au@Rc@HUD",
                    "eta": 1531818531
                }
            ],
            "ignored_avoids": {
                "congestioncharges": [
                    "wzkyHpaVv@|CPNN@XSJK`EcDPM",
                    "}_kyHbrUbA}@vDeDb@_@dBwA\\_@LSN}@Na@ZOX@V?NLHT@r@ALEZBXJn@LXDJb@r@DFNNVZb@`@^\\JJx@v@bC`Cn@j@bAx@jAn@VBJKf@oCHe@Vq@VGT@PFRVBLBJNd@N\\^lACXUIXOJBJ?LBh@FPBj@H\\D",
                    "qvhyHdnUQkAIk@[sBc@sC",
                    "qghyHhtTVAdAD"
                ]
            }
        }
    ],
    "status": "OK",
    "copyright": "© 2018 Sygic a.s."
}

Response with inaccessible waypoints

When Routing API can not compute a route with provided parameters due to waypoints placed in inaccessible areas, response body will contain an array inaccessible_waypoints.

{
    "routes": [],
    "inaccessible_waypoints": [
        "51.02724,4.47708"
    ],
    "status": "NO_RESULTS",
    "copyright": "© 2019 Sygic a.s."
}

Response Code

Response codes follow HTTP response standard.

Route format

Sygic Routing API is using Google Encoded Polyline that stores a series of coordinates into a single string. More information about Encoded Polyline can be found on this link.

Encoded polyline string from the response is escaped.
Polyline below is encoded from two coordinates "41.6076,-88.21549","41.60745,-88.21537":

on}|FxqlyO\W

it contains characters ['o', 'n', '}', '|', 'F', 'x', 'q', 'l', 'y', 'O', '\', 'W'], therefore if used as string literal in code, it has to be declared as:

var polyline = "on}|FxqlyO\\W";

Dispatch itinerary

For seamless support of route dispatching from Sygic Maps server side into the Sygic Professional Navigation SDK we provide possiblity to request the Routing response in SIF format.

Request body and parameters remains the same as in standard Routing API calculation.

To receive Routing response in SIF format you need to change the following key:value in request Header:

Response example:

{
    "name": "db9cad92-36c3-41c4-9416-2532b1cfbc4c",
    "routeParts": [
        {
            "waypointFrom": {
                "lat": 4815027,
                "lon": 1712561,
                "type": "start"
            },
            "waypointTo": {
                "lat": 4797874,
                "lon": 1761001,
                "type": "finish"
            }
        }
    ],
    "status": "OK",
    "copyright": "© 2017 Sygic a.s."
}