get_rental_listings: Get Zillow rental listings time series data

In stharms/realEstAnalytics.r: Interfacing with Zillow's API in R

Description

Reads the static .csv file for the desired Zillow Home Values series based on data type and geography, by building a URL path to the .csv file hosted by Zillow. Data is available for a variety of sizes and types, and can be returned in either gross prices or by $ per square foot.

Usage

get_rental_listings(bedrooms = 1, type = NULL, geography = "Zip",
  rate = "Total")

Arguments

bedrooms	a numeric value specifying the number of bedrooms. If not needed, leave at the default (1)
type	(optional) a character string specifying housing type, from NULL, 'SFR', 'Multi', 'Duplex', 'Condo/Co-op', 'Studio', and 'SFR/Condo'.
geography	string specifying the desired geographic region to summarise. Choices are 'Metro','City', 'State', 'Neighborhood', 'Zip', and 'County'.
rate	a string specifying the rate, either 'Total' or 'PerSqFt'

Value

A tibble. Columns returned correspond to geographic region information and monthly observations for each region.

Examples

#5 bedrooms by zipcode
## Not run: 

get_rental_listings(bedrooms=5, rate='PerSqFt', type="Studio",geography="Zip")


## End(Not run)

#1 bedroom multi-family homes by state.
## Not run: 

get_rental_listings(bedrooms=1, rate='Total', type="Multi", geography="State")


## End(Not run)

stharms/realEstAnalytics.r documentation built on May 14, 2019, 1:57 a.m.