Address search API (structured query)

Geocodes addresses already split into components. This function returns the tibble associated with the query, see geo_lite_struct_sf() for retrieving the data as a spatial object (sf format).

This function correspond to the structured query search described in the API endpoint. For performing 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: Name and/or type of POI, see also geo_amenity.
street: House number and street name.
city: City.
county: County.
state: State.
country: Country.
postalcode: Postal Code.
lat: Latitude column name in the output data (default "lat").
long: Longitude column name in the output data (default "long").
limit: Maximum number of results to return per input address. Note that each query returns a maximum of 50 results.
full_results: Returns all available data from the API service. If FALSE (default) only latitude, longitude and address columns are returned. See also return_addresses.
return_addresses: Return input addresses with results if TRUE.
verbose: If TRUE then detailed logs are output to the console.
nominatim_server: The URL of the Nominatim server to use. Defaults to "https://nominatim.openstreetmap.org/".
custom_query: A named list with API-specific parameters to be used (i.e. list(countrycodes = "US")). See Details.

Value

A tibble with the results found by the query.

Details

The structured form of the search query allows to look up up an address that is already split into its components. Each parameter represents a field of the address. All parameters are optional. You should only use the ones that are relevant for the address you want to geocode.

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: 43
#> $ 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, 36.65631, 36.65…
#> $ lon                      <dbl> -3.7069974, -5.6640558, -4.7285484, -4.480360…
#> $ address                  <chr> "Plaza Mayor, Barrio de los Austrias, Sol, Ma…
#> $ place_id                 <int> 270938992, 270518333, 270013325, 273939846, 2…
#> $ licence                  <chr> "Data © OpenStreetMap contributors, ODbL 1.0.…
#> $ osm_type                 <chr> "relation", "way", "way", "node", "node", "wa…
#> $ osm_id                   <dbl> 16657232, 78180390, 24432960, 7571619016, 117…
#> $ category                 <chr> "highway", "tourism", "highway", "railway", "…
#> $ type                     <chr> "pedestrian", "attraction", "pedestrian", "st…
#> $ place_rank               <int> 26, 30, 26, 30, 30, 26, 26, 30, 26, 26, 26, 2…
#> $ importance               <dbl> 0.43955427, 0.37221179, 0.32357442, 0.2548236…
#> $ addresstype              <chr> "road", "tourism", "road", "railway", "railwa…
#> $ name                     <chr> "Plaza Mayor", "Plaza Mayor", "Plaza Mayor", …
#> $ display_name             <chr> "Plaza Mayor, Barrio de los Austrias, Sol, Ma…
#> $ address.road             <chr> "Plaza Mayor", "Plaza Mayor", "Plaza Mayor", …
#> $ address.neighbourhood    <chr> "Barrio de los Austrias", NA, NA, NA, NA, NA,…
#> $ address.quarter          <chr> "Sol", NA, NA, NA, NA, "El Berrocal", NA, NA,…
#> $ address.city             <chr> "Madrid", "Salamanca", "Valladolid", "Málaga"…
#> $ address.state            <chr> "Comunidad de Madrid", "Castilla y León", "Ca…
#> $ `address.ISO3166-2-lvl4` <chr> "ES-MD", "ES-CL", "ES-CL", "ES-AN", "ES-AN", …
#> $ address.postcode         <chr> "28012", "37002", "47001", "29140", "29140", …
#> $ 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.tourism          <chr> NA, "Plaza Mayor", NA, NA, NA, NA, NA, "Plaça…
#> $ address.city_district    <chr> NA, "Centro", NA, NA, NA, NA, NA, NA, NA, NA,…
#> $ address.province         <chr> NA, "Salamanca", "Valladolid", "Málaga", "Mál…
#> $ `address.ISO3166-2-lvl6` <chr> NA, "ES-SA", "ES-VA", "ES-MA", "ES-MA", "ES-C…
#> $ address.suburb           <chr> NA, NA, "Plaza Mayor", NA, NA, NA, "San Loren…
#> $ address.railway          <chr> NA, NA, NA, "Plaza Mayor", "Plaza Mayor", NA,…
#> $ address.retail           <chr> NA, NA, NA, "Plaza Mayor", "Plaza Mayor", NA,…
#> $ address.borough          <chr> NA, NA, NA, "Churriana", "Churriana", NA, NA,…
#> $ address.county           <chr> NA, NA, NA, "Málaga-Costa del Sol", "Málaga-C…
#> $ address.town             <chr> NA, NA, NA, NA, NA, "Plasencia", NA, "Vic", N…
#> $ address.region           <chr> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, "l'Al…
#> $ address.village          <chr> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, N…
#> $ boundingbox              <list> <40.414988, 40.415813, -3.708121, -3.706630>…
# }

Usage

Arguments

Value

Details

See also

Examples