Skip to content
TarekyDocs
Console

Public API: snap a GPS trace to the road network (metered)

GET
/v1/match/{profile}/{coordinates}
curl --request GET \
  --url 'https://api.tareky.com/v1/match/driving/example?steps=true&geometries=polyline&overview=simplified&continue_straight=default&roundtrip=true&source=any&destination=any&gaps=split&tidy=true' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
profile
required
string
Allowed values: driving walking
coordinates
required
string

Query Parameters

Section titled “Query Parameters”
alternatives
string

True, false, or a number of alternatives (directions)

steps
string
Allowed values: true false

Turn-by-turn steps (directions, match, optimize)

geometries
string
Allowed values: polyline polyline6 geojson
overview
string
Allowed values: simplified full false
annotations
string

True, or a comma list of duration,distance,speed,nodes

continue_straight
string
Allowed values: default true false
bearings
string

{bearing},{range};… one per coordinate

approaches
string

Curb or unrestricted, ; separated

exclude
string

E.g. motorway, toll, ferry

sources
string

Matrix: indexes of the origin coordinates, ; separated

destinations
string

Matrix: indexes of the destination coordinates

roundtrip
string
Allowed values: true false

Optimize

source
string
Allowed values: any first

Optimize

destination
string
Allowed values: any last

Optimize

timestamps
string

Unix seconds per coordinate, ; separated

gaps
string
Allowed values: split ignore
tidy
string
Allowed values: true false
radiuses
string

Header Parameters

Section titled “Header Parameters”
x-access-key-id
string

Legacy key id (until its sunset)

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
code
required

“Ok” on success

string
matchings
required
Array<object>
object
distance
required
number
duration
required
number
geometry

Encoded polyline or GeoJSON, per geometries; omitted with overview=false

weight
number
weight_name
string
legs
required
Array<object>
object
distance
required
number
duration
required
number
summary
string
steps
required

Empty unless steps=true

Array<object>
object
key
additional properties
key
additional properties
confidence
required
number
key
additional properties
tracepoints
required
Array<object>
object
name
required

Name of the street the coordinate snapped to

string
location
required

[lng, lat]

array
>= 2 items <= 2 items
distance
required

Metres from the input coordinate to the snapped one

number
hint

Omitted with generate_hints=false

string
matchings_index
required
integer
>= -9007199254740991 <= 9007199254740991
waypoint_index
required
integer
>= -9007199254740991 <= 9007199254740991
alternatives_count
required
integer
>= -9007199254740991 <= 9007199254740991
key
additional properties
key
additional properties
any
Examplegenerated
{
  "code": "example",
  "matchings": [
    {
      "distance": 1,
      "duration": 1,
      "geometry": "example",
      "weight": 1,
      "weight_name": "example",
      "legs": [
        {
          "distance": 1,
          "duration": 1,
          "summary": "example",
          "steps": [
            {
              "additionalProperty": "example"
            }
          ]
        }
      ],
      "confidence": 1
    }
  ],
  "tracepoints": [
    {
      "name": "example",
      "location": [
        "example"
      ],
      "distance": 1,
      "hint": "example",
      "matchings_index": 1,
      "waypoint_index": 1,
      "alternatives_count": 1
    }
  ]
}

429

Section titled “429”

Rate limit or monthly quota exceeded; see Retry-After

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable code, e.g. quota_exceeded, no_route

string
message
required
string
status
required
integer
>= -9007199254740991 <= 9007199254740991
details

For invalid_request: the validation issues

docsUrl
required
string
requestId
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "status": 1,
    "details": "example",
    "docsUrl": "example"
  },
  "requestId": "example"
}

default

Section titled “default”

Any other error, in the /v1 error envelope

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable code, e.g. quota_exceeded, no_route

string
message
required
string
status
required
integer
>= -9007199254740991 <= 9007199254740991
details

For invalid_request: the validation issues

docsUrl
required
string
requestId
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "status": 1,
    "details": "example",
    "docsUrl": "example"
  },
  "requestId": "example"
}