getComps: Get Zillow estimates and information for comparable...

View source: R/zillow.R

getCompsR Documentation

Get Zillow estimates and information for comparable properties

Description

This retrieves information about properties that Zillow deems comparable to the specified property of interest.

Usage

getComps(id, zillowId, count = 30, ...)

Arguments

id

the property identifier. This can be a the Zillow property identifier, (i.e. a number something like 24842790 which is obtained from a previous call to the Zillow API) or it can be a character vector of length 2 giving the house number and street in the first element, and the zip code or city and state in the second element.

zillowId

the Zillow Web Services ID (ZWSID) that allows you to make calls to the Zillow API. See https://www.zillow.com/webservice/Registration.htm.

count

the number of comparables to return in the result. This should be a positive number and the current limit allowed by the Zillow API appears to be 30.

...

additional parameters passed on to the getForm call. These allow the caller to customize/parameterize the Web request, e.g. reusing an existing connection via a curl handle, changing the HTTP headers, etc.

Value

A data frame. The first row gives the details for the specified house, and the remaining rows provide the same details for each of the comparables. The variables are

amount
low
high
valueChange30Day
street
zip
latitude
longitude
taxAssessmentYear
taxAssessment
yearBuilt
lotSizeSqFt
finishedSqFt
bathrooms
bedrooms
lastSoldPrice
lastSold
score

References

http://www.zillow.com/howto/api/GetDeepComps.htm

See Also

zestimate

Examples

## Not run: 
      # You need a ZWSID to run these examples.
   getComps(c("1280 Monterey Avenue", "94707"), zillowId)
   getComps(c("1280 Monterey Avenue", "94707"), zillowId, count = 5)

      # Using a previously retrieved Zillow property identifier.
   getComps(24842790, zillowId)

## End(Not run)

duncantl/Zillow documentation built on Nov. 23, 2023, 4:29 p.m.