reverse_geocoding: Reverse geocoding

In ropensci/PostcodesioR: API Wrapper Around 'Postcodes.io'

Reverse geocoding

Description

Returns nearest postcodes for a given longitude and latitude.

Usage

reverse_geocoding(
  longitude,
  latitude,
  limit = 10,
  radius = 100,
  wideSearch = NULL
)

Arguments

longitude	A string or numeric. Needs to have at least three decimal points.
latitude	A string or numeric. Needs to have at least three decimal points.
limit	An integer. Limits number of postcodes matches to return. Defaults to 10. Needs to be less than 100.
radius	An integer. Limits number of postcodes matches to return. Defaults to 100m. Needs to be less than 2,000m.
wideSearch	TRUE or FALSE. Search up to 20km radius, but subject to a maximum of 10 results. Since lookups over a wide area can be very expensive, we've created this method to allow you choose to make the trade off between search radius and number of results. Defaults to false. When enabled, radius and limits over 10 are ignored.

Value

A list with available data.

See Also

postcode_lookup for documentation.

Examples

reverse_geocoding(0.127, 51.507)
reverse_geocoding("0.1275", "51.5073", limit = 3)
reverse_geocoding("0.1275", "51.5073", limit = 11, radius = 200)

ropensci/PostcodesioR documentation built on April 21, 2023, 1:52 p.m.