misikoff commited on
Commit
4097108
1 Parent(s): b8c0aa8

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +254 -0
README.md CHANGED
@@ -36,3 +36,257 @@ configs:
36
  path:
37
  - "sales.parquet"
38
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
36
  path:
37
  - "sales.parquet"
38
  ---
39
+
40
+ # Housing Data Provided by Zillow (In Progress)
41
+ Updated: 2023-02-01
42
+
43
+ This dataset contains several configs produced based on files available at https://www.zillow.com/research/data/.
44
+
45
+ # Processing Notes
46
+
47
+ This dataset contains only parquet files created from the raw Zillow data. For code related to processing that data and creating the parquet files see https://huggingface.co/datasets/misikoff/zillow.
48
+
49
+ Supported configs:
50
+ - [`days_on_market`](#days-on-market): Days to pending, days to close, share of listings with a price cut, and price cuts.
51
+ - [`for_sale_listings`](#for-sale-listings): Median listing price, new listings, and new pending listings.
52
+ - [`home_values`](#home-values): Zillow Home Value Index (ZHVI) for all homes, mid-tier, bottom-tier, and top-tier homes.
53
+ - [`home_values_forecasts`](#home-values-forecasts): Zillow Home Value Forecast (ZHVF) for all homes, mid-tier, bottom-tier, and top-tier homes.
54
+ - [`new_construction`](#new-construction): Median sale price, median sale price per square foot, and sales count.
55
+ - [`rentals`](#rentals): Zillow Observed Rent Index (ZORI) for all homes, mid-tier, bottom-tier, and top-tier homes.
56
+ - [`sales`](#sales): Median sale price, median sale price per square foot, and sales count.
57
+
58
+ ## DAYS ON MARKET AND PRICE CUTS (TODO investigate columns more)
59
+
60
+ 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.
61
+ Days to Close (mean/median): Number of days between the listing going pending and the sale date.
62
+ 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.
63
+ 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.
64
+
65
+ Base Columns
66
+ - `Region ID`: dtype="string", a unique identifier for the region
67
+ - `Size Rank`: dtype="int32", a rank of the region's size
68
+ - `Region`: dtype="string", the name of the region
69
+ - `Region Type`: dtype="class_label", the type of region
70
+ - '0': zip
71
+ - '1': city
72
+ - '2': county
73
+ - '3': msa
74
+ - '4': state
75
+ - '5': country
76
+ - `State`: dtype="string", the US state abbreviation for the state containing the region
77
+ - `Home Type`: dtype="string", the type of home
78
+ - '0': multifamily
79
+ - '1': condo/co-op
80
+ - '2': SFR
81
+ - '3': all homes
82
+ - '4': all homes plus multifamily
83
+ - `Date`: dtype="timestamp[ms]", the date of the last day of the week for this data
84
+
85
+ Value Columns
86
+ - `Mean Listings Price Cut Amount (Smoothed)`: dtype="float32"
87
+ - `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.
88
+ - `Mean Listings Price Cut Amount`: dtype="float32"
89
+ - `Percent Listings Price Cut (Smoothed)`: dtype="float32"
90
+ - `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)
91
+ - `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.
92
+
93
+ ## FOR-SALE LISTINGS
94
+
95
+ Base Columns
96
+ - `Region ID`: dtype="string", a unique identifier for the region
97
+ - `Size Rank`: dtype="int32", a rank of the region's size
98
+ - `Region`: dtype="string", the name of the region
99
+ - `Region Type`: dtype="class_label", the type of region
100
+ - '0': zip
101
+ - '1': city
102
+ - '2': county
103
+ - '3': msa
104
+ - '4': state
105
+ - `State`: dtype="string", the US state abbreviation for the state containing the region
106
+ - `Home Type`: dtype="string", the type of home
107
+ - '0': all homes
108
+ - '1': all homes plus multifamily
109
+ - '2': SFR
110
+ - '3': condo/co-op
111
+ - '4': multifamily
112
+ - `Date`: dtype="timestamp[ms]", the date of the last day of the month for this data
113
+
114
+ Value Columns
115
+ - `Median Listing Price`: dtype="float32", The median price at which homes across various geographies were listed.
116
+ - `Median Listing Price (Smoothed)`: dtype="float32", The median price at which homes across various geographies were listed. (smoothed)
117
+ - `New Listings`: dtype="int32", how many new listings have come on the market in a given month
118
+ - `New Listings (Smoothed)`: dtype="int32", how many new listings have come on the market in a given month. (smoothed)
119
+ - `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)
120
+ - `New Pending`: dtype="int32", The count of listings that changed from for-sale to pending status on Zillow.com in a given time period.
121
+
122
+
123
+ ## HOME VALUES
124
+
125
+ <!-- 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. -->
126
+
127
+ <!-- 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). -->
128
+
129
+ <!-- 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). -->
130
+
131
+ <!-- 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. -->
132
+
133
+ <!-- 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. -->
134
+
135
+ Base Columns
136
+ - `Region ID`: dtype="string", a unique identifier for the region
137
+ - `Size Rank`: dtype="int32", a rank of the region's size
138
+ - `Region`: dtype="string", the name of the region
139
+ - `Region Type`: dtype="class_label", the type of region
140
+ - '0': zip
141
+ - '1': city
142
+ - '2': county
143
+ - '3': msa
144
+ - '4': state
145
+ - '5': country"
146
+ - `State`: dtype="string", the US state abbreviation for the state containing the region
147
+ - `Home Type`: dtype="class_label", the type of home
148
+ - '0': multifamily
149
+ - '1': condo/co-op
150
+ - '2': SFR
151
+ - '3': all homes
152
+ - '4': all homes plus multifamily
153
+ - `Bedroom Count`: dtype="class_label", the number of bedrooms
154
+ - '0': 1-Bedroom
155
+ - '1': 2-Bedrooms
156
+ - '2': 3-Bedrooms
157
+ - '3': 4-Bedrooms
158
+ - '4': 5+-Bedrooms
159
+ - '5': All Bedrooms
160
+ - `Date`: dtype="timestamp[ms]", the date of the last day of the month for this data
161
+
162
+ Value Columns
163
+ - `Mid Tier ZHVI (Smoothed) (Seasonally Adjusted)`: dtype="float32",
164
+ - `Bottom Tier ZHVI (Smoothed) (Seasonally Adjusted)`: dtype="float32",
165
+ - `Top Tier ZHVI (Smoothed) (Seasonally Adjusted)`: dtype="float32",
166
+ - `ZHVI`: dtype="float32",
167
+ - `Mid Tier ZHVI`: dtype="float32"
168
+
169
+
170
+ ## HOME VALUES FORECASTS
171
+
172
+ <!-- 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. -->
173
+
174
+ <!-- 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. -->
175
+
176
+ Base Columns
177
+ - `Region ID`: dtype="string", a unique identifier for the region
178
+ - `Size Rank`: dtype="int32", a rank of the region's size
179
+ - `Region`: dtype="string", the name of the region
180
+ - `Region Type`: dtype="class_label", the type of region
181
+ - '0': county
182
+ - '1': city
183
+ - '2': zip
184
+ - '3': country
185
+ - '4': msa
186
+ - `State`: dtype="string", the US state abbreviation for the state containing the region
187
+ - `City`: dtype="string",
188
+ - `Metro`: dtype="string",
189
+ - `County`: dtype="string",
190
+ - `Home Type`: dtype="string", the type of home
191
+ - `Date`: dtype="timestamp[ms]", the date of these forecasts
192
+
193
+ Value Columns
194
+ - `Month Over Month % (Smoothed)`: dtype="float32",
195
+ - `Quarter Over Quarter % (Smoothed)`: dtype="float32",
196
+ - `Year Over Year % (Smoothed)`: dtype="float32"
197
+ - `Month Over Month % (Raw)`: dtype="float32"
198
+ - `Quarter Over Quarter % (Raw)`: dtype="float32"
199
+ - `Year Over Year % (Raw)`: dtype="float32"
200
+
201
+ ## NEW CONSTRUCTION
202
+
203
+ Base Columns
204
+ - `Region ID`: dtype="string", a unique identifier for the region
205
+ - `Size Rank`: dtype="int32", a rank of the region's size
206
+ - `Region`: dtype="string", the name of the region
207
+ - `Region Type`: dtype="class_label", the type of region
208
+ - '0': county
209
+ - '1': city
210
+ - '2': zip
211
+ - '3': country
212
+ - '4': msa
213
+ - `State`: dtype="string", the US state abbreviation for the state containing the region
214
+ - `Home Type`: dtype="class_label", the type of home
215
+ - '0': all homes
216
+ - '1': all homes plus multifamily
217
+ - '2': SFR
218
+ - '3': condo/co-op
219
+ - '4': multifamily
220
+ - `Date`: dtype="timestamp[ms]", the date of the last day of the month for this data
221
+
222
+ Value Columns
223
+ - `Median Sale Price`: dtype="float32", the median sale price of new construction homes that sold during the month in the specified region
224
+ - `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
225
+ - `Sales Count`: dtype="int32", the number of new construction homes that sold during the month in the specified region
226
+
227
+ ## RENTALS
228
+
229
+ Base Columns
230
+ - `Region ID`: dtype="string", a unique identifier for the region
231
+ - `Size Rank`: dtype="int32", a rank of the region's size
232
+ - `Region`: dtype="string", the name of the region
233
+ - `Region Type`: dtype="class_label", the type of region
234
+ - '0': county
235
+ - '1': city
236
+ - '2': zip
237
+ - '3': country
238
+ - '4': msa
239
+ - `State`: dtype="string", the US state abbreviation for the state containing the region
240
+ - `Home Type`: dtype="string", the type of home
241
+ - '0': all homes
242
+ - '1': all homes plus multifamily
243
+ - '2': SFR
244
+ - '3': condo/co-op
245
+ - '4': multifamily
246
+ - `Date`: dtype="timestamp[ms]", the date of the last day of the month for this data
247
+
248
+ Value Columns
249
+ - `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.
250
+ - `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.
251
+
252
+ ## SALES (TODO investigate columns)
253
+ <!-- Sale-to-List Ratio (mean/median): Ratio of sale vs. final list price. -->
254
+ <!-- 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. -->
255
+
256
+ Base Columns
257
+ - `Region ID`: dtype="string", a unique identifier for the region
258
+ - `Size Rank`: dtype="int32", a rank of the region's size
259
+ - `Region`: dtype="string", the name of the region
260
+ - `Region Type`: dtype="class_label", the type of region
261
+ - '0': county
262
+ - '1': city
263
+ - '2': zip
264
+ - '3': country
265
+ - '4': msa
266
+ - `State`: dtype="string", the US state abbreviation for the state containing the region
267
+ - `Home Type`: dtype="class_label", the type of home
268
+ - '0': all homes
269
+ - '1': all homes plus multifamily
270
+ - '2': SFR
271
+ - '3': condo/co-op
272
+ - '4': multifamily
273
+ - `Date`: dtype="timestamp[ms]", the date of the last day of the month for this data
274
+
275
+ Value Columns
276
+ - `Median Sale Price`: dtype="float32", The median price at which homes across various geographies were sold.
277
+ - `Median Sale Price per Sqft`: dtype="float32" The median price per square foot at which homes across various geographies were sold.
278
+ - `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.
279
+
280
+ ## DEFINITIONS OF HOME TYPES
281
+ - 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.
282
+ - SFR: single family residence
283
+ - condo/co-op: Condominium and co-operative homes.
284
+ - Multifamily 5+ units: Units in buildings with 5 or more housing units, that are not condominiums or co-ops.
285
+ <!-- - Duplex/Triplex/Quadplex: Housing units in buildings with 2, 3, or 4 housing units. -->
286
+
287
+ # Example Usage
288
+ ```python
289
+ from datasets import load_dataset
290
+
291
+ dataset = load_dataset("misikoff/zillow-viewer", 'home_values', trust_remote_code=True)
292
+ ```