{ "openapi": "3.0.1", "info": { "title": "Zillow Group Scraper - Zillow, Trulia & HotPads", "description": "Extract US property listings from Zillow, Trulia, and HotPads, including prices, bedrooms, addresses, and available contact details. Pay per delivered row plus a start fee.", "version": "0.4", "x-build-id": "if2uEPtOn8sllKhX8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~zillow-group-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-zillow-group-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/lentic_clockss~zillow-group-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-zillow-group-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/lentic_clockss~zillow-group-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-zillow-group-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": { "location": { "title": "Location", "maxLength": 160, "type": "string", "description": "US area to search, such as Austin, TX; Zillow also accepts recognized ZIP, county, and neighborhood locations. Use city and state for Trulia and HotPads." }, "locations": { "title": "Extra locations", "type": "array", "description": "Additional US areas to search in the same run; location is included too when filled. maxResults applies separately to each area.", "items": { "type": "string" } }, "detailUrls": { "title": "Property page URLs", "type": "array", "description": "Property or building page URLs from zillow.com, trulia.com, or hotpads.com, with mixed brands allowed. When set, location search is skipped and brand is detected from each URL; maxResults applies separately to each URL.", "items": { "type": "string" } }, "maxResults": { "title": "Maximum rows per input", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum rows per location or property URL, shared across its brands and listing types; default 70, with larger requests collected in parts of 70. The run also stops at your maximum cost or applicable free-plan limits.", "default": 70 }, "maxPages": { "title": "Legacy page preference", "minimum": 1, "maximum": 50, "type": "integer", "description": "Legacy page preference, not a page limit for current collection. Use maxResults to limit delivered rows.", "default": 1 }, "brand": { "title": "Brand", "enum": [ "zillow", "trulia", "hotpads", "all" ], "type": "string", "description": "Brand for location searches; all includes the supported paths for each brand and does not guarantee equal coverage. Ignored when detailUrls is filled.", "default": "zillow" }, "channel": { "title": "Channel", "enum": [ "", "sale", "rent", "sold", "new_homes", "building", "zestimate", "mortgage" ], "type": "string", "description": "Overrides listingType when filled: Zillow supports sale, rent, and sold; Trulia supports sale and rent; HotPads returns rentals only. The specialty options marked not available must not be selected.", "default": "" }, "listingType": { "title": "Listing type", "enum": [ "sale", "rent", "sold", "both", "all", "new_homes", "building", "zestimate", "mortgage" ], "type": "string", "description": "Used when channel is empty: both requests sale and rent, while all also requests sold listings. Coverage depends on brand; the specialty options marked not available must not be selected.", "default": "sale" }, "geoType": { "title": "Location hint (not applied)", "enum": [ "auto", "city", "zip", "county", "neighborhood", "state" ], "type": "string", "description": "This hint is not applied to current searches. Leave auto selected.", "default": "auto" }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Zillow search only: house, condo, townhouse, apartment, land, or multi_family. Not applied to Trulia, HotPads, or direct property URLs.", "default": [], "items": { "type": "string" } }, "saleStatuses": { "title": "Sale status filter (not available)", "type": "array", "description": "Not applied to current searches. Leave empty.", "default": [], "items": { "type": "string" } }, "minBeds": { "title": "Min bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Minimum bedroom count for Zillow searches only. Leave empty for no limit; not applied to Trulia, HotPads, or direct property URLs." }, "maxBeds": { "title": "Max bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Maximum bedroom count for Zillow searches only. Leave empty for no limit; not applied to Trulia, HotPads, or direct property URLs." }, "minBaths": { "title": "Min bathrooms", "minimum": 0, "maximum": 20, "type": "number", "description": "This filter is not applied to current searches. Leave empty and filter the exported rows when the corresponding value is available." }, "maxBaths": { "title": "Max bathrooms", "minimum": 0, "maximum": 20, "type": "number", "description": "This filter is not applied to current searches. Leave empty and filter the exported rows when the corresponding value is available." }, "minPrice": { "title": "Min price (USD)", "minimum": 0, "type": "integer", "description": "Minimum price in USD for Zillow searches only. Leave empty for no limit; not applied to Trulia, HotPads, or direct property URLs." }, "maxPrice": { "title": "Max price (USD)", "minimum": 0, "type": "integer", "description": "Maximum price in USD for Zillow searches only. Leave empty for no limit; not applied to Trulia, HotPads, or direct property URLs." }, "minSqft": { "title": "Min sqft", "minimum": 0, "type": "integer", "description": "This filter is not applied to current searches. Leave empty and filter the exported rows when the corresponding value is available." }, "maxSqft": { "title": "Max sqft", "minimum": 0, "type": "integer", "description": "This filter is not applied to current searches. Leave empty and filter the exported rows when the corresponding value is available." }, "minLotSqft": { "title": "Min lot sqft", "minimum": 0, "type": "integer", "description": "This filter is not applied to current searches. Leave empty and filter the exported rows when the corresponding value is available." }, "maxLotSqft": { "title": "Max lot sqft", "minimum": 0, "type": "integer", "description": "This filter is not applied to current searches. Leave empty and filter the exported rows when the corresponding value is available." }, "minYearBuilt": { "title": "Min year built", "minimum": 1800, "maximum": 2100, "type": "integer", "description": "This filter is not applied to current searches. Leave empty and filter the exported rows when the corresponding value is available." }, "maxYearBuilt": { "title": "Max year built", "minimum": 1800, "maximum": 2100, "type": "integer", "description": "This filter is not applied to current searches. Leave empty and filter the exported rows when the corresponding value is available." }, "maxHoa": { "title": "Max HOA", "minimum": 0, "type": "integer", "description": "This filter is not applied to current searches. Leave empty and filter the exported rows when the corresponding value is available." }, "maxDaysOnMarket": { "title": "Max days on market", "minimum": 0, "type": "integer", "description": "This filter is not applied to current searches. Leave empty and filter the exported rows when the corresponding value is available." }, "loanAmount": { "title": "Loan amount (mortgage)", "minimum": 0, "type": "integer", "description": "Mortgage lookups are not available. Leave empty." }, "creditBand": { "title": "Credit band (mortgage)", "type": "string", "description": "Mortgage lookups are not available. Leave empty." }, "ltv": { "title": "LTV % (mortgage)", "minimum": 0, "maximum": 100, "type": "number", "description": "Mortgage lookups are not available. Leave empty." }, "loanType": { "title": "Loan type (mortgage)", "type": "string", "description": "Mortgage lookups are not available. Leave empty." }, "includeRaw": { "title": "Include additional source data", "type": "boolean", "description": "Include available additional source fields in raw, such as Zillow property facts, photos, estimates, and history. Set false for compact rows.", "default": true }, "enrichDetails": { "title": "Add property details", "type": "boolean", "description": "Add available property and contact details to search rows. Enabled by default; it can take longer but does not create a separate billed row.", "default": true }, "expandUnits": { "title": "Expand building units (not available)", "type": "boolean", "description": "Individual building-unit expansion is not available. Leave false; apartment buildings are returned as listing rows.", "default": false }, "failover": { "title": "Retry collection", "type": "boolean", "description": "Allow another collection attempt when the first attempt fails or returns no rows. Leave enabled for normal use.", "default": true }, "workerBaseUrl": { "title": "Developer test setting", "type": "string", "description": "Leave empty. Used only by the developer for testing.", "default": "" } } }, "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 } } } } } } } } } }