Map Matching feature specification

The Map Matching API result feature is a feature of MultiLineString type. The geometry of the feature contains the route and the properties contain route details.

Feature properties

The feature properties contain information about the route:

Name Description
distance Distance in meters for the whole route
time Time in seconds for the whole route
mode Requested transportation or travel mode
waypoints An array of MatchedWaypoint
legs An array of RouteLeg. Each leg represents separate parts of the route.

MatchedWaypoint

Contains information about an original waypoint and matched location.

Name Description
original_index Original index of the waypoint in request
location Matched location. An array of the coordinates: [lon, lat]
original_location Original location. An array of the coordinates: [lon, lat]
match_type Matched type. Possible values: matched, unmatched, interpolated
match_distance Distance in meters between matched and original locations
leg_index Leg index, the waypoint belongs to
step_index Step point, the waypoint belongs to

RouteLeg

Contains information about a route between 2 locations.

Name Description
distance Length of the route in meters
time Time in seconds for the route
steps An array of LegStep. Steps of the route

LegStep

Contains information about a step or segment of a RouteLeg:

Name Description
name Route step name. Usually a street name
road_class Road class. Possible values: unclassified, motorway, trunk, primary, secondary, tertiary, unclassified, residential, service_other
surface Type of surface. Possible values: paved_smooth, paved, paved_rough, compacted, dirt, gravel, path, impassable
traversability Traversability of the road segment. Possible values: forward, backward, both
speed Actual (calculated) speed
speed_limit Speed limit for the road segment
lane_count Number of lanes
time Time in seconds required to pass the road segment
distance Length of the route segment in meters
begin_bearing Starting bearing
end_bearing Final bearing
from_index An index of the starting point for the segment in the corresponding feature coordinates array
to_index An index of the end point for the segment in the corresponding feature coordinates array