nearest_outcode function

Nearest outcode

Returns nearest outcodes for a given outcode. The search is based on the relative distance of the outcode centroid.

nearest_outcode(outcode, limit = 10, radius = 5000)

Arguments

• outcode: A string with a UK postcode.
• limit: An integer. Optional parameter. Limits number of postcodes matches to return. Defaults to 10. Needs to be less than 100.
• radius: An integer. Optional parameter. Limits number of postcodes matches to return. Defaults to 5,000m. Needs to be less than 25,000m.

Returns

A list of geographical properties.

Examples

nearest_outcode("EC1Y")
nearest_outcode("EC1Y", limit = 11)
nearest_outcode("EC1Y", limit = 11, radius = 6000)

See Also

postcode_lookup for documentation.