Skip to content
Scrappa Get API key
Zillow API 1 credit/request

Zillow Property Search

GET https://scrappa.co/api/zillow/search?latitude=47.6062&longitude=-122.3321&radius_mi=5&listing_category=category1&page_size=20

Search real estate listings across the United States. Query a bounding box, a centre point with a radius, a list of region ids, or a custom polygon, then narrow the results with price, bedroom, size and listing-status filters.

The response carries each listing in full, including its list price, value and rent estimates, address, property facts, media links and listing status.

Choosing an area

Use Zillow Autocomplete first to resolve a place into a region id or a bounding box. A centre point with radius_mi is converted into a bounding box for you.

Paging

Requests are capped so that page * page_size never exceeds 1000. Ask for up to 100 rows per page, or 1000 rows in a single call with page=1&page_size=1000.

Zillow Property Search 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/zillow/search?latitude=47.6062&longitude=-122.3321&radius_mi=5&listing_category=category1&page_size=20
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "data": {
        "listings": [],
        "count": 0,
        "total_matching_count": 0,
        "freshness": []
    }
}

Parameters

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

Runnable path

This endpoint has no required query parameters.

29 optional filters available.

latitude number Optional

Centre latitude of the search area.

Example value 47.6062
longitude number Optional

Centre longitude of the search area.

Example value -122.3321
radius_mi number Optional

Search radius around the centre point, up to 100 miles. Required with a latitude and longitude centre point unless a complete bounding box is given instead.

Example value 5
north_latitude number Optional

Northern bound of an explicit bounding box.

Example value 10
south_latitude number Optional

Southern bound of an explicit bounding box.

Example value 10
east_longitude number Optional

Eastern bound of an explicit bounding box.

Example value 10
west_longitude number Optional

Western bound of an explicit bounding box.

Example value 10
region_ids[] array Optional

Region ids from the autocomplete endpoint, up to 20.

Example value ["example"]
polygon string Optional

Custom search boundary as lat,lon|lat,lon|:lat,lon|lat,lon: points separated by |, polygons separated by |:.

Example value example
region_id_type integer Optional

How the region ids are interpreted: 0 state, 1 county, 2 city, 3 ZIP code, 5 neighborhood. The autocomplete endpoint returns the matching value as region_id_type.

Example value 10
sort_ascending boolean Optional

Sort lowest first instead of highest first.

Example value true
lot_size_min integer Optional

Smallest lot size in square feet.

Example value 10
include_off_market boolean Optional

Supplement the results with off-market listings. The totals reported then cover a larger population.

Example value true
listing_category string Optional

category1 for sale (default), category2 for rent, or all.

Example value category1
sort_order string Optional

One of relevance, price, beds, baths, yearBuilt, daysOn, featured, livingArea, lotArea, nearby, recentlyChanged, rentalDays, rentalPriorityScore.

Example value example
min_price integer Optional

Lowest list price to include.

Example value 10
max_price integer Optional

Highest list price to include.

Example value 10
min_beds integer Optional

Fewest bedrooms to include.

Example value 10
max_beds integer Optional

Most bedrooms to include.

Example value 10
min_baths integer Optional

Fewest bathrooms to include.

Example value 10
max_baths integer Optional

Most bathrooms to include.

Example value 10
living_area_min integer Optional

Smallest living area in square feet.

Example value 10
year_built_min integer Optional

Earliest construction year.

Example value 10
home_statuses[] array Optional

Statuses from one listing type only: for-sale statuses (fsba, fsbo, newConstruction, comingSoon, auction, foreclosure, foreclosed, preforeclosure), forRent, or recentlySold. Defaults to every for-sale status, or forRent when listing_category is category2.

Example value ["example"]
keywords string Optional

Free-text filter applied to listings.

Example value running shoes
zoom_level integer Optional

Map zoom level, 6 to 25.

Example value 10
page integer Optional

Page number, 1-based.

Example value 1
page_size integer Optional

Rows per page. page * page_size must not exceed 1000.

Example value 20
allow_empty boolean Optional

Return an empty result set for an area with no matches instead of raising.

Example value true

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/zillow/search?latitude=47.6062&longitude=-122.3321&radius_mi=5&listing_category=category1&page_size=20",
    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/search?latitude=47.6062&longitude=-122.3321&radius_mi=5&listing_category=category1&page_size=20');

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/search?latitude=47.6062&longitude=-122.3321&radius_mi=5&listing_category=category1&page_size=20', 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/search?latitude=47.6062&longitude=-122.3321&radius_mi=5&listing_category=category1&page_size=20',
    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/search?latitude=47.6062&longitude=-122.3321&radius_mi=5&listing_category=category1&page_size=20")
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/search?latitude=47.6062&longitude=-122.3321&radius_mi=5&listing_category=category1&page_size=20", 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/search?latitude=47.6062&longitude=-122.3321&radius_mi=5&listing_category=category1&page_size=20', 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/search?latitude=47.6062&longitude=-122.3321&radius_mi=5&listing_category=category1&page_size=20")
        .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());
        }
    }
}
Go
package main

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

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/zillow/search?latitude=47.6062&longitude=-122.3321&radius_mi=5&listing_category=category1&page_size=20", 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/search?latitude=47.6062&longitude=-122.3321&radius_mi=5&listing_category=category1&page_size=20"
C#
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/search?latitude=47.6062&longitude=-122.3321&radius_mi=5&listing_category=category1&page_size=20"));
            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/search?latitude=47.6062&longitude=-122.3321&radius_mi=5&listing_category=category1&page_size=20',
            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/search?latitude=47.6062&longitude=-122.3321&radius_mi=5&listing_category=category1&page_size=20")
        .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.

Example response fields

Scan these fields before integrating.

data
JSON Response
200 OK
{
    "data": {
        "listings": [],
        "count": 0,
        "total_matching_count": 0,
        "freshness": []
    }
}

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"
}
422

HTTP 422

The requested research file does not exist for the combination given.

422

HTTP 422

The family, geography and variant given do not identify a single research file.

422

HTTP 422

The named state or metropolitan area publishes no estimate-accuracy data.

422

HTTP 422

Zillow answered with a deterministic 4xx.

422

HTTP 422

The decoded building token resolved to a building at a different address than the slug names.

503

HTTP 503

The request reached the source, but what came back was a challenge or rate-limit page rather than the data.

503

HTTP 503

The request was served and answered with a 5xx.

503

HTTP 503

The request was sent and no answer came back before the deadline.

503

HTTP 503

No approved exit could be reached, so the request never reached the listing source.

503

HTTP 503

There was no usable approved exit to send the request through.

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.