{ "openapi": "3.0.1", "info": { "title": "Zillow Scraper - Listings & Property Details", "description": "Search Zillow homes for sale, for rent or recently sold by city, ZIP code or search link, or paste property links. Each listing becomes one row with price, beds, baths, area, address, coordinates, Zestimate, rent estimate, days on Zillow, photos and broker. Failures are reported, not charged.", "version": "0.1", "x-build-id": "sCsoUo0J9jYd2PjJF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/barefoot_grade~zillow-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-barefoot_grade-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/barefoot_grade~zillow-scraper/runs": { "post": { "operationId": "runs-sync-barefoot_grade-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/barefoot_grade~zillow-scraper/run-sync": { "post": { "operationId": "run-sync-barefoot_grade-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": { "searchLocations": { "title": "Places to search", "type": "array", "description": "Cities, ZIP codes, neighborhoods, counties or states as you would type them on Zillow, for example \"Austin, TX\", \"78704\" or \"Brooklyn, NY\". Each place is searched with the listing type and filters below.", "items": { "type": "string", "minLength": 1 } }, "listingType": { "title": "Listing type", "enum": [ "forSale", "forRent", "sold" ], "type": "string", "description": "Which listings to return for the places above.", "default": "forSale" }, "searchUrls": { "title": "Zillow search links", "type": "array", "description": "Links copied from a Zillow search results page (zillow.com/austin-tx/, zillow.com/homes/for_rent/...). The link's own filters and map area are kept.", "items": { "type": "string", "minLength": 1 } }, "propertyUrls": { "title": "Property links or zpids", "type": "array", "description": "Zillow property links (zillow.com/homedetails/.../12345678_zpid/) or bare zpid numbers. Each becomes one row with the full property details.", "items": { "type": "string", "minLength": 1 } }, "includeDetails": { "title": "Add full property details to search results", "type": "boolean", "description": "Open each search result's property page to add the description, agent and broker, MLS number, year built, HOA fee, tax rate, all photos and price history when Zillow shows it. Slower than search results alone.", "default": false }, "maxItems": { "title": "Maximum results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Total cap on rows for the run, across every place, link and property.", "default": 100 }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Lowest price in US dollars (monthly rent for rentals)." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Highest price in US dollars (monthly rent for rentals)." }, "minBeds": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Only homes with at least this many bedrooms." }, "minBaths": { "title": "Minimum bathrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Only homes with at least this many bathrooms." }, "minSqft": { "title": "Minimum square feet", "minimum": 0, "type": "integer", "description": "Smallest living area in square feet." }, "maxSqft": { "title": "Maximum square feet", "minimum": 0, "type": "integer", "description": "Largest living area in square feet." }, "homeTypes": { "title": "Home types", "type": "array", "description": "Only these home types. Leave empty for all.", "items": { "type": "string", "enum": [ "house", "townhouse", "condo", "apartment", "multiFamily", "manufactured", "land" ], "enumTitles": [ "Houses", "Townhomes", "Condos/co-ops", "Apartments", "Multi-family", "Manufactured", "Lots/land" ] } }, "sort": { "title": "Sort order", "enum": [ "relevance", "newest", "priceLowToHigh", "priceHighToLow", "bedrooms", "bathrooms", "squareFeet", "lotSize" ], "type": "string", "description": "Order of the search results, as on Zillow.", "default": "relevance" } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }