NearestApi.md

LocationIq::NearestApi

Load the API package

use LocationIq::Object::NearestApi;

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

Method	HTTP request	Description
nearest	GET /nearest/driving/{coordinates}	Nearest Service

nearest

DirectionsNearest nearest(coordinates => $coordinates, generate_hints => $generate_hints, exclude => $exclude, bearings => $bearings, radiuses => $radiuses, approaches => $approaches, number => $number)

Nearest Service

Snaps a coordinate to the street network and returns the nearest n matches. Where coordinates only supports a single {longitude},{latitude} entry.

Example

use Data::Dumper;
use LocationIq::NearestApi;
my $api_instance = LocationIq::NearestApi->new(

    # Configure API key authorization: key
    api_key => {'key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'key' => 'Bearer'},
);

my $coordinates = "-0.16102,51.523854"; # 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
my $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
my $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.
my $bearings = "10,20"; # 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
my $radiuses = "1000"; # 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)
my $approaches = "curb"; # string | Keep waypoints on curb side. Input Value - {approach};{approach}[;{approach} ...] Format - curb or unrestricted (default)
my $number = 3; # int | Number of nearest segments that should be returned. [ integer >= 1 (default 1) ]

eval { 
    my $result = $api_instance->nearest(coordinates => $coordinates, generate_hints => $generate_hints, exclude => $exclude, bearings => $bearings, radiuses => $radiuses, approaches => $approaches, number => $number);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NearestApi->nearest: $@\n";
}

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]
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]
approaches	string	Keep waypoints on curb side. Input Value - {approach};{approach}[;{approach} ...] Format - curb or unrestricted (default)	[optional]
number	int	Number of nearest segments that should be returned. [ integer >= 1 (default 1) ]	[optional]

Return type

DirectionsNearest

Authorization

key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]