Skip to content
This repository has been archived by the owner on Nov 21, 2024. It is now read-only.

Latest commit

 

History

History
91 lines (69 loc) · 7.48 KB

MatchingApi.md

File metadata and controls

91 lines (69 loc) · 7.48 KB
Raw

LocationIQClient::MatchingApi

All URIs are relative to https://eu1.locationiq.com/v1

Method HTTP request Description
matching GET /matching/driving/{coordinates} Matching Service

matching

DirectionsMatching matching(coordinates, opts)

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.

Example

# load the gem
require 'locationiq-ruby-client'
# setup authorization
LocationIQClient.configure do |config|
  # Configure API key authorization: key
  config.api_key['key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['key'] = 'Bearer'
end

api_instance = LocationIQClient::MatchingApi.new
coordinates = '-0.16102,51.523854;-0.15797,51.52326;-0.161593,51.522550' # String | String of format {longitude},{latitude};{longitude},{latitude}[;{longitude},{latitude} ...] or polyline({polyline}) or polyline6({polyline6}). polyline follows Google's polyline format with precision 5
opts = {
  generate_hints: 'false', # String | Adds a Hint to the response which can be used in subsequent requests, see hints parameter. Input Value - true (default), false Format - Base64 String
  approaches: 'curb;curb;curb', # String | Keep waypoints on curb side. Input Value - {approach};{approach}[;{approach} ...] Format - curb or unrestricted (default)
  exclude: 'toll', # String | Additive list of classes to avoid, order does not matter. input Value - {class}[,{class}] Format - A class name determined by the profile or none.
  bearings: 'None', # 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. Input Value :- {bearing};{bearing}[;{bearing} ...] Bearing follows the following format : bearing {value},{range} integer 0 .. 360,integer 0 .. 180
  radiuses: 'None', # String | Limits the search to given radius in meters Radiuses array length should be same as coordinates array, eaach value separated by semi-colon. Input Value - {radius};{radius}[;{radius} ...] Radius has following format :- double >= 0 or unlimited (default)
  steps: 'true', # String | Returned route steps for each route leg [ true, false (default) ]
  annotations: 'false', # String | Returns additional metadata for each coordinate along the route geometry.  [ true, false (default), nodes, distance, duration, datasources, weight, speed ]
  geometries: 'polyline', # String | Returned route geometry format (influences overview and per step) [ polyline (default), polyline6, geojson ]
  overview: 'simplified', # String | Add overview geometry either full, simplified according to highest zoom level it could be display on, or not at all. [ simplified (default), full, false ]
  timestamps: '200;300;900', # String | Timestamps for the input locations in seconds since UNIX epoch. Timestamps need to be monotonically increasing. [ {timestamp};{timestamp}[;{timestamp} ...]  integer seconds since UNIX epoch
  gaps: 'split', # String | Allows the input track splitting based on huge timestamp gaps between points. [ split (default), ignore ]
  tidy: 'false', # String | Allows the input track modification to obtain better matching quality for noisy tracks. [ true, false (default) ]
  waypoints: '0;1;2' # 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}... ]
}

begin
  #Matching Service
  result = api_instance.matching(coordinates, opts)
  p result
rescue LocationIQClient::ApiError => e
  puts "Exception when calling MatchingApi->matching: #{e}"
end

Parameters

Name Type Description Notes
coordinates String String of format {longitude},{latitude};{longitude},{latitude}[;{longitude},{latitude} ...] or polyline({polyline}) or polyline6({polyline6}). polyline follows Google's polyline format with precision 5
generate_hints String Adds a Hint to the response which can be used in subsequent requests, see hints parameter. Input Value - true (default), false Format - Base64 String [optional]
approaches String Keep waypoints on curb side. Input Value - {approach};{approach}[;{approach} ...] Format - curb or unrestricted (default) [optional]
exclude String Additive list of classes to avoid, order does not matter. input Value - {class}[,{class}] Format - A class name determined by the profile or none. [optional]
bearings 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. Input Value :- {bearing};{bearing}[;{bearing} ...] Bearing follows the following format : bearing {value},{range} integer 0 .. 360,integer 0 .. 180 [optional]
radiuses String Limits the search to given radius in meters Radiuses array length should be same as coordinates array, eaach value separated by semi-colon. Input Value - {radius};{radius}[;{radius} ...] Radius has following format :- double >= 0 or unlimited (default) [optional]
steps String Returned route steps for each route leg [ true, false (default) ] [optional]
annotations String Returns additional metadata for each coordinate along the route geometry. [ true, false (default), nodes, distance, duration, datasources, weight, speed ] [optional] [default to '"false"']
geometries String Returned route geometry format (influences overview and per step) [ polyline (default), polyline6, geojson ] [optional] [default to '"polyline"']
overview String Add overview geometry either full, simplified according to highest zoom level it could be display on, or not at all. [ simplified (default), full, false ] [optional] [default to '"simplified"']
timestamps String Timestamps for the input locations in seconds since UNIX epoch. Timestamps need to be monotonically increasing. [ {timestamp};{timestamp}[;{timestamp} ...] integer seconds since UNIX epoch [optional]
gaps String Allows the input track splitting based on huge timestamp gaps between points. [ split (default), ignore ] [optional] [default to '"split"']
tidy String Allows the input track modification to obtain better matching quality for noisy tracks. [ true, false (default) ] [optional] [default to '"false"']
waypoints 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}... ] [optional]

Return type

DirectionsMatching

Authorization

key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json