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

Latest commit

 

History

History
80 lines (61 loc) · 5.21 KB

ReverseApi.md

File metadata and controls

80 lines (61 loc) · 5.21 KB

ReverseApi

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

Method HTTP request Description
Reverse GET /reverse.php Reverse Geocoding

Reverse

Location Reverse(lat, lon, format, normalizecity, addressdetails=1, accept.language=var.accept.language, namedetails=var.namedetails, extratags=var.extratags, statecode=var.statecode, showdistance=var.showdistance, postaladdress=var.postaladdress)

Reverse Geocoding

Reverse geocoding is the process of converting a coordinate or location (latitude, longitude) to a readable address or place name. This permits the identification of nearby street addresses, places, and/or area subdivisions such as a neighborhood, county, state, or country.

Example

library(locationiq)

var.lat <- 40.7487727 # numeric | Latitude of the location to generate an address for.
var.lon <- -73.9849336 # numeric | Longitude of the location to generate an address for.
var.format <- 'json' # character | Format to geocode. Only JSON supported for SDKs
var.normalizecity <- 1 # integer | Normalizes village to city level data to city
var.addressdetails <- 1 # integer | Include a breakdown of the address into elements. Defaults to 1.
var.accept.language <- 'en' # character | Preferred language order for showing search results, overrides the value specified in the Accept-Language HTTP header. Defaults to en. To use native language for the response when available, use accept-language=native
var.namedetails <- 0 # integer | Include a list of alternative names in the results. These may include language variants, references, operator and brand.
var.extratags <- 0 # integer | Include additional information in the result if available, e.g. wikipedia link, opening hours.
var.statecode <- 0 # integer | Adds state or province code when available to the statecode key inside the address element. Currently supported for addresses in the USA, Canada and Australia. Defaults to 0
var.showdistance <- 0 # integer | Returns the straight line distance (meters) between the input location and the result's location. Value is set in the distance key of the response. Defaults to 0 [0,1]
var.postaladdress <- 0 # integer | Returns address inside the postaladdress key, that is specifically formatted for each country. Currently supported for addresses in Germany. Defaults to 0 [0,1]

#Reverse Geocoding
api.instance <- ReverseApi$new()
# Configure API key authorization: key
api.instance$apiClient$apiKeys['key'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$Reverse(var.lat, var.lon, var.format, var.normalizecity, addressdetails=var.addressdetails, accept.language=var.accept.language, namedetails=var.namedetails, extratags=var.extratags, statecode=var.statecode, showdistance=var.showdistance, postaladdress=var.postaladdress)
dput(result)

Parameters

Name Type Description Notes
lat numeric Latitude of the location to generate an address for.
lon numeric Longitude of the location to generate an address for.
format Enum [json] Format to geocode. Only JSON supported for SDKs
normalizecity Enum [1] Normalizes village to city level data to city
addressdetails Enum [0, 1] Include a breakdown of the address into elements. Defaults to 1. [optional] [default to 1]
accept.language character Preferred language order for showing search results, overrides the value specified in the Accept-Language HTTP header. Defaults to en. To use native language for the response when available, use accept-language=native [optional]
namedetails Enum [0, 1] Include a list of alternative names in the results. These may include language variants, references, operator and brand. [optional]
extratags Enum [0, 1] Include additional information in the result if available, e.g. wikipedia link, opening hours. [optional]
statecode Enum [0, 1] Adds state or province code when available to the statecode key inside the address element. Currently supported for addresses in the USA, Canada and Australia. Defaults to 0 [optional]
showdistance integer Returns the straight line distance (meters) between the input location and the result's location. Value is set in the distance key of the response. Defaults to 0 [0,1] [optional]
postaladdress integer Returns address inside the postaladdress key, that is specifically formatted for each country. Currently supported for addresses in Germany. Defaults to 0 [0,1] [optional]

Return type

Location

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 -