GetSearchResults {ZillowR} | R Documentation |
Make request to Zillow API GetSearchResults Web Service
Description
The GetSearchResults API finds a property for a specified address. The content returned contains the address for the property or properties as well as the Zillow Property ID (ZPID) and current Zestimate. It also includes the date the Zestimate was computed, a valuation range and the Zestimate ranking for the property within its ZIP code.
Usage
GetSearchResults(
address = NULL,
citystatezip = NULL,
rentzestimate = FALSE,
zws_id = getOption("ZillowR-zws_id"),
url = "http://www.zillow.com/webservice/GetSearchResults.htm"
)
Arguments
address |
The address of the property to search. Required. |
citystatezip |
The city+state combination and/or ZIP code for which to search. Required. |
rentzestimate |
Return Rent Zestimate information if available (logical, default: false). |
zws_id |
The Zillow Web Service Identifier. Required. |
url |
URL for the GetSearchResults 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:
GetSearchResults(address = '2114 Bigelow Ave', citystatezip = 'Seattle, WA')
GetSearchResults(address = '2114 Bigelow Ave', citystatezip = 'Seattle, WA',
rentzestimate = TRUE)
## End(Not run)