Mapping API

Our Mapping API offers the capability to conflate your internal or 3rd party road network to the Geo Location Platform road network. The Geo Location Platform can process data from any map or location data source, so interoperability is guaranteed. This enables you to decode the output of the Geo Location Platform APIs into your road network identifiers, which makes the API output usable for further processing inside your system. You can also map a set of geo-positions with headings to the most probable links (with offset) in the Geo Location Platform's road network. The Geo Location Platform's road network is sourced from Open Street Map. The returned road network link identifier is derived from the OSM identifier, however, is not the original OSM identifier. Once an OSM identifier changes, the road network link identifier changes as well.

Following endpoints can be used

MapPoint - For mapping list of single points
MapPolylines - For mapping poly-lines

You want to know what's new? See API changelog

Get started!

MapPoint

Mapping of list with single points.

URL address: https://api.geo-location-platform.com/roadnetwork/europe/v1/mapPoint
HTTP method: POST
Endpoint requires authentication. API_KEY needs to be provided to you by Kapsch TrafficCom. Please contact us for API usage conditions and to acquire your API_KEY. Usage of 'demo' API_KEY in examples on this page is not allowed for your productive systems.

Options:

URL parameter "includeShape" - Returns the geometry of the link if TRUE (default is FALSE)

NOTE: For accessing this endpoint you need an account, please contact us.

Request example

Use HTTP POST method https://api.geo-location-platform.com/roadnetwork/europe/v1/mapPoint
and send below request body.

JSON request details:

"mappingRadius" - Radius of how far around the point should be searched (in meters)
"points" - Array of points

"customId" - Custom ID (this will be returned in response)
"point" - Consist of "lat" (latitude) and "lon" (longitude)
"heading" - Heading of the point in degrees
"maxAngle" - Maximum angle (optional)
"linkClassHint" - Hint for link class (optional)
"linkReferenceHint" - Hint for link reference (optional)
"linkNameHint" - Hint for link name (optional)

Response example

{ "points": [ { "customId": "1-001", "mappedLinkId": 1153291593728, "mappedLinkOffset": 0.5963993, "confidence": 0, "mappedPoint": { "lat": 42.636074, "lon": 23.42553 }, "shape": { "type": "LineString", "coordinates": [ [ 23.424765, 42.63617 ], [ 23.425356, 42.636097 ], [ 23.426048, 42.63601 ] ] } } ] }

JSON response details:

"points" - Array of points

"customId" - Yor custom ID that was specified in the request
"mappedLinkId" - Id of the mapped link
"mappedLinkOffset" - Offset from starting point of the link (0 to 1)
"confidence" - Level of mapping confidence (0 to 1) - Currently always 0
"mappedPoint" - Consist of "lat" (latitude) and "lon" (longitude) and represents a mapped point
"shape" - Shape of the mapped link (returned only if "includeShape" parameter is set to TRUE)

"type" - Always "LineString"
"coordinates" - Array of "lat" (latitude) and "lon" (longitude) coordinates and represents a shape of the whole link

MapPolyline

Map list of polylines. Each polyline should contain at least two points.

URL address: https://api.geo-location-platform.com/roadnetwork/europe/v1/mapPolyline
HTTP method: POST
Endpoint requires authentication. API_KEY needs to be provided to you by Kapsch TrafficCom. Please contact us for API usage conditions and to acquire your API_KEY. Usage of 'demo' API_KEY in examples on this page is not allowed for your productive systems.

Options:

URL parameter "includeShape" - Returns the geometry of the link if TRUE (default is FALSE)

NOTE: For accessing this endpoint you need an account, please contact us.

Request example

Use HTTP POST method https://api.geo-location-platform.com/roadnetwork/europe/v1/mapPolyline
and send below request body.

JSON request details:

"snapToNodeDistance" - Distance when snaping to node (in meters)
"minSearchRadius" - Minimal radius for searching (in meters)
"polylines" - Array of polylines

"customId" - Custom ID (this will be returned in response)
"points" - Array of "lat" (latitude) and "lon" (longitude) coordinates that represent a polyline. (Minimal 2)
"linkClassHint" - Hint for link class (optional)
"linkReferenceHint" - Hint for link reference (optional)
"linkNameHint" - Hint for link name (optional)

Response example

{ "polylines": [ { "customId": "1-001", "confidence": 0.84850484, "warningCode": 0, "totalLength": 182.26245, "startOffset": 0.9235913, "endOffset": 0.37786368, "links": [ { "id": 56985995267, "length": 977.1671, "confidence": 0.85, "shape": { "type": "LineString", "coordinates": [ [ 25.562141, 43.086826 ], [ 25.561687, 43.086903 ], [ 25.56128, 43.086967 ], [ 25.560156, 43.087112 ], [ 25.55899, 43.08723 ], [ 25.557907, 43.08729 ], [ 25.556583, 43.08732 ], [ 25.55538, 43.0873 ], [ 25.554342, 43.087257 ], [ 25.552654, 43.08719 ], [ 25.551373, 43.087082 ], [ 25.550177, 43.087036 ] ] } }, { "id": 56985995268, "length": 12.088961, "confidence": 0.85, "shape": { "type": "LineString", "coordinates": [ [ 25.550177, 43.087036 ], [ 25.550028, 43.08704 ] ] } }, { "id": 56985995269, "length": 4.3369546, "confidence": 0.85, "shape": { "type": "LineString", "coordinates": [ [ 25.550028, 43.08704 ], [ 25.549974, 43.08704 ] ] } }, { "id": 1378314627072, "length": 30.434158, "confidence": 0.85, "shape": { "type": "LineString", "coordinates": [ [ 25.549974, 43.08704 ], [ 25.549894, 43.086956 ], [ 25.549847, 43.08689 ], [ 25.549788, 43.086803 ] ] } }, { "id": 321123196929, "length": 160.74135, "confidence": 0.85, "shape": { "type": "LineString", "coordinates": [ [ 25.549788, 43.086803 ], [ 25.549631, 43.086693 ], [ 25.549097, 43.086365 ], [ 25.548296, 43.085854 ] ] } } ] } ] }

JSON response details:

"polylines" - Array of polylines

"confidence" - Level of confidence of mapping (0.00 to 1.00)
"customId" - Custom ID that was specified in the request
"startOffset" - Start offset on the first link (0 to 1)
"endOffset" - End offset on the last link (0 to 1)
"totalLength" - Total length (in meters)
"warningCode" - Warning code that gives you hints about the confidence
"links" - Array of links

"id" - Unique id of link (if negative the link is reversed)
"confidence" - Confidence of mapping for this link (0.00 to 1.00)
"length" - Length of the link (in meters)
"shape" - Shape of the mapped link (returned only if "includeShape" parameter is set to TRUE)

"type" - Always "LineString"
"coordinates" - Array of "lat" (latitude) and "lon" (longitude) coordinates and represents a shape of the whole link