Zillow API in JavaScript

export PROPERTIESAPI_KEY="your_key_here"

const BASE = "https://api.propertiesapi.com/v1";
const headers = { "x-api-key": process.env.PROPERTIESAPI_KEY };

const url = new URL(`${BASE}/zillow/property`);
url.searchParams.set("url", "https://www.zillow.com/homedetails/2640-Steiner-St-San-Francisco-CA-94115/15073305_zpid/");
// or: url.searchParams.set("address", "2640 Steiner St, San Francisco, CA 94115");

const res = await fetch(url, { headers, signal: AbortSignal.timeout(120_000) });
if (!res.ok) throw new Error((await res.json()).error.message);
const { data: home, meta } = await res.json();

console.log(home.address, home.homeStatus, res.headers.get("x-cache"), `${meta.credits} credit(s)`);
console.log(`Price $${home.price?.toLocaleString()} · Zestimate $${home.zestimate?.toLocaleString()} · rent $${home.rentZestimate}/mo`);
console.log(`${home.beds} beds · ${home.baths} baths · ${home.livingArea} sqft · ${home.daysOnZillow} days on Zillow`);

type ZillowProperty = {
  zpid: string | null;
  detailUrl: string | null;
  address: string | null;
  city: string | null; state: string | null; zipcode: string | null;
  latitude: number | null; longitude: number | null;
  homeStatus: string | null;        // "FOR_SALE", "FOR_RENT", "RECENTLY_SOLD", "OFF_MARKET", ...
  price: number | null;
  zestimate: number | null;
  rentZestimate: number | null;
  beds: number | null; baths: number | null; livingArea: number | null;
  lotSize: number | null; yearBuilt: number | null; homeType: string | null;
  daysOnZillow: number | null;
  imgSrc: string | null;
  photos: string[];
  priceHistory: { date: string | null; event: string | null; price: number | null }[];
  taxHistory: { year: number | null; taxPaid: number | null; value: number | null }[];
  brokerName: string | null; agentName: string | null;
  // ...and more: see /docs/endpoints/property
};

type PropertyResponse = {
  data: ZillowProperty;
  meta: { credits: number; cached: boolean; cache_key: string; fetched_at: string; took_ms: number };
};

async function lookup(params: { url: string } | { address: string }): Promise<ZillowProperty | null> {
  const u = new URL(`${BASE}/zillow/property`);
  for (const [k, v] of Object.entries(params)) u.searchParams.set(k, v);

  for (let attempt = 0; attempt < 4; attempt++) {
    let r: Response;
    try {
      r = await fetch(u, { headers, signal: AbortSignal.timeout(120_000) });
    } catch {
      continue; // timed out: the live lookup took too long, try again
    }
    if (r.status === 404) return null;                  // no matching Zillow property
    if (r.status >= 500) {
      const wait = Number(r.headers.get("retry-after")) || 2 ** attempt;
      await new Promise((ok) => setTimeout(ok, wait * 1000));
      continue;
    }
    if (!r.ok) throw new Error((await r.json()).error.code); // 401 missing/invalid_api_key, 400 bad_param
    return ((await r.json()) as PropertyResponse).data;
  }
  throw new Error("lookup failed after retries");
}

export async function GET(req: Request) {
  const link = new URL(req.url).searchParams.get("url") ?? "";
  const u = new URL("https://api.propertiesapi.com/v1/zillow/property");
  u.searchParams.set("url", link);

  const r = await fetch(u, {
    headers: { "x-api-key": process.env.PROPERTIESAPI_KEY! },
    signal: AbortSignal.timeout(120_000),
  });
  const body = await r.json();
  return Response.json(r.ok ? body.data : body.error, { status: r.status });
}

import { readFile, writeFile } from "node:fs/promises";

const inputs = (await readFile("zillow-links.txt", "utf8")).split("\n").map((l) => l.trim()).filter(Boolean);
const found = [], failed = [];

for (let i = 0; i < inputs.length; i += 50) {
  const r = await fetch(`${BASE}/zillow/batch`, {
    method: "POST",
    headers: { ...headers, "content-type": "application/json" },
    body: JSON.stringify({ items: inputs.slice(i, i + 50) }), // links or addresses
    signal: AbortSignal.timeout(320_000),
  });
  if (!r.ok) throw new Error((await r.json()).error.message);
  for (const item of (await r.json()).data) (item.ok ? found : failed).push(item);
}

await writeFile("homes.json", JSON.stringify(found.map((x) => x.data), null, 2));
console.log(`${found.length} found, ${failed.length} failed (not billed)`);