docs/NearestApi.md

In location-iq/locationiq-r-client: R Package Client for LocationIQ

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, generate.hints=var.generate.hints, exclude=var.exclude, bearings=var.bearings, radiuses=var.radiuses, approaches=var.approaches, number=var.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

library(locationiq)

var.coordinates <- '-0.16102,51.523854' # character | String of format {longitude},{latitude};{longitude},{latitude}[;{longitude},{latitude} ...] or polyline({polyline}) or polyline6({polyline6}). polyline follows Google's polyline format with precision 5
var.generate.hints <- 'false' # character | Adds a Hint to the response which can be used in subsequent requests, see hints parameter. Input Value - true (default), false Format - Base64 String
var.exclude <- 'toll' # character | Additive list of classes to avoid, order does not matter. input Value - {class}[,{class}] Format - A class name determined by the profile or none.
var.bearings <- '10,20' # character | 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
var.radiuses <- '1000' # character | 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)
var.approaches <- 'curb' # character | Keep waypoints on curb side. Input Value - {approach};{approach}[;{approach} ...] Format - curb or unrestricted (default)
var.number <- 3 # integer | Number of nearest segments that should be returned. [ integer >= 1 (default 1) ]

#Nearest Service
api.instance <- NearestApi$new()
# Configure API key authorization: key
api.instance$apiClient$apiKeys['key'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$Nearest(var.coordinates, generate.hints=var.generate.hints, exclude=var.exclude, bearings=var.bearings, radiuses=var.radiuses, approaches=var.approaches, number=var.number)
dput(result)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- coordinates | character| 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 | character| 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 | character| 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 | character| 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 | character| 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 | character| Keep waypoints on curb side. Input Value - {approach};{approach}[;{approach} ...] Format - curb or unrestricted (default) | [optional] number | integer| 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

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | OK | - | | 400 | Bad Request | - | | 401 | Unauthorized | - | | 403 | The request has been made from an unauthorized domain. | - | | 404 | No location or places were found for the given input | - | | 429 | Request exceeded the rate-limits set on your account | - | | 500 | Internal Server Error | - |

location-iq/locationiq-r-client documentation built on Feb. 28, 2020, 9:42 p.m.