Zillow Market Data

GET https://scrappa.co/api/zillow/market-data?family=zhvi&geography=Zip&variant=bdrmcnt_4&region_name=98052

Get monthly market time series for a geography: home value and rent indices, sale prices, transaction volume, days to close, sale-to-list ratios and inventory. Each series covers every place of the requested geography type, so a single request covers the whole country.

Geography is a filter, not a filename

Each file holds every place of one geography type. Set region_name, state, metro or county to narrow the rows to the places you want.

Comparables are scoped, not listed

Comparable properties come from running a listing search over the same area with the search endpoint. There is no separate comparable-sales array on this endpoint.

Run this endpoint

Zillow Market Data 1 credit/request

Get API key Open Playground

Request preview

GET

https://scrappa.co/api/zillow/market-data?family=zhvi&geography=Zip&variant=bdrmcnt_4&region_name=98052

Auth header: x-api-key
Cost: 1 credit/request

family = zhvi geography = Zip

Response preview

200 OK

{
    "data": {
        "places": [],
        "places_available": 0,
        "total_rows_matched": 0
    }
}

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

2 required parameters needed before sending a request.

9 optional filters available.

family geography

family


                                        string

Required

Dataset family, for example zhvi, zori or invt_fs.

Example value


                                        zhvi

geography


                                        string

Required

City, County, Metro, National, Neighborhood, State or Zip.

Example value

Zip

region_name


                                        string

Optional

Filter rows to one place by name.

Example value

state


                                        string

Optional

Filter rows to one state.

Example value


                                        example

metro


                                        string

Optional

Filter rows to one metropolitan area.

Example value


                                        example

county


                                        string

Optional

Filter rows to one county.

Example value


                                        example

segment


                                        string

Optional

Property-type segment for families other than the home value and rent indices.

Example value


                                        example

stat


                                        string

Optional

Statistic suffix such as sm (smoothed mean) or sa (seasonal average).

Example value


                                        example

variant


                                        string

Optional

Metric variant such as bdrmcnt_4 or tier_0.33_0.67. Required when a family and geography match more than one dataset.

Example value


                                        bdrmcnt_4

limit


                                        integer

Optional

Maximum places to return, up to 500 per page.

Example value

offset


                                        integer

Optional

Matching places to skip before the page starts. Use it to reach places past the first 500.

Example value

Request Examples

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/zillow/market-data?family=zhvi&geography=Zip&variant=bdrmcnt_4&region_name=98052",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-api-key: YOUR_API_KEY_HERE"
    ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}

PHP

<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/zillow/market-data?family=zhvi&geography=Zip&variant=bdrmcnt_4&region_name=98052');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}

JavaScript

const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/zillow/market-data?family=zhvi&geography=Zip&variant=bdrmcnt_4&region_name=98052', options)
    .then(response => {
        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return response.text();
    })
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));

JavaScript

const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/zillow/market-data?family=zhvi&geography=Zip&variant=bdrmcnt_4&region_name=98052',
    headers: {
        x-api-key: 'YOUR_API_KEY_HERE',
    }
};

try {
    const response = await axios(options);
    console.log(response.data);
} catch (error) {
    console.error('Error:', error.message);
}

Ruby

require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/zillow/market-data?family=zhvi&geography=Zip&variant=bdrmcnt_4&region_name=98052")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'

request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'

begin
    response = http.request(request)
    puts response.body
rescue => e
    puts "Error: #{e.message}"
end

Python

import http.client
import json

conn = http.client.HTTPSConnection("scrappa.co")

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    conn.request("GET", "/api/zillow/market-data?family=zhvi&geography=Zip&variant=bdrmcnt_4&region_name=98052", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()

Python

import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/zillow/market-data?family=zhvi&geography=Zip&variant=bdrmcnt_4&region_name=98052', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")

Java

import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class ApiExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("https://scrappa.co/api/zillow/market-data?family=zhvi&geography=Zip&variant=bdrmcnt_4&region_name=98052")
        .addHeader("x-api-key", "YOUR_API_KEY_HERE")
            .build();

        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.out.println("Error: " + response.code());
            }
        } catch (IOException e) {
            System.out.println("Error: " + e.getMessage());
        }
    }
}

package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/zillow/market-data?family=zhvi&geography=Zip&variant=bdrmcnt_4&region_name=98052", nil)
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }
    req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")

    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error making request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }

    fmt.Println(string(body))
}

Terminal

#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/zillow/market-data?family=zhvi&geography=Zip&variant=bdrmcnt_4&region_name=98052"

using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");

        try
        {
            var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/zillow/market-data?family=zhvi&geography=Zip&variant=bdrmcnt_4&region_name=98052"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}

TypeScript

import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/zillow/market-data?family=zhvi&geography=Zip&variant=bdrmcnt_4&region_name=98052',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();

RUST

use reqwest::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    let response = client
        .get("https://scrappa.co/api/zillow/market-data?family=zhvi&geography=Zip&variant=bdrmcnt_4&region_name=98052")
        .header("x-api-key", "YOUR_API_KEY_HERE")
        .send()
        .await?;

    println!("{}", response.text().await?);

    Ok(())
}

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Open in Playground

Example response fields

Scan these fields before integrating.

data

JSON Response

200 OK

{
    "data": {
        "places": [],
        "places_available": 0,
        "total_rows_matched": 0
    }
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

400

HTTP 400

A query parameter is missing, malformed, or outside its documented range. This is the only Zillow response that carries no error code: the body has a message and a field list and nothing else, so match it on the 400 status.

{
    "errors": {
        "page_size": [
            "The page size field must not be greater than 1000.",
            "page * page_size must not exceed 1000."
        ]
    },
    "message": "The request validation failed"
}

503

HTTP 503

The publisher changed the shape of a response or served a document that is not the expected file.

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.

Get API key Open Playground

Zillow Market Data

Geography is a filter, not a filename

Comparables are scoped, not listed

Endpoint

Parameters

Request Examples

Response Schema

Errors

HTTP 400

HTTP 422

HTTP 422

HTTP 422

HTTP 422

HTTP 422

HTTP 503

HTTP 503

HTTP 503

HTTP 503

HTTP 503

HTTP 503

Generate Code with AI

Try It Live