Skip to contents

Postcode autocomplete

Source: R/postcode_autocomplete.R
postcode_autocomplete.Rd

Returns a data frame of matching postcodes.

Usage

postcode_autocomplete(postcode, limit = 10)

Arguments

postcode

A string. Valid UK postcode.

limit

An integer. Limits number of postcodes matches to return. Defaults to 10. Needs to be less than 100.

Value

A data frame with suggested postcodes.

Examples

# \donttest{
postcode_autocomplete("E1")
#>    postcode
#> 1    E1 0AA
#> 2    E1 0AD
#> 3    E1 0AE
#> 4    E1 0AF
#> 5    E1 0AG
#> 6    E1 0AH
#> 7    E1 0AJ
#> 8    E1 0AL
#> 9    E1 0AN
#> 10   E1 0AP
postcode_autocomplete("E1", limit = 11)
#>    postcode
#> 1    E1 0AA
#> 2    E1 0AD
#> 3    E1 0AE
#> 4    E1 0AF
#> 5    E1 0AG
#> 6    E1 0AH
#> 7    E1 0AJ
#> 8    E1 0AL
#> 9    E1 0AN
#> 10   E1 0AP
#> 11   E1 0AQ
# }