{ "openapi": "3.0.1", "info": { "title": "Multi Purpose Zillow Data Scraper", "description": "Scrape Zillow property data (Rent, Sale, Sold) and deep home details fast! 🏡 Extract prices, units, addresses, and all image URLs using geographic bounding box filters. Perfect for market research and real estate lead gen. Professional Zillow extractor with clean JSON/CSV output.", "version": "0.0", "x-build-id": "YHq7SPl8f22y1wJk1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/eunit~multi-purpose-zillow-data-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-eunit-multi-purpose-zillow-data-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/eunit~multi-purpose-zillow-data-scraper/runs": { "post": { "operationId": "runs-sync-eunit-multi-purpose-zillow-data-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/eunit~multi-purpose-zillow-data-scraper/run-sync": { "post": { "operationId": "run-sync-eunit-multi-purpose-zillow-data-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", "required": [ "proxyConfiguration" ], "properties": { "scraper_type": { "title": "Scraper Type", "enum": [ "for_rent", "for_sale", "sold", "for_homes", "for_department" ], "type": "string", "description": "Select the type of scrape you want to perform.", "default": "for_rent" }, "search_value": { "title": "Search Query / Location", "type": "string", "description": "Enter a city, state, or ZIP code (e.g., 'Austin, TX'). Note: Geographic coordinates will override this if provided for search types." }, "property_url": { "title": "Property URL", "type": "string", "description": "Direct Zillow URL of the property (Required for 'Home Details' or 'Apartment Details' if ID is not provided)." }, "property_id": { "title": "Property ID (ZPID)", "type": "string", "description": "The ZPID of the property (Required for 'Home Details' or 'Apartment Details' if URL is not provided)." }, "search_parameters_section": { "title": "Search Parameters", "type": "object", "description": "Define min/max beds, baths, and price ranges.", "properties": { "min_price": { "title": "Minimum Price ($)", "description": "Minimum Price ($)", "type": "integer", "minimum": 0, "unit": "USD", "editor": "number" }, "max_price": { "title": "Maximum Price ($)", "description": "Maximum Price ($)", "type": "integer", "minimum": 0, "unit": "USD", "editor": "number" }, "min_beds": { "title": "Minimum Bedrooms", "description": "Minimum Bedrooms", "type": "integer", "minimum": 0, "editor": "number" }, "max_beds": { "title": "Maximum Bedrooms", "description": "Maximum Bedrooms", "type": "integer", "minimum": 0, "editor": "number" }, "min_bathrooms": { "title": "Minimum Bathrooms", "description": "Minimum Bathrooms", "type": "number", "minimum": 0, "editor": "number" }, "max_bathrooms": { "title": "Maximum Bathrooms", "description": "Maximum Bathrooms", "type": "number", "minimum": 0, "editor": "number" }, "is_entire_place": { "title": "Entire Place (Apartment/House)", "description": "For Rent only", "type": "boolean" }, "is_room": { "title": "Private Rooms (Roommate listings)", "description": "For Rent only", "type": "boolean" }, "pagination": { "title": "Pagination Page Number", "description": "Pagination Page Number", "type": "integer", "default": 1, "editor": "number" } } }, "geographic_section": { "title": "Geographic Boundary", "type": "object", "description": "Define the map area using coordinates.", "properties": { "ne_lat": { "title": "North East Latitude", "description": "North East Latitude", "type": "number" }, "ne_long": { "title": "North East Longitude", "description": "North East Longitude", "type": "number" }, "sw_lat": { "title": "South West Latitude", "description": "South West Latitude", "type": "number" }, "sw_long": { "title": "South West Longitude", "description": "South West Longitude", "type": "number" }, "zoom_value": { "title": "Zoom Level", "description": "Zoom Level", "type": "integer", "editor": "number" } } }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Select proxies to be used by your crawler. Residential proxies are recommended for Zillow." } } }, "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 } } } } } } } } } }