---
# language: 
# - "List of ISO 639-1 code for your language"
# - lang1
# - lang2
pretty_name: "Zillow"
# tags:
# - tag1
# - tag2
license: "other"
# task_categories:
# - task1
# - task2
---

# Housing Data Provided by Zillow
## Updated 2023-02-01

This dataset contains several configs produced based on files available at https://www.zillow.com/research/data/.

supported configs:
<!-- list each with a short description (1 sentence) -->
- [`home_values`](https://huggingface.co/datasets/misikoff/zillow#home-values): Zillow Home Value Index (ZHVI) for all homes, mid-tier, bottom-tier, and top-tier homes.
- [`home_values_forecasts`](https://huggingface.co/datasets/misikoff/zillow#home-values-forecasts): Zillow Home Value Forecast (ZHVF) for all homes, mid-tier, bottom-tier, and top-tier homes.
- [`rentals`](https://huggingface.co/datasets/misikoff/zillow#rentals): Zillow Observed Rent Index (ZORI) for all homes, mid-tier, bottom-tier, and top-tier homes.
- [`for_sale_listings`](https://huggingface.co/datasets/misikoff/zillow#for-sale-listings): Median listing price, new listings, and new pending listings.
- [`sales`](https://huggingface.co/datasets/misikoff/zillow#sales): Median sale price, median sale price per square foot, and sales count.
- [`days_on_market`](https://huggingface.co/datasets/misikoff/zillow#days-on-market): Days to pending, days to close, share of listings with a price cut, and price cuts.
- [`new_construction`](https://huggingface.co/datasets/misikoff/zillow#new-construction): Median sale price, median sale price per square foot, and sales count.

## HOME VALUES

<!-- Zillow Home Value Index (ZHVI): A measure of the typical home value and market changes across a given region and housing type. It reflects the typical value for homes in the 35th to 65th percentile range. Available as a smoothed, seasonally adjusted measure and as a raw measure. -->

<!-- Zillow publishes top-tier ZHVI (\$, typical value for homes within the 65th to 95th percentile range for a given region) and bottom-tier ZHVI (\$, typical value for homes within the 5th to 35th percentile range for a given region). -->

<!-- Zillow also publishes ZHVI for all single-family residences (\$, typical value for all single-family homes in a given region), for condo/coops (\$), for all homes with 1, 2, 3, 4 and 5+ bedrooms (\$), and the ZHVI per square foot (\$, typical value of all homes per square foot calculated by taking the estimated home value for each home in a given region and dividing it by the home’s square footage). -->

<!-- Note: Starting with the January 2023 data release, and for all subsequent releases, the full ZHVI time series has been upgraded to harness the power of the neural Zestimate. -->

<!-- More information about what ZHVI is and how it’s calculated is available on this overview page. Here’s a handy ZHVI User Guide for information about properly citing and making calculations with this metric. -->

Base Columns
- `Region ID`: dtype="string", a unique identifier for the region
- `Size Rank`: dtype="int32", a rank of the region's size
- `Region`: dtype="string", the name of the region
- `Region Type`: dtype="string", the type of region
- `State`: dtype="string", the US state abbreviation for the state containing the region
- `Home Type`: dtype="string", the type of home
- `Date`: dtype="string", the date of the last day of the month for this data

Value Columns
- `Mid Tier ZHVI (Smoothed) (Seasonally Adjusted)`: dtype="float32",
- `Bottom Tier ZHVI (Smoothed) (Seasonally Adjusted)`: dtype="float32",
- `Top Tier ZHVI (Smoothed) (Seasonally Adjusted)`: dtype="float32",
- `ZHVI`: dtype="float32",
- `Mid Tier ZHVI`: dtype="float32"


## HOME VALUES FORECASTS

<!-- Zillow Home Value Forecast (ZHVF): A month-ahead, quarter-ahead and year-ahead forecast of the Zillow Home Value Index (ZHVI). ZHVF is created using the all homes, mid-tier cut of ZHVI and is available both raw and smoothed, seasonally adjusted. -->

<!-- Note: Starting with the January 2023 forecast (made available in February 2023), Zillow’s Home Value Forecast is based on the upgraded ZHVI that harnesses the power of the neural Zestimate. More information about what ZHVI is and how it’s calculated is available on this overview page. -->

Base Columns
- `Region ID`: dtype="string", a unique identifier for the region
- `Size Rank`: dtype="int32", a rank of the region's size
- `Region`: dtype="string", the name of the region
- `Region Type`: dtype="string", the type of region
- `State`: dtype="string", the US state abbreviation for the state containing the region
- `City`: dtype="string", id="City"),
- `Metro`: dtype="string", id="Metro"),
- `County`: dtype="string", id="County"),
- `Home Type`: dtype="string", the type of home
- `Date`: dtype="string", the date of these forecasts

Value Columns
- `Month Over Month % (Smoothed)`: dtype="float32",
- `Quarter Over Quarter % (Smoothed)`: dtype="float32",
- `Year Over Year % (Smoothed)`: dtype="float32"
- `Month Over Month % (Raw)`: dtype="float32"
- `Quarter Over Quarter % (Raw)`: dtype="float32"
- `Year Over Year % (Raw)`: dtype="float32"

## RENTALS

Base Columns
- `Region ID`: dtype="string", a unique identifier for the region
- `Size Rank`: dtype="int32", a rank of the region's size
- `Region`: dtype="string", the name of the region
- `Region Type`: dtype="string", the type of region
- `State`: dtype="string", the US state abbreviation for the state containing the region
- `Home Type`: dtype="string", the type of home
- `Date`: dtype="string", the date of the last day of the month for this data

Value Columns
- `Rent (Smoothed)`: dtype="float32", Zillow Observed Rent Index (ZORI): A smoothed measure of the typical observed market rate rent across a given region. ZORI is a repeat-rent index that is weighted to the rental housing stock to ensure representativeness across the entire market, not just those homes currently listed for-rent. The index is dollar-denominated by computing the mean of listed rents that fall into the 40th to 60th percentile range for all homes and apartments in a given region, which is weighted to reflect the rental housing stock.
- `Rent (Smoothed) (Seasonally Adjusted)`: dtype="float32", Zillow Observed Rent Index (ZORI) :A smoothed measure of the typical observed market rate rent across a given region. ZORI is a repeat-rent index that is weighted to the rental housing stock to ensure representativeness across the entire market, not just those homes currently listed for-rent. The index is dollar-denominated by computing the mean of listed rents that fall into the 40th to 60th percentile range for all homes and apartments in a given region, which is weighted to reflect the rental housing stock.

## FOR-SALE LISTINGS

Base Columns
- `Region ID`: dtype="string", a unique identifier for the region
- `Size Rank`: dtype="int32", a rank of the region's size
- `Region`: dtype="string", the name of the region
- `Region Type`: dtype="string", the type of region
- `State`: dtype="string", the US state abbreviation for the state containing the region
- `Home Type`: dtype="string", the type of home
- `Date`: dtype="string", the date of the last day of the month for this data
  
Value Columns
- `Median Listing Price`: dtype="float32",  The median price at which homes across various geographies were listed.
- `Median Listing Price (Smoothed)`: dtype="float32",  The median price at which homes across various geographies were listed. (smoothed)
- `New Listings`: dtype="int32", how many new listings have come on the market in a given month
- `New Listings (Smoothed)`: dtype="int32", how many new listings have come on the market in a given month. (smoothed)
- `New Pending (Smoothed)`: dtype="int32", The count of listings that changed from for-sale to pending status on Zillow.com in a given time period. (smoothed)
- `New Pending`: dtype="int32", The count of listings that changed from for-sale to pending status on Zillow.com in a given time period.


## SALES (TODO investigate columns)
<!-- Sale-to-List Ratio (mean/median): Ratio of sale vs. final list price. -->
<!-- Percent of Sales Below/Above List: Share of sales where sale price below/above the final list price; excludes homes sold for exactly the list price.  -->

Base Columns
- `Region ID`: dtype="string", a unique identifier for the region
- `Size Rank`: dtype="int32", a rank of the region's size
- `Region`: dtype="string", the name of the region
- `Region Type`: dtype="string", the type of region
- `State`: dtype="string", the US state abbreviation for the state containing the region
- `Home Type`: dtype="string", the type of home
- `Date`: dtype="string", the date of the last day of the month for this data

Value Columns 
- `Median Sale Price`: dtype="float32",  The median price at which homes across various geographies were sold.
- `Median Sale Price per Sqft`: dtype="float32"  The median price per square foot at which homes across various geographies were sold.
- `Sales Count`: dtype="int32", The "Sales Count Nowcast" is the estimated number of unique properties that sold during the month after accounting for the latency between when sales occur and when they are reported.

## DAYS ON MARKET AND PRICE CUTS (TODO investigate columns more)

Days to Pending: How long it takes homes in a region to change to pending status on Zillow.com after first being shown as for sale. The reported figure indicates the number of days (mean or median) that it took for homes that went pending during the week being reported, to go pending. This differs from the old “Days on Zillow” metric in that it excludes the in-contract period before a home sells.
Days to Close (mean/median): Number of days between the listing going pending and the sale date.
Share of Listings With a Price Cut: The number of unique properties with a list price at the end of the month that’s less than the list price at the beginning of the month, divided by the number of unique properties with an active listing at some point during the month.
Price Cuts: The mean and median price cut for listings in a given region during a given time period, expressed as both dollars ($) and as a percentage (%) of list price.

Base Columns
- `Region ID`: dtype="string", a unique identifier for the region
- `Size Rank`: dtype="int32", a rank of the region's size
- `Region`: dtype="string", the name of the region
- `Region Type`: dtype="string", the type of region
- `State`: dtype="string", the US state abbreviation for the state containing the region
- `Home Type`: dtype="string", the type of home
- `Date`: dtype="string", the date of the last day of the week for this data
  
Value Columns
- `Mean Listings Price Cut Amount (Smoothed)`: dtype="float32"
- `Percent Listings Price Cut`: dtype="float32", The number of unique properties with a list price at the end of the month that’s less than the list price at the beginning of the month, divided by the number of unique properties with an active listing at some point during the month.
- `Mean Listings Price Cut Amount`: dtype="float32"
- `Percent Listings Price Cut (Smoothed)`: dtype="float32"
- `Median Days on Pending (Smoothed)`: dtype="float32", median number of days it takes for homes in a region to change to pending status on Zillow.com after first being shown as for sale. (smoothed)
- `Median Days on Pending`: dtype="float32", median number of days it takes for homes in a region to change to pending status on Zillow.com after first being shown as for sale.

## NEW CONSTRUCTION

Base Columns
- `Region ID`: dtype="string", a unique identifier for the region
- `Size Rank`: dtype="int32", a rank of the region's size
- `Region`: dtype="string", the name of the region
- `Region Type`: dtype="string", the type of region
- `State`: dtype="string", the US state abbreviation for the state containing the region
- `Home Type`: dtype="string", the type of home
- `Date`: dtype="string", the date of the last day of the month for this data
  
Value Columns
- `Median Sale Price`: dtype="float32", the median sale price of new construction homes that sold during the month in the specified region
- `Median Sale Price per Sqft`: dtype="float32", the median sale price per square foot of new construction homes that sold during the month in the specified region
- `Sales Count`: dtype="int32", the number of new construction homes that sold during the month in the specified region

## DEFINITIONS OF HOME TYPES
- All Homes: Zillow defines all homes as single-family, condominium and co-operative homes with a county record. Unless specified, all series cover this segment of the housing stock.
- Condo/Co-op: Condominium and co-operative homes.
- Multifamily 5+ units: Units in buildings with 5 or more housing units, that are not condominiums or co-ops.
- Duplex/Triplex/Quadplex: Housing units in buildings with 2, 3, or 4 housing units.

# Example Usage
```python
from datasets import load_dataset

dataset = load_dataset("misikoff/zillow", 'home_values', trust_remote_code=True)
```