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

Zillow Location & Address Lookup

GET https://scrappa.co/api/zillow/autocomplete?query=Redmond+WA

Resolve a place name, region or street address into the identifiers the other Zillow endpoints use. Each result carries a display name, a result type, coordinates, and where applicable a property id and region id.

Write freeform prefixes

Query with a freeform prefix such as Redmond WA or 98101. A comma-form address returns no results.

Check the city

An ambiguous street number can resolve to a different city than you meant, with no error. Compare the returned city and state against what you asked for before using a property id.

Zillow Location & Address Lookup 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/zillow/autocomplete?query=Redmond+WA
Auth header
x-api-key
Cost
1 credit/request
query = Redmond WA
Response preview
200 OK
{
    "data": {
        "results": [],
        "count": 0
    }
}

Parameters

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

Runnable path

1 required parameter needed before sending a request.

1 optional filter available.

query string Required

Freeform place prefix, for example "Redmond WA". A comma-form address returns no results.

Example value Redmond WA
result_count integer Optional

Maximum number of results, 1 to 20.

Example value 10

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/zillow/autocomplete?query=Redmond+WA",
    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/autocomplete?query=Redmond+WA');

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/autocomplete?query=Redmond+WA', 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/autocomplete?query=Redmond+WA',
    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/autocomplete?query=Redmond+WA")
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/autocomplete?query=Redmond+WA", 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/autocomplete?query=Redmond+WA', 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/autocomplete?query=Redmond+WA")
        .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/autocomplete?query=Redmond+WA", 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/autocomplete?query=Redmond+WA"
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/autocomplete?query=Redmond+WA"));
            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/autocomplete?query=Redmond+WA',
            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/autocomplete?query=Redmond+WA")
        .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": {
        "results": [],
        "count": 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"
}
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.