WebsiteDashboard
GuidesAPI Reference

Matching Service

Matching API matches or snaps given GPS points to the road network in the most plausible way. Please note the request might result multiple sub-traces. Large jumps in the timestamps (> 60s) or improbable transitions lead to trace splits if a complete matching could not be found. The algorithm might not be able to match all points. Outliers are removed if they can not be matched successfully.

GET
/matching/{profile}/{coordinates}

Authorization

stringRequired

LocationIQ Access Token

Path Parameters

stringRequired

Mode of transportation. driving and walking are supported.

Allowed:drivingwalking
stringRequired

String of format {longitude},{latitude};{longitude},{latitude}[;{longitude},{latitude} ...] or polyline({polyline}) or polyline6({polyline6}). You can send up to a maximum of 25 coordinate pairs per request (except Nearest API where coordinates only supports a single {longitude},{latitude} entry)

Query Parameters

string

Limits the search to segments with given bearing in degrees towards true north in clockwise direction. List of positive integer pairs separated by semi-colon and bearings array should be equal to length of coordinate array. Accepted Value :- {bearing};{bearing}[;{bearing} ...] Each {bearing} follows the following format: {value},{range} integer 0 .. 360,integer 0 .. 180

string

Limits the search to given radius in meters Radiuses array length should be same as coordinates array, each value separated by semi-colon. Accepted Value - {radius};{radius}[;{radius} ...] Each {radius} has following format: double >= 0 or unlimited (default)

string

Hint from previous request to derive position in street network. Accepted value: {hint};{hint}[;{hint} ...]

string

Returned route steps for each route leg. Accepted value: true, false (default)

stringDefaults to polyline

Returned route geometry format (influences overview and per step). Accepted value: polyline (default), polyline6, geojson

stringDefaults to false

Returns additional metadata for each coordinate along the route geometry. Accepted value: true, false (default), nodes, distance, duration, datasources, weight, speed

stringDefaults to simplified

Add overview geometry either full, simplified according to highest zoom level it could be display on, or not at all. Accepted value: simplified (default), full, false

string

'Timestamps for the input locations in seconds since UNIX epoch. Timestamps need to be monotonically increasing. Accepted value: {timestamp};{timestamp}[;{timestamp} ...] Each {timestamp} has the following format: integer seconds since UNIX epoch'

stringDefaults to split

Allows the input track splitting based on huge timestamp gaps between points. Accepted value: split (default), ignore

stringDefaults to false

Allows the input track modification to obtain better matching quality for noisy tracks. Accepted value: true, false (default).

string

Treats input coordinates indicated by given indices as waypoints in returned Match object. Default is to treat all input coordinates as waypoints. {index};{index};{index}... ]

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/matching/driving/string?bearings=10%2C20%3B40%2C30%3B30%2C9&radiuses=500%3B200%3B300&steps=true&geometries=polyline&annotations=false&overview=simplified&timestamps=200%3B300%3B900&gaps=ignore&tidy=false&waypoints=0%3B1%3B2"
{  "code": "ok",  "tracepoints": {    "waypoint_index": 0,    "matchings_index": 0,    "alternatives_count": 0,    "distance": 8.414822,    "location": [      -0.161136,      51.523832    ],    "name": "Huntsworth Mews"  },  "matchings": {    "duration": 109.3,    "distance": 752.4,    "weight": 109.3,    "geometry": "}fnyHbn^|@_@O_BeDlAw@}G~@uB@WXs@fE}Ab@OxBpU",    "confidence": 0,    "weight_name": "routability",    "legs": {      "steps": [],      "weight": 10.2,      "distance": 36.7,      "summary": "",      "duration": 10.2    }  }}