get_ZHVI_series: Get Zillow Home Value Index time series data

In xiyuansun/realEstAnalytics: Interfacing with Zillow's API in R

Description

Reads the static .csv file for Zillow Home Values series by type and geography, building a URL path to the .csv file. Options are available for a variety of home sizes and types, as well as tiers if you wish to view other data that is aggregated. The return is a dataframe with time series observations aggregated by region.

Usage

get_ZHVI_series(bedrooms = 1, geography = "Metro", allhomes = F,
  tier = "ALL", summary = F, other = NULL)

Arguments

bedrooms	a numeric value specifying the number of bedrooms. If not needed, leave at the default (1)
geography	(required) string specifying the desired geographic region to summarise. Choices are 'Metro', 'City', 'State', 'Neighborhood', 'Zip', and 'County'.
allhomes	logical, set to TRUE If you do not want a specific # of bedrooms or type of home
tier	one of 'ALL','T' (for top), 'B' (for bottom), or 'M' (for median)
summary	logical, if TRUE, the ZHVI summary for all homes is returned
other	Other possible options from the Zillow home data series. Default is NULL. Possible options are strings "Median Home Price Per Sq Ft", and "Increasing" or "Decreasing"

Value

A tibble. Columns returned correspond to geographic identification information and dates for which the time series observations are available.

Examples

#All homes, bottom tier, by zipcode
## Not run: 

get_ZHVI_series(allhomes=TRUE, tier="B",geography="Zip")


## End(Not run)

#2 bedrooms by city
## Not run: 
get_ZHVI_series(bedrooms=2,geography="City")


## End(Not run)

#the ZHVI summary for all homes by State
## Not run: 

get_ZHVI_series(geography="State", summary=TRUE)


## End(Not run)

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