Skip to content
Plaza Plaza Docs
GuidesPlaygroundDashboard
API Reference
Map Match

Match GPS coordinates to the road network

$ plaza map-match match
POST/api/v1/map-match

Match GPS coordinates to the road network

ParametersExpand Collapse
--trace: object { coordinates, type }

GPS trace (GeoJSON LineString geometry)

--radius: optional array of number

Search radius per coordinate in meters (optional, default 50)

ReturnsExpand Collapse
map_match_result: object { geometry, properties, type, legs }

Map matching result with snapped geometry

geometry: object { coordinates, type }
coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number

GeoJSON coordinates array (nesting depth varies by geometry type)

union_member_0: array of number
union_member_1: array of array of number
union_member_2: array of array of array of number
union_member_3: array of array of array of array of number
type: "Point" or "LineString" or "Polygon" or 3 more
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
properties: object { confidence, distance, duration }
confidence: optional number

Match confidence score

distance: optional number

Total matched distance in meters

duration: optional number

Estimated duration in seconds

type: "Feature"
"Feature"
legs: optional array of map[unknown]

Matched route legs between consecutive trace points

Match GPS coordinates to the road network

plaza map-match match \
  --api-key 'My API Key' \
  --trace '{coordinates: [0], type: Point}'
Returns Examples