first commit

R/postcode_properties.R

@@ -0,0 +1,34 @@
+#' Postcode Properties
+#'
+#' @import dplyr
+#' @import httr
+#' @import XML
+#' 
+#' @param postcode A string representing a valid UK postcode, e.g. "EH1 2NG".
+#' @param API_key An API key from Zoopla.
+#'
+#' @return A list.
+#' @export
+#'
+#' @references \url{https://developer.zoopla.co.uk/docs/read/Arrange_Appraisals}
+#'
+#' @examples
+#' \dontrun{
+#' 
+#' postcode_properties("EH12NG", "YOUR_API_KEY")
+#' postcode_properties("EH1 2NG", "YOUR_API_KEY")
+#' }
+#' 
+postcode_properties <- function(postcode=NULL, API_key=NULL){
+  if (!is.character(postcode) || nchar(postcode) < 2) {
+    stop("Please provide a valid UK outcode.")
+  }
+  if (!is.character(API_key)) {
+    stop("Please provide an API key.")
+  }
+  postcode <- gsub(" ", "", postcode, fixed = TRUE)
+  r <- GET("https://api.zoopla.co.uk/api/v1/postcode_properties",
+           query = list(postcode = postcode, api_key = API_key))
+  warn_for_status(r)
+  r %>% content(encoding="UTF-8") %>% xmlParse() %>%  xmlToList() %>% return()
+}