GetComps: Get the results for comparable recent property sales for a...

Description Usage Arguments Value Examples

View source: R/GetComps.R

Description

For a given Zillow property ID, find valuation data for comparable recent property sales. The returned data frame contains address information and Zestimate/Rental valuation information for the comparables.

Usage

1
2
GetComps(zpid, count = 10, rentzestimate = FALSE, api_key,
  raw = FALSE)

Arguments

zpid

The Zillow property id to search for

count

(integer) How many comparables to return? Maximum: 25

rentzestimate

(logical) If TRUE, gets the rent zestimate.

api_key

A character string specifying your unique Zillow API key

raw

(logical) If TRUE the raw XML data from the API call is returned (i.e., the original ZillowR call)

Value

If raw=T, a raw XML document. If raw=F (default), a data frame with columns corresponding to address information, Zestimates, and property information. The number of columns varies by property use type.

Examples

1
2
3
4
5
6
7
## Not run: 
#Comparable properties for 600 S. Quail Ct.

GetComps(zpid='1340244', count=10, rentzestimate=TRUE,
 api_key = getOption('ZillowR-zws_id'))
 
## End(Not run)

xiyuansun/realEstAnalytics documentation built on May 7, 2019, 7:12 p.m.