Address search API (structured query)

Searches for addresses already split into components and returns matching results as a tibble. Use geo_lite_struct_sf() to return an sf object instead.

This function performs the structured address search described in the API endpoint. To perform a free-form search, use geo_lite().

Usage

geo_lite_struct(
  amenity = NULL,
  street = NULL,
  city = NULL,
  county = NULL,
  state = NULL,
  country = NULL,
  postalcode = NULL,
  lat = "lat",
  long = "lon",
  limit = 1,
  full_results = FALSE,
  return_addresses = TRUE,
  verbose = FALSE,
  nominatim_server = "https://nominatim.openstreetmap.org/",
  custom_query = list()
)

Arguments

amenity: A string giving the name or type of amenity. See geo_amenity().
street: A string giving the house number and street name.
city: A string giving the city.
county: A string giving the county.
state: A string giving the state.
country: A string giving the country.
postalcode: A string giving the postal code.
lat: A string giving the name of the latitude column in the output. Defaults to "lat".
long: A string giving the name of the longitude column in the output. Defaults to "lon".
limit: A positive integer giving the maximum number of results to return per query. Nominatim returns at most 50 results per query.
full_results: If TRUE, return all available fields from the Nominatim API. If FALSE, return only query metadata, location data and requested address columns.
return_addresses: If TRUE, include single-line addresses in the results.
verbose: If TRUE, displays detailed messages in the console.
nominatim_server: A string giving the base URL of the Nominatim server. Defaults to "https://nominatim.openstreetmap.org/".
custom_query: A named list of additional API parameters, for example list(countrycodes = "US"). See Details.

Value

A tibble with the results that match the query.

Details

A structured address search accepts an address already split into components. Each argument represents an address field. All components are optional, so provide only those relevant to the address you want to find.

See https://nominatim.org/release-docs/latest/api/Search/ for additional parameters to be passed to custom_query.

Examples

# \donttest{
pl_mayor <- geo_lite_struct(
  street = "Plaza Mayor", country = "Spain",
  limit = 50, full_results = TRUE
)

dplyr::glimpse(pl_mayor)
#> Rows: 31
#> Columns: 41
#> $ q_amenity                <chr> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, N…
#> $ q_street                 <chr> "Plaza Mayor", "Plaza Mayor", "Plaza Mayor", …
#> $ q_city                   <chr> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, N…
#> $ q_county                 <chr> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, N…
#> $ q_state                  <chr> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, N…
#> $ q_country                <chr> "Spain", "Spain", "Spain", "Spain", "Spain", …
#> $ q_postalcode             <chr> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, N…
#> $ lat                      <dbl> 40.41539, 40.96503, 41.65206, 40.95033, 40.02…
#> $ lon                      <dbl> -3.7069974, -5.6640558, -4.7285484, -4.123986…
#> $ address                  <chr> "Plaza Mayor, Barrio de los Austrias, Sol, Ce…
#> $ place_id                 <int> 293280562, 292768831, 292162441, 292826660, 2…
#> $ licence                  <chr> "Data © OpenStreetMap contributors, ODbL 1.0.…
#> $ osm_type                 <chr> "relation", "way", "way", "relation", "way", …
#> $ osm_id                   <int> 16657232, 78180390, 24432960, 18226870, 18456…
#> $ category                 <chr> "highway", "highway", "highway", "highway", "…
#> $ type                     <chr> "pedestrian", "pedestrian", "pedestrian", "pe…
#> $ place_rank               <int> 26, 26, 26, 26, 26, 26, 26, 26, 26, 26, 26, 2…
#> $ importance               <dbl> 0.43695500, 0.35441159, 0.32592895, 0.1961921…
#> $ addresstype              <chr> "road", "road", "road", "road", "road", "road…
#> $ name                     <chr> "Plaza Mayor", "Plaza Mayor", "Plaza Mayor", …
#> $ display_name             <chr> "Plaza Mayor, Barrio de los Austrias, Sol, Ce…
#> $ address.road             <chr> "Plaza Mayor", "Plaza Mayor", "Plaza Mayor", …
#> $ address.neighbourhood    <chr> "Barrio de los Austrias", NA, NA, "La Judería…
#> $ address.quarter          <chr> "Sol", NA, NA, NA, "Miralvalle", NA, NA, NA, …
#> $ address.city_district    <chr> "Centro", "Centro", NA, "Comunidad de Ciudad …
#> $ address.city             <chr> "Madrid", "Salamanca", "Valladolid", "Segovia…
#> $ address.state            <chr> "Comunidad de Madrid", "Castilla y León", "Ca…
#> $ `address.ISO3166-2-lvl4` <chr> "ES-MD", "ES-CL", "ES-CL", "ES-CL", "ES-EX", …
#> $ address.postcode         <chr> "28012", "37002", "47003", "40001", "10609", …
#> $ address.country          <chr> "España", "España", "España", "España", "Espa…
#> $ address.country_code     <chr> "es", "es", "es", "es", "es", "es", "es", "es…
#> $ address.province         <chr> NA, "Salamanca", "Valladolid", "Segovia", "Cá…
#> $ `address.ISO3166-2-lvl6` <chr> NA, "ES-SA", "ES-VA", "ES-SG", "ES-CC", "ES-Z…
#> $ address.suburb           <chr> NA, NA, "Plaza Mayor", "La Albuera", NA, "Bar…
#> $ address.hamlet           <chr> NA, NA, NA, NA, "Olivar del Puerto", NA, NA, …
#> $ address.town             <chr> NA, NA, NA, NA, "Plasencia", NA, "Vic", NA, N…
#> $ address.village          <chr> NA, NA, NA, NA, NA, NA, "Sentfores", NA, NA, …
#> $ address.county           <chr> NA, NA, NA, NA, NA, NA, "Osona", NA, NA, NA, …
#> $ address.region           <chr> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, "l'Al…
#> $ address.borough          <chr> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, N…
#> $ boundingbox              <list> <40.414989, 40.415813, -3.708120, -3.706629>…
# }

Usage

Arguments

Value

Details

See also

Examples