All URIs are relative to https://eu1.locationiq.com/v1
| Method | HTTP request | Description |
|---|---|---|
| directions | GET /directions/driving/{coordinates} | Directions Service |
DirectionsDirections directions(coordinates, opts)
Directions Service
Finds the fastest route between coordinates in the supplied order.
# 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::DirectionsApi.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 = {
bearings: '10,20;40,30;30,9', # 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: '500;200;300', # 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)
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.
alternatives: 0, # Float | Search for alternative routes. Passing a number alternatives=n searches for up to n alternative routes. [ true, false (default), or Number ]
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 ]
continue_straight: 'default' # String | Forces the route to keep going straight at waypoints constraining uturns there even if it would be faster. Default value depends on the profile [ default (default), true, false ]
}
begin
#Directions Service
result = api_instance.directions(coordinates, opts)
p result
rescue LocationIQClient::ApiError => e
puts "Exception when calling DirectionsApi->directions: #{e}"
end| 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 | |
| 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] |
| 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] |
| alternatives | Float | Search for alternative routes. Passing a number alternatives=n searches for up to n alternative routes. [ true, false (default), or Number ] | [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"'] |
| continue_straight | String | Forces the route to keep going straight at waypoints constraining uturns there even if it would be faster. Default value depends on the profile [ default (default), true, false ] | [optional] [default to '"default"'] |
- Content-Type: Not defined
- Accept: application/json