# Zillow \[Just 💰$0.8] — US Real Estate Listings & Rentals (`blackfalcondata/zillow-scraper`) Actor

💰 $0.80 per 1,000 listings. Scrape US real estate from zillow.com — for-sale, for-rent & recently-sold homes · Zestimate & Rent Zestimate valuations · year built · HOA fees · agent contacts · photos · GPS · radius search · incremental NEW/UPDATED/EXPIRED tracking.

- **URL**: https://apify.com/blackfalcondata/zillow-scraper.md
- **Developed by:** [Black Falcon Data](https://apify.com/blackfalcondata) (community)
- **Categories:** Real estate, Lead generation, Automation
- **Stats:** 2 total users, 1 monthly users, 76.9% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $1.20 / 1,000 results

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

### What does Zillow do?

Zillow Scraper extracts structured US real-estate listings from zillow.com — for sale, for rent, and recently sold. Every listing carries price, beds/baths, square footage, lot size, address with GPS, all listing photos, and broker/agent info. Zestimate is included where Zillow provides one on the listing. Detail enrichment (on by default) adds full description, year built, HOA fee, property history, tax history, assigned schools, and Rent Zestimate where Zillow provides one. Filter by price, beds, baths, sqft, property type, and an optional lat/long radius; paste any zillow.com search or property URL; and run incrementally to capture only new, changed, or expired listings.

**New to Apify?** [Sign up free](https://console.apify.com/sign-up?fpr=1h3gvi&fp_sid=ctaplain) and use the included $5 monthly platform credit to test this actor.

### Key features

<!-- KEY_FEATURES:START -->
- **📋 Deep property detail** — every listing is enriched (on by default) with the listing's own detail page: full description, year built, HOA fee, and more. Turn it off for faster, cheaper search-only records.
- **💵 Price & valuation** — structured list price, price-per-sqft, and Zillow's own Zestimate / Rent Zestimate estimates and assessed tax value, where Zillow provides them — compare against Zillow's own valuation without a separate lookup.
- **📧 Contact extraction** — best-effort regex extraction of contact emails and phone numbers from descriptions — emitted as `extractedEmails[]` and `extractedPhones[]` on every record.
- **🎯 Multi-location search** — pass several locations (city, ZIP, or neighborhood) in one run with a shared dedup state. Filter by price, beds, baths, sqft, property type, listing category, and an optional lat/long radius.
- **🔔 Notifications** — Telegram, Slack, Discord, WhatsApp Cloud API, and generic webhook out of the box. Pair with incremental for daily new-listing alerts without pipeline glue.
- **🔗 Paste-mode** — build the search you want on zillow.com, copy the result-page URL, and paste it. Mix in individual property URLs too; results dedupe by listing id.
- **📦 Compact mode** — AI-agent and MCP-friendly payloads with core fields only.
- **♻️ Incremental mode** — recurring runs emit and charge only for new or changed listings — first run builds the baseline. Price Drops Only turns a scheduled run into a price-cut monitor. Saves 80-95% on daily monitoring.
- **📤 Export anywhere** — Download as JSON, CSV, or Excel from the Apify Console, or stream live via the API and integrations (Make, Zapier, Google Sheets, n8n, …).
- **🔌 MCP connectors** — export results into Notion via Apify's MCP connectors — a clean run-summary page, no glue code. Opt-in via the App connector field.
<!-- KEY_FEATURES:END -->

### What data can you extract from Zillow?

Each result includes Core property fields (`zpid`, `listingId`, `title`, `url`, `status`, `statusDisplay`, `addressStreet`, and `addressFull`, and more) and detail fields when enrichment is enabled (`description`, `descriptionHtml`, `descriptionMarkdown`, and `descriptionLength`). In standard mode, all fields are always present — unavailable data points are returned as `null`, never omitted. In compact mode, only core fields are returned.

Enable detail enrichment in the input to get richer fields such as full descriptions where the source provides them.

### Input

The main inputs are a search keyword and a result limit. Additional filters and options are available in the input schema.

Key parameters:

- **`searchMode`** — Which listings to scrape. (default: `"for_sale"`)
- **`searchLocations`** — One or more locations: "City, ST" (e.g. "Austin, TX"), a ZIP code (e.g. "78704"), or a neighborhood. Each is searched independently. Leave empty if you only use Start URLs.
- **`propertyTypes`** — Restrict to one or more property types. Leave empty for all types. (default: `[]`)
- **`searchStatuses`** — Include additional statuses alongside active for-sale listings.
- **`keyword`** — Optional text that must appear in the listing (e.g. "pool", "waterfront").
- **`startUrls`** — Paste zillow.com search-result URLs (e.g. https://www.zillow.com/austin-tx/) or individual property URLs (e.g. https://www.zillow.com/homedetails/2600-Willow-St-Austin-TX-78702/29406653_zpid/). Search URLs read their location from the URL; the 🔁 Search Mode and filters below still apply.
- **`maxResults`** — Maximum listings to return (0 = full coverage). Full coverage works even for very large markets. (default: `100`)
- **`listingCategories`** — Restrict for-sale results to specific listing types (agent-listed, for-sale-by-owner, foreclosure, auction, new construction). Leave empty for all. For-sale searches only. Note: the derived listingCategory output field is best-effort — agent/foreclosure/new-construction are reliably labeled, but selecting FSBO or auction narrows the results returned without always individually labeling that category on the record.
- **`priceMin`** — Minimum listing price.
- **`priceMax`** — Maximum listing price.
- **`bedsMin`** — Minimum number of bedrooms.
- **`bedsMax`** — Maximum number of bedrooms.
- ...and 31 more parameters

### Input examples

**Homes for sale in a city** — Search one or more locations (city + state, ZIP code, or neighborhood). Detail enrichment is on by default.

→ Full listing records with price, beds/baths, sqft, address + GPS, photos, Zestimate, broker/agent info, plus full description, year built, HOA fee, property/tax history, and schools.

```json
{
  "searchMode": "for_sale",
  "searchLocations": [
    "Austin, TX"
  ],
  "includeDetails": true,
  "maxResults": 100
}
````

**Condos for rent with a price ceiling** — Filter by mode, property type, location, and a maximum monthly rent.

→ Rental listings within the price band, each with beds/baths, sqft, address, Rent Zestimate, and agent contact.

```json
{
  "searchMode": "for_rent",
  "searchLocations": [
    "Miami, FL"
  ],
  "propertyTypes": [
    "condo"
  ],
  "priceMax": 3000,
  "maxResults": 100
}
```

**Daily monitoring of a ZIP code** — Re-run on a schedule to capture only new and changed listings in a ZIP code.

→ Records tagged NEW / UPDATED / EXPIRED against the previous run, with priceChange populated on price drops.

```json
{
  "searchMode": "for_sale",
  "searchLocations": [
    "78704"
  ],
  "incrementalMode": true,
  "stateKey": "austin-78704-for-sale",
  "maxResults": 500
}
```

**Compact output for AI pipelines** — Return only the core comparison fields for a smaller, faster export — detail enrichment off.

→ Core fields only (zpid, URL, status, price, beds/baths, sqft, address, GPS) — ideal for large exports and LLM context.

```json
{
  "searchMode": "for_sale",
  "searchLocations": [
    "Dallas, TX"
  ],
  "includeDetails": false,
  "compact": true,
  "maxResults": 100
}
```

**Paste a search URL** — Build the search you want on zillow.com, copy the result-page URL, and paste it. The location and mode are read from the URL.

→ The listings from exactly that search, merged and deduplicated.

```json
{
  "startUrls": [
    "https://www.zillow.com/seattle-wa/"
  ],
  "maxResults": 100
}
```

### Output

Each run produces a dataset of structured property records. Results can be downloaded as JSON, CSV, or Excel from the Dataset tab in Apify Console.

### Example property record

```json
{
  "zpid": "15086376",
  "listingId": "f9b84a01bcb9802e9f83511ffe753bb339d1ae4070f1ebec93ef6581529e3c9d",
  "title": "1030 Oak St, San Francisco, CA 94117",
  "url": "https://www.zillow.com/homedetails/1030-Oak-St-San-Francisco-CA-94117/15086376_zpid/",
  "status": "FOR_SALE",
  "statusDisplay": "Condo for sale",
  "addressStreet": "1030 Oak St",
  "addressFull": "1030 Oak St, San Francisco, CA 94117",
  "city": "San Francisco",
  "state": "CA",
  "postalCode": "94117",
  "latitude": 37.773426,
  "longitude": -122.43635,
  "propertyType": "CONDO",
  "beds": 2,
  "bathsTotal": 2,
  "sqft": 1417,
  "lotSize": 2813.976,
  "lotSizeUnit": "sqft",
  "price": 1499000,
  "priceFormatted": "$1,499,000",
  "priceCurrency": "USD",
  "pricePerSqft": 1058,
  "zestimate": 1556100,
  "taxAssessedValue": 1299404,
  "daysOnZillow": 2,
  "isForeclosure": false,
  "isOpenHouse": true,
  "isFsba": true,
  "listingCategory": "agent",
  "isFeatured": false,
  "isShowcase": true,
  "has3DModel": true,
  "hasVideo": false,
  "descriptionLength": 0,
  "thumbnail": "https://photos.zillowstatic.com/fp/2cf1ffe8e5425260af92579014899482-p_e.jpg",
  "photoCount": 37,
  "photos": [
    "https://photos.zillowstatic.com/fp/2cf1ffe8e5425260af92579014899482-p_e.jpg",
    "https://photos.zillowstatic.com/fp/1e10b7543be1dd7a68b67c7474e1e8cb-p_e.jpg",
    "https://photos.zillowstatic.com/fp/d8c01a5a6a730a332593bcbc4f461cd5-p_e.jpg",
    "https://photos.zillowstatic.com/fp/7eac3da5d324b89c0dee6bfb05f31db9-p_e.jpg",
    "https://photos.zillowstatic.com/fp/2fe56a05c52e98c8ac56e686f3fe92b3-p_e.jpg",
    "... 32 more items"
  ],
  "brokerName": "Fifty Hills Real Estate",
  "agentInfo": "Rebecca M Preece DRE #01924429",
  "sourceDomain": "zillow.com",
  "searchLocation": "San Francisco, CA",
  "scrapedAt": "2026-07-19T12:00:00.000Z",
  "contentQuality": "full",
  "contentHash": "cf09af960cc20b81a5da369e2bb4a9687205ba31f33b7153c5a3838383afd01e",
  "trackedHash": "50c86cf6bad1de582d793961e3344fcf77f351f1d15f15ea2d0cd4ad288cd99c"
}
```

### Incremental fields

When incremental mode is on, each record also carries:

- `changeType` — one of `NEW`, `UPDATED`, `UNCHANGED`, `REAPPEARED`, `EXPIRED`. Default output covers `NEW` / `UPDATED` / `REAPPEARED`; set `emitUnchanged: true` or `emitExpired: true` to opt into the others.
- `firstSeenAt`, `lastSeenAt` — ISO-8601 timestamps tracking the listing across runs.
- `isRepost`, `repostOfId`, `repostDetectedAt` — populated when a new listing matches the tracked content of a previously expired one. Set `skipReposts: true` to drop detected reposts from the output.

### How to scrape Zillow

1. Go to [Zillow](https://apify.com/blackfalcondata/zillow-scraper?fpr=1h3gvi) in Apify Console.
2. Enter a search keyword.
3. Set `maxResults` to control how many results you need.
4. Enable `includeDetails` if you need full descriptions.
5. Click **Start** and wait for the run to finish.
6. Export the dataset as JSON, CSV, or Excel.

### Use cases

- Extract property data from Zillow for market research and competitive analysis.
- Track pricing trends across regions and categories over time.
- Monitor new and changed properties on scheduled runs without processing the full dataset every time.
- Use structured location data for regional analysis, mapping, and geo-targeting.
- Feed structured data into AI agents, MCP tools, and automated pipelines using compact mode.
- Export clean, structured data to dashboards, spreadsheets, or data warehouses.

### How much does it cost to scrape Zillow?

Zillow uses [pay-per-event](https://docs.apify.com/platform/actors/paid-actors/pay-per-event) pricing. You pay a small fee when the run starts and then for each result that is actually produced.

- **Run start:** $0.003 per run
- **Per property (primary event):** $0.0012

You are billed only for the events your run actually triggers. Prices below are the Free plan tier.

| Event | Price (Free tier) | Charged when |
|---|---|---|
| Actor Start | $0.003 (one-time) | Charged when the Actor starts running. Number of events charged depends on Actor memory (one event per GB, minimum one event). |
| Result (primary) | $0.0012 | Single listing in the default dataset. |
| Detail enrichment | $0.0008 | Charged per listing enriched with the detail page (full description, year built, HOA fee, additional specs). Only when Include Detail Enrichment is on. |
| Email match | $0.002 | Charged per listing where a contact email was discovered. Only when Discover Contact Emails is on. |

Example costs (primary event only — other events above add cost when they fire):

- 10 results: **$0.015**
- 25 results: **$0.033**
- 100 results: **$0.12**
- 200 results: **$0.24**
- 500 results: **$0.6**

#### Example: recurring monitoring savings

These examples compare full re-scrapes with incremental runs at different churn rates. Churn is the share of properties that are new or whose tracked content changed since the previous run. Actual churn depends on your query breadth, source activity, and polling frequency — the scenarios below are examples, not predictions.

Example setup: 250 results per run, daily polling (30 runs/month). Event-pricing examples scale linearly with result count.

Numbers below are for the primary **Result** event. Other events (**Detail enrichment**, **Email match**) are billed separately when they fire.

| Churn rate | Full re-scrape run cost | Incremental run cost | Savings vs full re-scrape | Monthly cost after baseline |
|---|---:|---:|---:|---:|
| 5% — stable niche query | $0.30 | $0.02 | $0.28 (94%) | $0.54 |
| 15% — moderate broad query | $0.30 | $0.05 | $0.26 (84%) | $1.44 |
| 30% — high-volume aggregator | $0.30 | $0.09 | $0.21 (69%) | $2.79 |

Full re-scrape monthly cost at daily polling: $9.09. First month with incremental costs $0.82 / $1.70 / $3.00 for the 5% / 15% / 30% scenarios because the first run builds baseline state at full cost before incremental savings apply.

Platform usage (compute and proxies) is billed separately by Apify based on actual consumption. Incremental runs consume less on result processing, though fixed per-run overhead stays the same.

### FAQ

#### How many results can I get from Zillow?

The number of results depends on the search query and available properties on Zillow. Use the `maxResults` parameter to control how many results are returned per run.

#### Does Zillow support recurring monitoring?

Yes. Enable incremental mode to only receive new or changed properties on subsequent runs. This is ideal for scheduled monitoring where you want to track changes over time without re-processing the full dataset.

#### Can I integrate Zillow with other apps?

Yes. Zillow works with Apify's [integrations](https://apify.com/integrations?fpr=1h3gvi) to connect with tools like Zapier, Make, Google Sheets, Slack, and more. You can also use webhooks to trigger actions when a run completes.

#### Can I use Zillow with the Apify API?

Yes. You can start runs, manage inputs, and retrieve results programmatically through the [Apify API](https://docs.apify.com/api/v2). Client libraries are available for JavaScript, Python, and other languages.

#### Can I use Zillow through an MCP Server?

Yes. Apify provides an [MCP Server](https://apify.com/apify/actors-mcp-server?fpr=1h3gvi) that lets AI assistants and agents call this actor directly. Use compact mode, `descriptionMaxLength`, a single `descriptionFormat`, and `excludeEmptyFields` to keep payloads manageable for LLM context windows.

#### Is it legal to scrape Zillow?

This actor extracts publicly available data from Zillow. Web scraping of public information is generally considered legal, but you should always review the target site's terms of service and ensure your use case complies with applicable laws and regulations, including GDPR where relevant.

#### Your feedback

If you have questions, need a feature, or found a bug, please [open an issue](https://apify.com/blackfalcondata/zillow-scraper/issues?fpr=1h3gvi) on the actor's page in Apify Console. Your feedback helps us improve.

### You might also like

- [Airbnb Realtime API — Live Listing, Reviews & Search Lookups](https://apify.com/blackfalcondata/airbnb-realtime?fpr=1h3gvi) — Real-time Airbnb lookups via a persistent standby server — fetch a single listing, its reviews.
- [Airbnb Scraper — Listings, Prices, Reviews & Host Data](https://apify.com/blackfalcondata/airbnb-scraper?fpr=1h3gvi) — Scrape Airbnb stays — listings with price, ratings, amenities, host info, photos, GPS and full.
- [Airbnb URL Scraper — Fast, Cheap Listing URL Discovery](https://apify.com/blackfalcondata/airbnb-url-scraper?fpr=1h3gvi) — Discover every Airbnb listing URL for a city, neighborhood or search — the cheapest way to.
- [Bayut \[Just 💰$0.8\] — UAE Property Listings & Agents](https://apify.com/blackfalcondata/bayut-scraper?fpr=1h3gvi) — 💰 $0.80 per 1,000 rows across the UAE, Saudi Arabia, Qatar, Oman and Jordan. Scrape Bayut property.
- [Craigslist Scraper - Listings, Prices & Photos](https://apify.com/blackfalcondata/craigslist-scraper?fpr=1h3gvi) — Scrape craigslist.org listings across for-sale, housing, jobs, gigs and services. Get structured.
- [Domain.com.au \[Just 💰$0.05\] — Property Listings & Agents](https://apify.com/blackfalcondata/domain-com-au-scraper?fpr=1h3gvi) — Domain.com.au property scraper for Australian real estate — extract for-sale, rental, and sold.
- [HAR Texas Real Estate Scraper](https://apify.com/blackfalcondata/har-scraper?fpr=1h3gvi) — Scrape har.com — the largest Texas MLS portal — for homes for sale, rent and sold in every Texas.
- [Harcourts Property Scraper — buy, rent, sold & leased](https://apify.com/blackfalcondata/harcourts-scraper?fpr=1h3gvi) — Scrape harcourts.net property listings across Australia, New Zealand and Fiji — price, bedrooms,.

### Getting started with Apify

New to Apify? [Create a free account with $5 credit](https://console.apify.com/sign-up?fpr=1h3gvi\&fp_sid=ctaplain) — no credit card required.

1. Sign up — $5 platform credit included
2. Open this actor and configure your input
3. Click **Start** — export results as JSON, CSV, or Excel

Need more later? [See Apify pricing](https://apify.com/pricing?fpr=1h3gvi).

### Disclaimer

This actor accesses only publicly available data on zillow.com. You are responsible for how you use the extracted data — in particular any personal information such as names, phone numbers, or email addresses — and for complying with Zillow's terms of use, applicable data-protection law (including the GDPR where it applies), and the anti-spam rules of your jurisdiction.

This actor is not affiliated with, endorsed by, or connected to Zillow.

### Search keywords

zillow scraper, zillow api, apify zillow, zillow data extraction, zillow.com scraper, zillow.com data, zillow.com api, property listings scraper, real estate data, property data.

# Actor input Schema

## `searchMode` (type: `string`):

Which listings to scrape.

## `searchLocations` (type: `array`):

One or more locations: "City, ST" (e.g. "Austin, TX"), a ZIP code (e.g. "78704"), or a neighborhood. Each is searched independently. Leave empty if you only use Start URLs.

## `propertyTypes` (type: `array`):

Restrict to one or more property types. Leave empty for all types.

## `searchStatuses` (type: `array`):

Include additional statuses alongside active for-sale listings.

## `keyword` (type: `string`):

Optional text that must appear in the listing (e.g. "pool", "waterfront").

## `startUrls` (type: `array`):

Paste zillow.com search-result URLs (e.g. https://www.zillow.com/austin-tx/) or individual property URLs (e.g. https://www.zillow.com/homedetails/2600-Willow-St-Austin-TX-78702/29406653\_zpid/). Search URLs read their location from the URL; the 🔁 Search Mode and filters below still apply.

## `maxResults` (type: `integer`):

Maximum listings to return (0 = full coverage). Full coverage works even for very large markets.

## `listingCategories` (type: `array`):

Restrict for-sale results to specific listing types (agent-listed, for-sale-by-owner, foreclosure, auction, new construction). Leave empty for all. For-sale searches only. Note: the derived listingCategory output field is best-effort — agent/foreclosure/new-construction are reliably labeled, but selecting FSBO or auction narrows the results returned without always individually labeling that category on the record.

## `priceMin` (type: `integer`):

Minimum listing price.

## `priceMax` (type: `integer`):

Maximum listing price.

## `bedsMin` (type: `integer`):

Minimum number of bedrooms.

## `bedsMax` (type: `integer`):

Maximum number of bedrooms.

## `bathsMin` (type: `integer`):

Minimum number of bathrooms.

## `sqftMin` (type: `integer`):

Minimum interior square footage.

## `sqftMax` (type: `integer`):

Maximum interior square footage.

## `centerLat` (type: `string`):

Optional radius filter — center latitude (decimal, e.g. 30.2672). Combine with Center Longitude + Radius to keep only listings within the radius.

## `centerLng` (type: `string`):

Radius filter — center longitude (decimal, e.g. -97.7431).

## `radiusKm` (type: `integer`):

Keep only listings within this many kilometres of the center point.

## `includeDetails` (type: `boolean`):

Fetch each listing's detail page: full description, year built, HOA fee, and additional structured specs beyond the search-card summary. On by default. Turn off for faster, cheaper search-only records.

## `enrichEmails` (type: `boolean`):

Best-effort agent/advertiser email discovery (billed per listing with a match).

## `descriptionMaxLength` (type: `integer`):

Truncate description to this many characters. 0 = no truncation.

## `descriptionFormat` (type: `string`):

Keep one description representation and drop the others to shrink payload.

## `excludeEmptyFields` (type: `boolean`):

Drop null / empty-string / empty-array fields from each record.

## `compact` (type: `boolean`):

Output only core comparison fields (for AI-agent / MCP workflows).

## `incrementalMode` (type: `boolean`):

Track new/changed/expired listings across runs. Requires a State Key.

## `stateKey` (type: `string`):

Stable identifier for this tracking universe (e.g. "austin-tx-for-sale").

## `emitUnchanged` (type: `boolean`):

When incremental, also emit listings that have not changed.

## `emitExpired` (type: `boolean`):

When incremental, also emit listings no longer found (now off-market). These off-market markers are always included so change tracking stays complete — they are not subject to Max Results.

## `skipReposts` (type: `boolean`):

When incremental, skip listings that are reposts of previously seen (now expired) listings.

## `priceDropsOnly` (type: `boolean`):

When incremental tracking is on, emit only listings whose price dropped since the last run — turn a scheduled run into a price-cut monitor. Requires Incremental Mode + a prior run to compare against.

## `telegramToken` (type: `string`):

Telegram bot token (from @BotFather). Required for Telegram notifications.

## `telegramChatId` (type: `string`):

Telegram chat or channel ID where alerts are sent.

## `discordWebhookUrl` (type: `string`):

Discord incoming webhook URL.

## `slackWebhookUrl` (type: `string`):

Slack incoming webhook URL.

## `whatsappPhoneNumberId` (type: `string`):

WhatsApp Business phone number ID from Meta Business Manager.

## `whatsappAccessToken` (type: `string`):

Meta Cloud API access token with whatsapp\_business\_messaging scope.

## `whatsappTo` (type: `string`):

Recipient phone number in E.164 format (e.g. +14155551234).

## `webhookUrl` (type: `string`):

Universal escape hatch for n8n / Make / Zapier / custom HTTP backends. Receives a JSON POST per run.

## `webhookHeaders` (type: `object`):

Additional HTTP headers sent with the generic webhook POST.

## `notificationLimit` (type: `integer`):

Maximum number of listings included in each notification message (1–20).

## `notifyOnlyChanges` (type: `boolean`):

When Incremental Mode is on, only notify for NEW and UPDATED listings.

## `appConnector` (type: `string`):

Optional. Pick a connected app under Settings → API & Integrations to receive your results (including contact details where available). A run-summary is written to the connected app; support is best-effort as Apify expands its connector catalog.

## `mcpIssueTeam` (type: `string`):

Only when the connected app is an issue tracker: the team (name or ID) the summary issue is created under, if that app requires one.

## `cityName` (type: `string`):

City name (e.g. "Paris", "Lyon"). Resolved to the nearest known city.

## `lat` (type: `number`):

GPS latitude. Pair with lon. Ignored when cityName is set.

## `lon` (type: `number`):

GPS longitude. Pair with lat.

## `query` (type: `string`):

Listing search keywords. Enter a single term or a JSON array for multi-query runs.

## Actor input object example

```json
{
  "searchMode": "for_sale",
  "searchLocations": [
    "Austin, TX"
  ],
  "propertyTypes": [],
  "startUrls": [],
  "maxResults": 10,
  "listingCategories": [],
  "includeDetails": true,
  "enrichEmails": false,
  "descriptionMaxLength": 0,
  "descriptionFormat": "text",
  "excludeEmptyFields": false,
  "compact": false,
  "incrementalMode": false,
  "emitUnchanged": false,
  "emitExpired": false,
  "skipReposts": false,
  "priceDropsOnly": false,
  "notificationLimit": 5,
  "notifyOnlyChanges": false
}
```

# Actor output Schema

## `results` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "searchLocations": [
        "Austin, TX"
    ],
    "propertyTypes": [],
    "startUrls": [],
    "maxResults": 10,
    "listingCategories": [],
    "includeDetails": false
};

// Run the Actor and wait for it to finish
const run = await client.actor("blackfalcondata/zillow-scraper").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "searchLocations": ["Austin, TX"],
    "propertyTypes": [],
    "startUrls": [],
    "maxResults": 10,
    "listingCategories": [],
    "includeDetails": False,
}

# Run the Actor and wait for it to finish
run = client.actor("blackfalcondata/zillow-scraper").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "searchLocations": [
    "Austin, TX"
  ],
  "propertyTypes": [],
  "startUrls": [],
  "maxResults": 10,
  "listingCategories": [],
  "includeDetails": false
}' |
apify call blackfalcondata/zillow-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=blackfalcondata/zillow-scraper",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Zillow [Just 💰$0.8] — US Real Estate Listings & Rentals",
        "description": "💰 $0.80 per 1,000 listings. Scrape US real estate from zillow.com — for-sale, for-rent & recently-sold homes · Zestimate & Rent Zestimate valuations · year built · HOA fees · agent contacts · photos · GPS · radius search · incremental NEW/UPDATED/EXPIRED tracking.",
        "version": "0.1",
        "x-build-id": "eyaJKQPFPf5BECB3y"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/blackfalcondata~zillow-scraper/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-blackfalcondata-zillow-scraper",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        },
        "/acts/blackfalcondata~zillow-scraper/runs": {
            "post": {
                "operationId": "runs-sync-blackfalcondata-zillow-scraper",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor and returns information about the initiated run in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/runsResponseSchema"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/acts/blackfalcondata~zillow-scraper/run-sync": {
            "post": {
                "operationId": "run-sync-blackfalcondata-zillow-scraper",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "inputSchema": {
                "type": "object",
                "properties": {
                    "searchMode": {
                        "title": "🔁 Search Mode",
                        "enum": [
                            "for_sale",
                            "for_rent",
                            "sold"
                        ],
                        "type": "string",
                        "description": "Which listings to scrape.",
                        "default": "for_sale"
                    },
                    "searchLocations": {
                        "title": "📍 Locations",
                        "type": "array",
                        "description": "One or more locations: \"City, ST\" (e.g. \"Austin, TX\"), a ZIP code (e.g. \"78704\"), or a neighborhood. Each is searched independently. Leave empty if you only use Start URLs.",
                        "items": {
                            "type": "string"
                        }
                    },
                    "propertyTypes": {
                        "title": "🏠 Property Types",
                        "type": "array",
                        "description": "Restrict to one or more property types. Leave empty for all types.",
                        "items": {
                            "type": "string",
                            "enum": [
                                "single_family",
                                "condo",
                                "townhomes",
                                "multi_family",
                                "duplex_triplex",
                                "mobile",
                                "land",
                                "farm"
                            ],
                            "enumTitles": [
                                "Single family",
                                "Condo",
                                "Townhome",
                                "Multi-family",
                                "Duplex/Triplex",
                                "Mobile",
                                "Land",
                                "Farm"
                            ]
                        },
                        "default": []
                    },
                    "searchStatuses": {
                        "title": "🏷️ Extra Statuses (for-sale only)",
                        "type": "array",
                        "description": "Include additional statuses alongside active for-sale listings.",
                        "items": {
                            "type": "string",
                            "enum": [
                                "pending",
                                "contingent",
                                "coming_soon"
                            ],
                            "enumTitles": [
                                "Pending",
                                "Contingent",
                                "Coming soon"
                            ]
                        }
                    },
                    "keyword": {
                        "title": "🔤 Keyword",
                        "type": "string",
                        "description": "Optional text that must appear in the listing (e.g. \"pool\", \"waterfront\")."
                    },
                    "startUrls": {
                        "title": "🔗 Start URLs",
                        "type": "array",
                        "description": "Paste zillow.com search-result URLs (e.g. https://www.zillow.com/austin-tx/) or individual property URLs (e.g. https://www.zillow.com/homedetails/2600-Willow-St-Austin-TX-78702/29406653_zpid/). Search URLs read their location from the URL; the 🔁 Search Mode and filters below still apply.",
                        "items": {
                            "type": "string"
                        }
                    },
                    "maxResults": {
                        "title": "💯 Max Results",
                        "minimum": 0,
                        "type": "integer",
                        "description": "Maximum listings to return (0 = full coverage). Full coverage works even for very large markets.",
                        "default": 100
                    },
                    "listingCategories": {
                        "title": "🏷️ Listing Categories",
                        "type": "array",
                        "description": "Restrict for-sale results to specific listing types (agent-listed, for-sale-by-owner, foreclosure, auction, new construction). Leave empty for all. For-sale searches only. Note: the derived listingCategory output field is best-effort — agent/foreclosure/new-construction are reliably labeled, but selecting FSBO or auction narrows the results returned without always individually labeling that category on the record.",
                        "items": {
                            "type": "string",
                            "enum": [
                                "agent",
                                "fsbo",
                                "foreclosure",
                                "auction",
                                "new_construction"
                            ],
                            "enumTitles": [
                                "Agent-listed",
                                "For sale by owner",
                                "Foreclosure",
                                "Auction",
                                "New construction"
                            ]
                        }
                    },
                    "priceMin": {
                        "title": "💰 Min Price (USD)",
                        "minimum": 0,
                        "type": "integer",
                        "description": "Minimum listing price."
                    },
                    "priceMax": {
                        "title": "💰 Max Price (USD)",
                        "minimum": 0,
                        "type": "integer",
                        "description": "Maximum listing price."
                    },
                    "bedsMin": {
                        "title": "🛏️ Min Bedrooms",
                        "minimum": 0,
                        "type": "integer",
                        "description": "Minimum number of bedrooms."
                    },
                    "bedsMax": {
                        "title": "🛏️ Max Bedrooms",
                        "minimum": 0,
                        "type": "integer",
                        "description": "Maximum number of bedrooms."
                    },
                    "bathsMin": {
                        "title": "🛁 Min Bathrooms",
                        "minimum": 0,
                        "type": "integer",
                        "description": "Minimum number of bathrooms."
                    },
                    "sqftMin": {
                        "title": "📐 Min Sqft",
                        "minimum": 0,
                        "type": "integer",
                        "description": "Minimum interior square footage."
                    },
                    "sqftMax": {
                        "title": "📐 Max Sqft",
                        "minimum": 0,
                        "type": "integer",
                        "description": "Maximum interior square footage."
                    },
                    "centerLat": {
                        "title": "🧭 Center Latitude",
                        "type": "string",
                        "description": "Optional radius filter — center latitude (decimal, e.g. 30.2672). Combine with Center Longitude + Radius to keep only listings within the radius."
                    },
                    "centerLng": {
                        "title": "🧭 Center Longitude",
                        "type": "string",
                        "description": "Radius filter — center longitude (decimal, e.g. -97.7431)."
                    },
                    "radiusKm": {
                        "title": "📏 Radius (km)",
                        "minimum": 0,
                        "type": "integer",
                        "description": "Keep only listings within this many kilometres of the center point."
                    },
                    "includeDetails": {
                        "title": "📋 Include Detail Enrichment",
                        "type": "boolean",
                        "description": "Fetch each listing's detail page: full description, year built, HOA fee, and additional structured specs beyond the search-card summary. On by default. Turn off for faster, cheaper search-only records.",
                        "default": true
                    },
                    "enrichEmails": {
                        "title": "📧 Discover Contact Emails",
                        "type": "boolean",
                        "description": "Best-effort agent/advertiser email discovery (billed per listing with a match).",
                        "default": false
                    },
                    "descriptionMaxLength": {
                        "title": "✂️ Description Max Length",
                        "minimum": 0,
                        "type": "integer",
                        "description": "Truncate description to this many characters. 0 = no truncation.",
                        "default": 0
                    },
                    "descriptionFormat": {
                        "title": "📝 Description Format",
                        "enum": [
                            "text",
                            "html",
                            "markdown"
                        ],
                        "type": "string",
                        "description": "Keep one description representation and drop the others to shrink payload.",
                        "default": "text"
                    },
                    "excludeEmptyFields": {
                        "title": "🧹 Exclude Empty Fields",
                        "type": "boolean",
                        "description": "Drop null / empty-string / empty-array fields from each record.",
                        "default": false
                    },
                    "compact": {
                        "title": "📦 Compact Output",
                        "type": "boolean",
                        "description": "Output only core comparison fields (for AI-agent / MCP workflows).",
                        "default": false
                    },
                    "incrementalMode": {
                        "title": "♻️ Incremental Mode",
                        "type": "boolean",
                        "description": "Track new/changed/expired listings across runs. Requires a State Key.",
                        "default": false
                    },
                    "stateKey": {
                        "title": "🔑 State Key",
                        "type": "string",
                        "description": "Stable identifier for this tracking universe (e.g. \"austin-tx-for-sale\")."
                    },
                    "emitUnchanged": {
                        "title": "♻️ Emit Unchanged Records",
                        "type": "boolean",
                        "description": "When incremental, also emit listings that have not changed.",
                        "default": false
                    },
                    "emitExpired": {
                        "title": "⚰️ Emit Expired Records",
                        "type": "boolean",
                        "description": "When incremental, also emit listings no longer found (now off-market). These off-market markers are always included so change tracking stays complete — they are not subject to Max Results.",
                        "default": false
                    },
                    "skipReposts": {
                        "title": "🚫 Skip Reposts",
                        "type": "boolean",
                        "description": "When incremental, skip listings that are reposts of previously seen (now expired) listings.",
                        "default": false
                    },
                    "priceDropsOnly": {
                        "title": "📉 Price Drops Only",
                        "type": "boolean",
                        "description": "When incremental tracking is on, emit only listings whose price dropped since the last run — turn a scheduled run into a price-cut monitor. Requires Incremental Mode + a prior run to compare against.",
                        "default": false
                    },
                    "telegramToken": {
                        "title": "🔑 Telegram Bot Token",
                        "type": "string",
                        "description": "Telegram bot token (from @BotFather). Required for Telegram notifications."
                    },
                    "telegramChatId": {
                        "title": "💬 Telegram Chat ID",
                        "type": "string",
                        "description": "Telegram chat or channel ID where alerts are sent."
                    },
                    "discordWebhookUrl": {
                        "title": "🎮 Discord Webhook URL",
                        "type": "string",
                        "description": "Discord incoming webhook URL."
                    },
                    "slackWebhookUrl": {
                        "title": "💼 Slack Webhook URL",
                        "type": "string",
                        "description": "Slack incoming webhook URL."
                    },
                    "whatsappPhoneNumberId": {
                        "title": "📱 WhatsApp Phone Number ID",
                        "type": "string",
                        "description": "WhatsApp Business phone number ID from Meta Business Manager."
                    },
                    "whatsappAccessToken": {
                        "title": "🔐 WhatsApp Access Token",
                        "type": "string",
                        "description": "Meta Cloud API access token with whatsapp_business_messaging scope."
                    },
                    "whatsappTo": {
                        "title": "📨 WhatsApp Recipient",
                        "type": "string",
                        "description": "Recipient phone number in E.164 format (e.g. +14155551234)."
                    },
                    "webhookUrl": {
                        "title": "🪝 Generic Webhook URL",
                        "type": "string",
                        "description": "Universal escape hatch for n8n / Make / Zapier / custom HTTP backends. Receives a JSON POST per run."
                    },
                    "webhookHeaders": {
                        "title": "🪝 Webhook Headers (optional)",
                        "type": "object",
                        "description": "Additional HTTP headers sent with the generic webhook POST."
                    },
                    "notificationLimit": {
                        "title": "📊 Max Listings Per Notification",
                        "minimum": 1,
                        "maximum": 20,
                        "type": "integer",
                        "description": "Maximum number of listings included in each notification message (1–20).",
                        "default": 5
                    },
                    "notifyOnlyChanges": {
                        "title": "🔄 Notify Only New/Updated",
                        "type": "boolean",
                        "description": "When Incremental Mode is on, only notify for NEW and UPDATED listings.",
                        "default": false
                    },
                    "appConnector": {
                        "title": "📤 Send results to a connected app",
                        "type": "string",
                        "description": "Optional. Pick a connected app under Settings → API & Integrations to receive your results (including contact details where available). A run-summary is written to the connected app; support is best-effort as Apify expands its connector catalog."
                    },
                    "mcpIssueTeam": {
                        "title": "🏷️ Issue tracker team",
                        "type": "string",
                        "description": "Only when the connected app is an issue tracker: the team (name or ID) the summary issue is created under, if that app requires one."
                    },
                    "cityName": {
                        "title": "🏙️ City Name",
                        "type": "string",
                        "description": "City name (e.g. \"Paris\", \"Lyon\"). Resolved to the nearest known city."
                    },
                    "lat": {
                        "title": "🌐 Latitude",
                        "minimum": -90,
                        "maximum": 90,
                        "type": "number",
                        "description": "GPS latitude. Pair with lon. Ignored when cityName is set."
                    },
                    "lon": {
                        "title": "🌐 Longitude",
                        "minimum": -180,
                        "maximum": 180,
                        "type": "number",
                        "description": "GPS longitude. Pair with lat."
                    },
                    "query": {
                        "title": "🔍 Search Term(s)",
                        "type": "string",
                        "description": "Listing search keywords. Enter a single term or a JSON array for multi-query runs."
                    }
                }
            },
            "runsResponseSchema": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "actId": {
                                "type": "string"
                            },
                            "userId": {
                                "type": "string"
                            },
                            "startedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "finishedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "status": {
                                "type": "string",
                                "example": "READY"
                            },
                            "meta": {
                                "type": "object",
                                "properties": {
                                    "origin": {
                                        "type": "string",
                                        "example": "API"
                                    },
                                    "userAgent": {
                                        "type": "string"
                                    }
                                }
                            },
                            "stats": {
                                "type": "object",
                                "properties": {
                                    "inputBodyLen": {
                                        "type": "integer",
                                        "example": 2000
                                    },
                                    "rebootCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "restartCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "resurrectCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "computeUnits": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "options": {
                                "type": "object",
                                "properties": {
                                    "build": {
                                        "type": "string",
                                        "example": "latest"
                                    },
                                    "timeoutSecs": {
                                        "type": "integer",
                                        "example": 300
                                    },
                                    "memoryMbytes": {
                                        "type": "integer",
                                        "example": 1024
                                    },
                                    "diskMbytes": {
                                        "type": "integer",
                                        "example": 2048
                                    }
                                }
                            },
                            "buildId": {
                                "type": "string"
                            },
                            "defaultKeyValueStoreId": {
                                "type": "string"
                            },
                            "defaultDatasetId": {
                                "type": "string"
                            },
                            "defaultRequestQueueId": {
                                "type": "string"
                            },
                            "buildNumber": {
                                "type": "string",
                                "example": "1.0.0"
                            },
                            "containerUrl": {
                                "type": "string"
                            },
                            "usage": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "integer",
                                        "example": 1
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "usageTotalUsd": {
                                "type": "number",
                                "example": 0.00005
                            },
                            "usageUsd": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "number",
                                        "example": 0.00005
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
