R/geocoding_reverse.R

In s-Nick-s/traveltimeR: R Interface to Travel Time

#' Reverse Geocoding
#'
#' Attempt to match a latitude, longitude pair to an address.
#'
#' See \url{https://traveltime.com/docs/api/reference/geocoding-reverse} for details
#'
#' @param lat Latitude of the point to reverse geocode.
#' @param lng Longitude of the point to reverse geocode.
#' @inheritParams geocoding
#'
#' @return API response parsed as list and as a raw json
#' @export
#'
#' @examples \dontrun{
#' geocoding_reverse(lat=51.507281, lng=-0.132120)
#' }
geocoding_reverse <- function(lat, lng, within.country = NA, exclude.location.types = NA) {

  queryFull <- c(lat = lat,
                 lng = lng,
                 within.country = within.country,
                 exclude.location.types = exclude.location.types)

  traveltime_api(path = c('geocoding', 'reverse'), query = as.list(queryFull)[!is.na(queryFull)])
}