GetComps: Make request to Zillow API GetComps Web Service

In ZillowR: R Interface to Zillow Real Estate and Mortgage Data API

Make request to Zillow API GetComps Web Service

Description

The GetComps API returns a list of comparable recent sales for a specified property. The result set returned contains the address, Zillow property identifier, and Zestimate for the comparable properties and the principal property for which the comparables are being retrieved.

Usage

GetComps(
  zpid = NULL,
  count = NULL,
  rentzestimate = FALSE,
  zws_id = getOption("ZillowR-zws_id"),
  url = "http://www.zillow.com/webservice/GetComps.htm"
)

Arguments

zpid	The Zillow Property ID for the property for which to obtain information. Required.
count	The number of comparable recent sales to obtain (between 1 and 25)
rentzestimate	Return Rent Zestimate information if available (logical, default: false).
zws_id	The Zillow Web Service Identifier. Required.
url	URL for the GetComps Web Service. Required.

Value

A named list with the following elements:

request

a list with the request parameters

message

a list of status code(s) and message(s) returned by the API

response

an XMLNode with the API-specific response values. At this time, no further coercion is performed, so you may have to use functions from the XML package to extract the desired output.

Examples

## Not run: 
GetComps(zpid = 48749425, count = 5)
GetComps(zpid = 48749425, count = 5, rentzestimate = TRUE)
## End(Not run)

ZillowR documentation built on May 5, 2022, 9:06 a.m.