Synchronous Snap to Roads
Purpose
The Synchronous Snap to Roads endpoint provides detailed information of a reconstructed road in an efficient way. The Snap to Roads endpoint matches the received points to the map road network and reconstructs the driven road. Points given as input to the Snap to Roads endpoint are related to themselves and are a part of the same route from the same client.
The matching algorithm chooses the driven road fitting to all of the given points, or in case of a few possibilities takes into account additional restrictions provided by the client. This endpoint can also provide extended data related to a matched route. This endpoint can be used for:
- Reconstructing the driven road and getting the detailed insights for it.
- Providing innovative information in order to build applications with advanced map data.
Run this endpoint
You can easily run this and other endpoints. Go to the TomTom API Explorer and follow the directions.
Request data
HTTPS method: GET
For ease of viewing and identification:
- Constants and parameters enclosed in curly brackets { } must be replaced with their values.
- Please see the following GET request parameters section with the required and optional parameters tables for their values. The generic request format is as follows.
https://{baseURL}/snapToRoads/{versionNumber}?key={Your_API_Key}&points={longitude,latitude...}&headings={string}×tamps={string}&fields={string}&vehicleType={string}&measurementSystem={string}
https://api.tomtom.com/snapToRoads/1?key={Your_API_Key}&points=4.6104919036936565,52.37576529649988;4.614096792595859,52.38341473290629&headings=0;0×tamps=2021-01-01T00:00:00Z;2021-01-01T00:01:00Z&fields={route{properties{id,speedLimits{value,unit,type}}}}&vehicleType=PassengerCar&measurementSystem=auto
curl 'https://api.tomtom.com/snapToRoads/1?key={Your_API_Key}&points=4.6104919036936565,52.37576529649988;4.614096792595859,52.38341473290629&headings=0;0×tamps=2021-01-01T00:00:00Z;2021-01-01T00:01:00Z&fields={route{properties{id,speedLimits{value,unit,type}}}}&vehicleType=PassengerCar&measurementSystem=auto'
https://api.tomtom.com/snapToRoads/1?key={Your_API_Key}&points=4.6104919036936565,52.37576529649988;4.614096792595859,52.38341473290629&headings=0;0×tamps=2021-01-01T00:00:00Z;2021-01-01T00:01:00Z&fields={projectedPoints{type,geometry{type,coordinates},properties{routeIndex,snapResult}},route{type,geometry{type,coordinates},properties{id,speedLimits{value,unit,type}}}}&vehicleType=PassengerCar&measurementSystem=auto&offroadMargin=50
curl 'https://api.tomtom.com/snapToRoads/1?key={Your_API_Key}&points=4.6104919036936565,52.37576529649988;4.614096792595859,52.38341473290629<&headings=0;0×tamps=2021-01-01T00:00:00Z;2021-01-01T00:01:00Z&fields={projectedPoints{type,geometry{type,coordinates},properties{routeIndex,snapResult}},route{type,geometry{type,coordinates},properties{id,speedLimits{value,unit,type}}}}&vehicleType=PassengerCar&measurementSystem=auto&offroadMargin=50'
https://api.tomtom.com/snapToRoads/1?key={Your_API_Key}&points=4.6104919036936565,52.37576529649988;4.614096792595859,52.38341473290629&headings=0;0×tamps=2021-01-01T00:00:00Z;2021-01-01T00:01:00Z&fields={projectedPoints{type,geometry{type,coordinates},properties{routeIndex,snapResult}},route{type,geometry{type,coordinates},properties{id,linearReference,speedLimits{value,unit,type},speedProfile{value,unit},address{roadName,roadNumbers,municipality,countryName,countryCode,countrySubdivision},maximumDimensions{height{value,unit},length{value,unit},width{value,unit},totalWeight{value,unit},weightPerAxle{value,unit}},traveledDistance{value,unit},privateRoad,partOfTunnel,urbanArea,elementType,frc,formOfWay,roadUse,laneInfo{numberOfLanes},heightInfo{height,chainage,unit},trafficSigns{signType,chainage,unit},trafficLight,confidence}},distances{total,ferry,publicRoad,privateRoad,road,offRoad,unit}}&vehicleType=PassengerCar&measurementSystem=auto&offroadMargin=50
curl 'https://api.tomtom.com/snapToRoads/1?key={Your_API_Key}&points=4.6104919036936565,52.37576529649988;4.614096792595859,52.38341473290629&headings=0;0×tamps=2021-01-01T00:00:00Z;2021-01-01T00:01:00Z&fields={projectedPoints{type,geometry{type,coordinates},properties{routeIndex,snapResult}},route{type,geometry{type,coordinates},properties{id,speedLimits{value,unit,type},speedProfile{value,unit},address{roadName,roadNumbers,municipality,countryName,countryCode,countrySubdivision},maximumDimensions{height{value,unit},length{value,unit},width{value,unit},totalWeight{value,unit},weightPerAxle{value,unit}},traveledDistance{value,unit},privateRoad,partOfTunnel,urbanArea,elementType,frc,formOfWay,roadUse,laneInfo{numberOfLanes},heightInfo{height,chainage,unit},trafficSigns{signType,chainage,unit},trafficLight,confidence}},distances{total,ferry,publicRoad,privateRoad,road,offRoad,unit}}&vehicleType=PassengerCar&measurementSystem=auto&offroadMargin=50'
GET request parameters
The following table describes the parameters that can be used in a request.
- Required parameters must be used or the call will fail.
- Parameters and values are case-sensitive.
- Optional parameters may be used.
Required parameters | Description |
---|---|
| The base URL for calling TomTom services. |
| The version of the service to call. |
| The authorization key for access to the API. |
| Semicolon separated list of points.
Value: |
Optional parameters | Description |
---|---|
| A semicolon-separated list indicating the direction of movement.
Default value: |
| A semicolon-separated list indicating the timestamps of obtained points.
|
| The fields to be included in the response, nested as in the response schema.
Default value:
Value needed to obtain all data - JSON
|
| It can contribute to a more accurate road identification by possibly
excluding roads that are not suited for a given value. If the
|
| Indicates the measurement system in which the client requests data. If
|
| It can contribute to detect an offroad movement of the vehicle. Any
input point being further (from any road segment) than this value is
considered as an offroad point.
|
HTTPS method: POST
For ease of viewing and identification:
- Constants and parameters enclosed in curly brackets must be replaced with their values.
- Please see the following POST request parameters section with the required and optional parameters tables for their values. The generic request format is as follows.
https://{baseURL}/snapToRoads/{versionNumber}?key={Your_API_Key}&fields={string}&vehicleType={string}&measuremenSystem={string}
https://api.tomtom.com/snapToRoads/1?key={Your_API_Key}&fields={route{properties{id,speedLimits{value,unit,type}}}}&vehicleType=PassengerCar&measurementSystem=auto
1curl -X POST 'https://api.tomtom.com/snapToRoads/1?key={Your_API_Key}&fields={route{properties{id,speedLimits{value,unit,type}}}}&vehicleType=PassengerCar&measurementSystem=auto' -d '{2"points": [3 {4 "type": "Feature",5 "geometry": {6 "type": "Point",7 "coordinates": [4.6104919036936565,52.37576529649988]8 },9 "properties": {10 "heading": 011 }12 },13 {14 "type": "Feature",15 "geometry": {16 "type": "Point",17 "coordinates": [4.614096792595859,52.38341473290629]18 },19 "properties": {20 "heading": 021 }22 }23 ]24}'
https://api.tomtom.com/snapToRoads/1?key={Your_API_Key}&fields={projectedPoints{type,geometry{type,coordinates},properties{routeIndex,snapResult}},route{type,geometry{type,coordinates},properties{id,speedLimits{value,unit,type}}}}&vehicleType=PassengerCar&measurementSystem=auto
1curl -X POST 'https://api.tomtom.com/snapToRoads/1?key=Your_API_Key&fields={projectedPoints{type,geometry{type,coordinates},properties{routeIndex,snapResult}},route{type,geometry{type,coordinates},properties{id,speedLimits{value,unit,type}}}}&vehicleType=PassengerCar&measurementSystem=auto' -d '{2"points": [3 {4 "type": "Feature",5 "geometry": {6 "type": "Point",7 "coordinates": [4.6104919036936565,52.37576529649988]8 },9 "properties": {10 "heading": 011 }12 },13 {14 "type": "Feature",15 "geometry": {16 "type": "Point",17 "coordinates": [4.614096792595859,52.38341473290629]18 },19 "properties": {20 "heading": 021 }22 }23 ]24}'
https://api.tomtom.com/snapToRoads/1?key=Your_API_Key&fields={projectedPoints{type,geometry{type,coordinates},properties{routeIndex,snapResult}},route{type,geometry{type,coordinates},properties{id,linearReference,speedLimits{value,unit,type},speedProfile{value,unit},address{roadName,roadNumbers,municipality,countryName,countryCode,countrySubdivision},maximumDimensions{height{value,unit},length{value,unit},width{value,unit},totalWeight{value,unit},weightPerAxle{value,unit}},elementType,traveledDistance{value,unit},privateRoad,partOfTunnel,urbanArea,frc,formOfWay,roadUse,laneInfo{numberOfLanes},heightInfo{height,chainage,unit},trafficSigns{signType,chainage,unit},trafficLight,confidence}},distances{total,ferry,publicRoad,privateRoad,road,offRoad,unit}}&vehicleType=PassengerCar&measurementSystem=auto&offroadMargin=50
1curl -X POST 'https://api.tomtom.com/snapToRoads/1?key=Your_API_Key&fields={projectedPoints{type,geometry{type,coordinates},properties{routeIndex,snapResult}},route{type,geometry{type,coordinates},properties{id,linearReference,speedLimits{value,unit,type},speedProfile{value,unit},address{roadName,roadNumbers,municipality,countryName,countryCode,countrySubdivision},maximumDimensions{height{value,unit},length{value,unit},width{value,unit},totalWeight{value,unit},weightPerAxle{value,unit}},elementType,traveledDistance{value,unit},privateRoad,partOfTunnel,urbanArea,frc,formOfWay,roadUse,laneInfo{numberOfLanes},heightInfo{height,chainage,unit},trafficSigns{signType,chainage,unit},trafficLight,confidence}},distances{total,ferry,publicRoad,privateRoad,road,offRoad,unit}}&vehicleType=PassengerCar&measurementSystem=auto&offroadMargin=50' -d '2{3"points": [4 {5 "type": "Feature",6 "geometry": {7 "type": "Point",8 "coordinates": [4.6104919036936565,52.37576529649988]9 },10 "properties": {11 "heading": 012 }13 },14 {15 "type": "Feature",16 "geometry": {17 "type": "Point",18 "coordinates": [4.614096792595859,52.38341473290629]19 },20 "properties": {21 "heading": 022 }23 }24 ]25}'
POST request parameters
The following table describes the parameters that can be used in a request.
- Required parameters must be used or the call will fail.
- Parameters and values are case-sensitive.
- Optional parameters may be used.
Required parameters | Description |
---|---|
| The base URL for calling TomTom services. |
| The version of the service to call. |
| The authorization key for access to the API. |
Optional parameters | Description |
---|---|
| The fields to be included in the response, nested as in the response schema.
Default value:
Value needed to obtain all data - JSON
|
| It can contribute to a more accurate road identification by possibly
excluding roads that are not suited for the given value. If the
|
| Indicates the measurement system in which a client requests data.
|
Request body
Follow the request body schema in order to prepare a valid POST request. The maximum size of the HTTP POST request body is 10 MB
.
Request schema
An exclamation mark !
means that this field is required.
1{2 type Query {3 points: [Point!]!4 }5 type Point {6 type: GeojsonFeatureType!7 geometry: GeojsonPoint!8 properties: Properties9 }10 type GeojsonPoint {11 type: GeojsonPointType!12 coordinates: [Float!]!13 }14 type Properties {15 heading: Float16 timestamp: String17 }18 enum GeojsonPointType {19 Point20 }21 enum GeojsonFeatureType {22 Feature23 }24}
Fields of the request body
Structure of the root object | |
---|---|
Field | Description |
| The list of points.
|
Structure of the point object | |
---|---|
Field | Description |
| The value is always set as |
| This is a
GeoJSON
object type which must contain the |
| It may contain data in order to increase the likelihood of correctly snapping the point. |
Structure of the geometry object | |
---|---|
Field | Description |
| The value is always set as a |
| It must contain exactly two numbers which represent the longitude and latitude of the point. |
Structure of the properties object | |
---|---|
Field | Description |
| The directional heading of the vehicle in degrees for travel along a segment of roadway.
|
| The timestamp of obtained point.
|
1{2 "points": [3 {4 "type": "Feature",5 "geometry": {6 "type": "Point",7 "coordinates": [4.6104919036936565, 52.37576529649988]8 },9 "properties": {10 "heading": 0,11 "timestamp": "2021-01-01T12:00:00Z"12 }13 },14 {15 "type": "Feature",16 "geometry": {17 "type": "Point",18 "coordinates": [4.614096792595859, 52.38341473290629]19 },20 "properties": {21 "heading": 0,22 "timestamp": "2021-01-01T12:00:01Z"23 }24 }25 ]26}
HTTP request headers
The following table lists HTTP request headers of particular interest to clients of the Synchronous Snap to Roads endpoint.
Note: There are no required headers in this endpoint.
Optional headers | Description |
---|---|
Contains the content encoding (usually a compression algorithm), that
the client is able to understand. | |
Tracking-ID | Specifies an identifier for the request.
Value: |
Response data
Successful response
For a single valid request, the Synchronous Snap to Roads endpoint returns its response body in JSON format. The fields that appear in the JSON response depend on the value of the fields
request parameter. By default, the client only gets the geometry of projected points.
Response schema
Exclamation mark !
means that the field is not nullable. For example:
Point!
- is non-nullable[Point!]
- list of non-null objects[Point]!
- list cannot be null, but it can contain null values
1{2 union AnyElement = RoadElement | FerryElement3 type Query {4 projectedPoints: [ProjectedPoint!]!5 route: [AnyElement!]!6 distances: Distances!7 }89 type Distances {10 total: Int!11 ferry: Int!12 road: Int!13 privateRoad: Int!14 publicRoad: Int!15 offRoad: Int!16 unit: DistanceUnit!17 }1819 type ProjectedPoint {20 type: GeojsonFeatureType!21 geometry: GeojsonPoint22 properties: ProjectedPointProperties!23 }2425 type ProjectedPointProperties {26 routeIndex: Int27 snapResult: String!28 }2930 type FerryElement {31 type: GeojsonFeatureType!32 geometry: GeojsonLinestring!33 properties: FerryElementProperties!34 }3536 type RoadElement {37 type: GeojsonFeatureType!38 geometry: GeojsonLinestring!39 properties: RoadElementProperties!40 }4142 type RoadElementProperties {43 id: String!44 linearReference: String!45 address: RoadAddress!46 maximumDimensions:MaximumDimension47 speedLimits: SpeedLimit48 speedProfile: SpeedProfile49 elementType: ElementType!50 frc: Int!51 formOfWay: String52 roadUse: String53 laneInfo: LaneInfo!54 traveledDistance: Distance!55 privateRoad: bool!56 partOfTunnel: bool!57 urbanArea: bool!58 heightInfo: [HeightInfo!]!59 trafficSigns: [TrafficSign!]!60 trafficLight: String61 confidence: Float!62 }6364 type FerryElementProperties {65 id: String!66 linearReference: String!67 address: FerryAddress!68 maximumDimensions:MaximumDimension69 elementType: ElementType!70 frc: Int!71 traveledDistance: Distance!72 privateRoad: bool!73 partOfTunnel: bool!74 urbanArea: bool!75 confidence: Float!76 }7778 type LaneInfo {79 numberOfLanes: Int80 }8182 type Distance {83 value: Int!84 unit: DistanceUnit!85 }8687 type SpeedLimit {88 value: Int!89 unit: SpeedUnit!90 type: String!91 }9293 type SpeedProfile {94 value: Int!95 unit: SpeedUnit!96 }9798 type FerryAddress {99 roadName: String100 roadNumbers: [String!]!101 }102103 type RoadAddress {104 roadName: String105 roadNumbers: [String!]!106 municipality: String107 countryName: String108 countryCode: String109 countrySubdivision: String110 }111112 type MaximumDimension {113 height : Dimension114 length : Dimension115 width : Dimension116 totalWeight : Dimension117 weightPerAxle : Dimension118 }119120 type Dimension {121 value : Int!122 unit : String!123 }124125 type HeightInfo {126 height: Int!127 chainage: Int!128 unit: DistanceUnit!129 }130131 type TrafficSign {132 signType: String!133 chainage: Int!134 unit: DistanceUnit!135 }136137 enum DistanceUnit {138 cm,139 m,140 ft141 }142143 enum SpeedUnit {144 kmph,145 mph146 }147148 enum ElementType {149 Road,150 Ferry151 }152153 type GeojsonPoint {154 type: GeojsonPointType!155 coordinates: [Float!]!156 }157158 type GeojsonLinestring {159 type: GeojsonLinestringType!160 coordinates: [[Float!]!]!161 }162163 enum GeojsonLinestringType {164 LineString165 }166167 enum GeojsonPointType {168 Point169 }170171 enum GeojsonFeatureType {172 Feature173 }174}
Response field structure
The following tables describe JSON element fields that can appear in a response.
Structure of the root object | |
---|---|
Field | Description |
|
|
| The list of road elements forming the reconstructed route. |
| The traveled distance within the road segment or on the ferry in meters or feet depending on the chosen measurement system. |
Structure of the ProjectedPoint object | |
---|---|
Field | Description |
| The value is set as |
| A
GeoJSON
feature of type
|
| They contain information about a point. |
Structure of the ProjectedPointProperties object | |
---|---|
Field | Description |
| The index of a matching road element from the |
| Stores the result given by the matching algorithm.
|
Structure of the FerryElement object | |
---|---|
Field | Description |
| The value is set as |
| A
GeoJSON
feature of type LineString. It always contains the |
| Detailed information about the ferry element. |
Structure of the RoadElement object | |
---|---|
Field | Description |
| The value is set as |
| A
GeoJSON
feature of type LineString. It always contains the |
| Detailed information about the road element. |
Structure of the FerryElementProperties object | |
---|---|
Field | Description |
| Unique ID of the ferry element. |
| Base64 encoded location reference expressed in
OpenLR
format. |
| Address information relevant to the ferry element. |
| Information about the maximum dimensions of a vehicle allowed to use this road. |
| Type of the element. |
| FRC
(Functional Road Class) represents a classification of roads based on
the importance that the constituting roads have in the road network. |
| The traveled distance within the ferry segment in meters or feet depending on the chosen measurement system. |
| Ferry element ownership.
|
| Ferry element that is a part of a tunnel.
|
| Ferry element that is a part of an urban area.
|
| It represents the algorithm's confidence for the given ferry element. It's a float from the range (0,1]. |
Structure of the RoadElementProperties object | |
---|---|
Field | Description |
| Unique ID of the road element. |
| Base64 encoded location reference expressed in
OpenLR
format. |
| Speed limits for a given
|
| Speed profile represented as average speed in a given road segment in a given timeframe. The time frame is calculated from a GPS point timestamp which must be present for at least the first GPS point. |
| Address information relevant to the road element. |
| Information about the maximum dimensions of a vehicle allowed to use this road. |
| Type of the element. |
| FRC
(Functional Road Class) represents a classification of roads based on
the importance that the constituting roads have in the total road
network. |
| Form of way represents the physical form of a road. This is based on a
number of certain physical characteristics and traffic properties.
|
| It specifies how the road element is used for travel.
|
| Lane Information refers to the collection of lane-related information stored in a Road Element. |
| The traveled distance within the road segment in meters or feet depending on the chosen measurement system. |
| Road element ownership.
|
| Road element is a part of a tunnel.
|
| Road element is a part of an urban area.
|
| Information about the road element's height. |
| Information about traffic signs along the traveled road. |
| Position of a traffic light on the route segment.
|
| It represents the algorithm's confidence for the given road element. It's a float from the range (0,1]. |
Structure of the FerryAddress object | |
---|---|
Field | Description |
| Road name in NGT format. |
| The list of road numbers. |
Structure of the RoadAddress object | |
---|---|
Field | Description |
| Road name in NGT format. |
| The list of road numbers. |
| City name in NGT format. |
| Country name in NGT format. |
| |
| State or province name in NGT format. |
Structure of the MaximumDimension object | |
---|---|
Field | Description |
| Maximum height of a vehicle. |
| Maximum length of a vehicle. |
| Maximum width of a vehicle. |
| Maximum weight of a vehicle. |
| Maximum weight per axle. |
Structure of the Dimension object | |
---|---|
Field | Description |
| Value of dimension. |
| Unit of dimension value. |
Structure of the LaneInfo object | |
---|---|
Field | Description |
| Number of lanes the road segment has. |
Structure of the SpeedLimit object | |
---|---|
Field | Description |
| Value of the speed limit. |
| Unit of the speed limit. |
| Type of the speed limit.
|
Structure of the Distance object | |
---|---|
Field | Description |
| Value of the driven distance. |
| Unit of the distance. |
Structure of the Distances object | |
---|---|
Field | Description |
| Total traveled distance in meters or feet depending on the chosen measurement system. |
| The traveled distance on a ferry in meters or feet depending on the chosen measurement system. |
| Traveled distance within the road segment in meters or feet depending on the chosen measurement system. |
| Traveled distance within the private road segment in meters or feet depending on the chosen measurement system. |
| Traveled distance within the public road segment in meters or feet depending on the chosen measurement system. |
| Traveled distance out of the road segment in meters or feet depending on the chosen measurement system. |
| Unit of distances. |
Structure of the HeightInfo object | |
---|---|
Field | Description |
| Represents the height of a road above a reference geoid EGM2008 at a specified location. Expressed in cm or feet depending on the measurement system. |
| Represents the distance along a Road Element measured from a fixed reference point. Expressed in cm or feet depending on the measurement system. |
| Unit of the chainage. |
Structure of the TrafficSign object | |
---|---|
Field | Description |
| Information about the type of the traffic sign. Currently, the service returns information about:
|
| Represents the distance between the starting point of travel on the route segment and the traffic sign. Expressed in cm or feet depending on the measurement system. |
| Unit of the chainage. |
Successful response examples
Example response (only speed limits) - JSON
1{2 "route": [3 {4 "properties": {5 "id": "88a7637c-db86-448c-aca9-b7d1f1b66ea0",6 "speedLimits": {7 "value": 70,8 "unit": "kmph",9 "type": "Maximum"10 }11 }12 },13 ...14 {15 "properties": {16 "id": "c23e417c-ac30-4764-9272-9909b7448f87",17 "speedLimits": {18 "value": 70,19 "unit": "kmph",20 "type": "Maximum"21 }22 }23 },24 {25 "properties": {26 "id": "cd03f919-c6c5-48ca-8c0f-130db62d77b7",27 "speedLimits": {28 "value": 70,29 "unit": "kmph",30 "type": "Maximum"31 }32 }33 },34 {35 "properties": {36 "id": "bc4a05a8-5340-49e4-82fb-a8abba07a8a6",37 "speedLimits": {38 "value": 70,39 "unit": "kmph",40 "type": "Maximum"41 }42 }43 }44 ]45}
Example response (projected points and road elements with geometry, speed limits, and IDs) - JSON
1{2 "route": [3 {4 "type": "Feature",5 "geometry": {6 "type": "LineString",7 "coordinates": [[4.6109198034,52.3757167161],[4.6109291911,52.3757502437],[4.6110069752,52.3759138584],[4.6110418439,52.3759916425],[4.6110659838,52.3760412633]]8 },9 "properties": {10 "id": "88a7637c-db86-448c-aca9-b7d1f1b66ea0",11 "speedLimits": {12 "value": 70,13 "unit": "kmph",14 "type": "Maximum"15 }16 }17 },18 ...19 {20 "type": "Feature",21 "geometry": {22 "type": "LineString",23 "coordinates": [[4.6134424210,52.3791351914],[4.6134652197,52.3791633546],[4.6137334406,52.3795053363],[4.6138648689,52.3796957731],[4.6139051020,52.3797588050]]24 },25 "properties": {26 "id": "c23e417c-ac30-4764-9272-9909b7448f87",27 "speedLimits": {28 "value": 70,29 "unit": "kmph",30 "type": "Maximum"31 }32 }33 },34 {35 "type": "Feature",36 "geometry": {37 "type": "LineString",38 "coordinates": [[4.6139051020,52.3797588050],[4.6140727401,52.3800149560],[4.6141116321,52.3800887167]]39 },40 "properties": {41 "id":"cd03f919-c6c5-48ca-8c0f-130db62d77b7",42 "speedLimits": {43 "value": 70,44 "unit": "kmph",45 "type": "Maximum"46 }47 }48 },49 {50 "type": "Feature",51 "geometry": {52 "type": "LineString",53 "coordinates": [[4.6141116321,52.3800887167],[4.6141947806,52.3802402616]]54 },55 "properties": {56 "id":"bc4a05a8-5340-49e4-82fb-a8abba07a8a6",57 "speedLimits": {58 "value": 70,59 "unit": "kmph",60 "type": "Maximum"61 }62 }63 }64 ],65 "projectedPoints": [66 {67 "type": "Feature",68 "geometry": {69 "type": "Point",70 "coordinates": [4.6109191758,52.3757173113]71 },72 "properties": {73 "routeIndex": 0,74 "snapResult": "Matched"75 }76 },77 {78 "type": "Feature",79 "geometry": {80 "type": "Point",81 "coordinates": [4.6147588418,52.3834214472]82 },83 "properties": {84 "routeIndex": 10,85 "snapResult": "Matched"86 }87 }88 ]89}
Example response (all possible data) - JSON
1{2 "route": [3 {4 "type": "Feature",5 "geometry": {6 "type": "LineString",7 "coordinates": [[4.6109198034,52.3757167161],[4.6109291911,52.3757502437],[4.6110069752,52.3759138584],[4.6110418439,52.3759916425],[4.6110659838,52.3760412633]]8 },9 "properties": {10 "id": "88a7637c-db86-448c-aca9-b7d1f1b66ea0",11 "speedLimits": {12 "value": 70,13 "unit": "kmph",14 "type": "Maximum"15 },16 "speedProfile": {17 "value": 70,18 "unit": "kmph"19 },20 "address": {21 "roadName": "Westelijke Randweg",22 "roadNumbers": ["N208"],23 "municipality": "Haarlem",24 "countryName": "Nederland",25 "countryCode": "NLD",26 "countrySubdivision": "Noord-Holland"27 },28 "maximumDimensions":{29 "height": {30 "value":4,31 "unit":"m"32 },33 "length": {34 "value":10,35 "unit":"m"36 },37 "width": {38 "value":4,39 "unit":"m"40 },41 "totalWeight": {42 "value":6,43 "unit":"t"44 },45 "weightPerAxle": {46 "value":1.5,47 "unit":"t"48 }49 },50 "traveledDistance": {51 "value": 123,52 "unit": "m"53 },54 "privateRoad": false,55 "partOfTunnel": false,56 "urbanArea": true,57 "elementType": "Road",58 "frc": 2,59 "formOfWay": "DualCarriageway",60 "roadUse": "Arterial",61 "laneInfo": {62 "numberOfLanes": 263 },64 "heightInfo":[65 {66 "height":394,67 "chainage":0,68 "unit": "cm"69 },70 {71 "height":1575,72 "chainage":197,73 "unit": "cm"74 },75 {76 "height":2756,77 "chainage":315,78 "unit": "cm"79 }80 ],81 "trafficSigns":[82 {83 "signType": "StopSign",84 "chainage": 329,85 "unit": "cm"86 }87 ],88 "trafficLight": "Start",89 "confidence": 0.6790 }91 },92 ...93 {94 "type": "Feature",95 "geometry": {96 "type": "LineString",97 "coordinates": [[4.6134424210,52.3791351914],[4.6134652197,52.3791633546],[4.6137334406,52.3795053363],[4.6138648689,52.3796957731],[4.6139051020,52.3797588050]]98 },99 "properties": {100 "id": "c23e417c-ac30-4764-9272-9909b7448f87",101 "speedLimits": {102 "value": 70,103 "unit": "kmph",104 "type": "Maximum"105 },106 "speedProfile": {107 "value": 70,108 "unit": "kmph"109 },110 "address": {111 "roadName": "Westelijke Randweg",112 "roadNumbers": ["N208"],113 "municipality": "Haarlem",114 "countryName": "Nederland",115 "countryCode": "NLD",116 "countrySubdivision": "Noord-Holland"117 },118 "maximumDimensions":{119 "height": {120 "value":4,121 "unit":"m",122 },123 "length": {124 "value":10,125 "unit":"m",126 },127 "width": {128 "value":4,129 "unit":"m",130 },131 "totalWeight": {132 "value":6,133 "unit":"t"134 },135 "weightPerAxle": {136 "value":1.5,137 "unit":"t",138 }139 },140 "traveledDistance": {141 "value": 321,142 "unit": "m"143 },144 "privateRoad": false,145 "partOfTunnel": false,146 "urbanArea": false,147 "elementType": "Road",148 "frc": 2,149 "formOfWay": "DualCarriageway",150 "roadUse": "Arterial",151 "laneInfo": {152 "numberOfLanes": 4153 },154 "heightInfo":[155 {156 "height": 252,157 "chainage": 0,158 "unit": "cm"159 },160 {161 "height": 678,162 "chainage": 211,163 "unit": "cm"164 }165 ],166 "trafficSigns":[167 {168 "signType": "StopSign",169 "chainage": 678,170 "unit": "cm"171 }172 ],173 "trafficLight": "Both",174 "confidence": 0.87175 }176 },177 {178 "type": "Feature",179 "geometry": {180 "type": "LineString",181 "coordinates": [[4.6139051020,52.3797588050],[4.6140727401,52.3800149560],[4.6141116321,52.3800887167]]182 },183 "properties": {184 "id": "cd03f919-c6c5-48ca-8c0f-130db62d77b7",185 "speedLimits": {186 "value": 70,187 "unit": "kmph",188 "type": "Maximum"189 },190 "speedProfile": {191 "value" : 70,192 "unit": "kmph"193 },194 "address": {195 "roadName": "Westelijke Randweg",196 "roadNumbers": ["N208"],197 "municipality": "Haarlem",198 "countryName": "Nederland",199 "countryCode": "NLD",200 "countrySubdivision": "Noord-Holland"201 },202 "maximumDimensions": {203 "height:" {204 "value":4,205 "unit":"m"206 },207 "length": {208 "value":10,209 "unit":"m"210 },211 "width": {212 "value":4,213 "unit":"m"214 },215 "totalWeight": null,216 "weightPerAxle":null217 },218 "traveledDistance": {219 "value": 456,220 "unit": "m"221 },222 "privateRoad": false,223 "partOfTunnel": false,224 "urbanArea": false,225 "elementType": "Road",226 "frc": 2,