R/postcode_validation.R

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

#' Postcode validation
#'
#' Convenience method to validate a postcode.
#'
#' @importFrom httr GET
#' @importFrom utils URLencode
#'
#' @param postcode A string. Valid UK postcode.
#'
#' @export
#'
#' @return A logical vector: True or False (meaning respectively valid or invalid postcode).
#'
#' @examples
#' \donttest{
#' postcode_validation("EC1Y 8LX") # returns TRUE
#' postcode_validation("XYZ") # returns FALSE
#' }
#'
postcode_validation <- function(postcode) {
  postcode <- URLencode(postcode)
  r <- GET(paste0("https://api.postcodes.io/postcodes/", postcode, "/validate"))
  extract_results(r)
}