# Zillow Agent Inventory Scraper (`propertyapi/zillow-agent-inventory-scraper`) Actor Gain visibility into any real estate agent's current portfolio with the Zillow Agent Inventory Scraper. This utility actor enables you to programmatically fetch all active property listings associated with a specific agent's profile - **URL**: https://apify.com/propertyapi/zillow-agent-inventory-scraper.md - **Developed by:** [Property API](https://apify.com/propertyapi) (community) - **Categories:** Developer tools, Real estate, Lead generation - **Stats:** 43 total users, 2 monthly users, 100.0% runs succeeded, 1 bookmarks - **User rating**: 5.00 out of 5 stars ## Pricing $19.99/month + usage To use this Actor, you pay a monthly rental fee to the developer. The rent is subtracted from your prepaid usage every month after the free trial period.You also pay for the Apify platform usage, which gets cheaper the higher Apify subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#rental-actors ## 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.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.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/platform/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 ## 📋 Zillow Agent Inventory Scraper ### 🏢 Introduction Gain visibility into any real estate agent's current portfolio with the **Zillow Agent Inventory Scraper**. This utility actor enables you to programmatically fetch all active property listings associated with a specific agent's profile. Ideal for tracking competitor inventory, analyzing agent performance, or aggregating listings from top performers, this tool parses Zillow agent pages to deliver structured data on every home they currently represent. > **Note**: Configured for the `agentActiveListings` data scope. --- ### 🎯 Key Features * **Portfolio Extraction**: Retrieve all active listings for any agent using their unique Zillow ID. * **Detailed Property Metadata**: Get essential details for each listing, including price, address, specs (beds/baths), and direct URLs. * **Pagination Support**: Iterate through multiple pages of listings to capture complete portfolios for high-volume agents. --- ### ⚙️ Configuration To use this actor, you simply need the target agent's identifier and the page you wish to view. #### Input Parameters | Parameter | Type | Necessity | Description | | :--- | :--- | :--- | :--- | | `zuid` | String | **Required** | The Zillow Agent Profile ID (e.g., `X1-ZUytn1phpg9b7t_5i26a`). | | `page_number` | Integer | **Required** | The page number of the agent's listings to scrape (start at `1`). | --- ### 📥 Input Example ```json { "zuid": "X1-ZUytn1phpg9b7t_5i26a", "page_number": 1 } ```` *** ### 📤 Sample Output The output is a structured JSON report of the listings found on the requested page. ```json { "status": "success", "page_number": 1, "agent_id": "X1-ZUytn1phpg9b7t_5i26a", "listings": [ { "listing_id": "20918231", "address": "456 Oak St, Seattle, WA 98101", "price": 750000, "details": { "beds": 4, "baths": 3, "sqft": 2400 }, "url": "https://www.zillow.com/homedetails/20918231_zpid/" } ] } ``` *** ### 💡 Best Practices - **Pagination Loops**: To get *all* listings for an agent, start with `page_number: 1` and increment the page number in subsequent runs until no results are returned. - **Agent Discovery**: Use the ZUIDs found in other Zillow scraping tasks (like property details) to feed this actor and explore related inventory. # Actor input Schema ## `zuid` (type: `string`): Enter Zillow User ID ## `page_number` (type: `integer`): Enter page number (default: 1) ## Actor input object example ```json { "zuid": "X1-ZUytn1phpg9b7t_5i26a", "page_number": 1 } ``` # Actor output Schema ## `overview` (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 '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "zuid": "X1-ZUytn1phpg9b7t_5i26a", "page_number": 1 }; // Run the Actor and wait for it to finish const run = await client.actor("propertyapi/zillow-agent-inventory-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 '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "zuid": "X1-ZUytn1phpg9b7t_5i26a", "page_number": 1, } # Run the Actor and wait for it to finish run = client.actor("propertyapi/zillow-agent-inventory-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 '{ "zuid": "X1-ZUytn1phpg9b7t_5i26a", "page_number": 1 }' | apify call propertyapi/zillow-agent-inventory-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=propertyapi/zillow-agent-inventory-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Zillow Agent Inventory Scraper", "description": "Gain visibility into any real estate agent's current portfolio with the Zillow Agent Inventory Scraper. This utility actor enables you to programmatically fetch all active property listings associated with a specific agent's profile", "version": "0.0", "x-build-id": "RoEgukjwpkiGNoLKP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/propertyapi~zillow-agent-inventory-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-propertyapi-zillow-agent-inventory-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/propertyapi~zillow-agent-inventory-scraper/runs": { "post": { "operationId": "runs-sync-propertyapi-zillow-agent-inventory-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/propertyapi~zillow-agent-inventory-scraper/run-sync": { "post": { "operationId": "run-sync-propertyapi-zillow-agent-inventory-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": { "zuid": { "title": "Zillow User ID (ZUID) ", "type": "string", "description": "Enter Zillow User ID " }, "page_number": { "title": "Page Number (default: 1)", "type": "integer", "description": "Enter page number (default: 1)" } } }, "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 } } } } } } } } } } ```