{ "openapi": "3.0.1", "info": { "title": "Zoopla UK Property Scraper", "description": "Scrape UK homes for sale or to rent from Zoopla by location or search URL: price, address, beds/baths/receptions, floor area, EPC, coordinates, price history and the listing agent's name and phone. Clean JSON for lead-gen and market research.", "version": "0.1", "x-build-id": "3FIj8dI4q0cIzaGX6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/xtracto~zoopla-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-xtracto-zoopla-property-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/xtracto~zoopla-property-scraper/runs": { "post": { "operationId": "runs-sync-xtracto-zoopla-property-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/xtracto~zoopla-property-scraper/run-sync": { "post": { "operationId": "run-sync-xtracto-zoopla-property-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": { "mode": { "title": "For sale or to rent", "enum": [ "for-sale", "to-rent" ], "type": "string", "description": "Which Zoopla market to search: properties for sale, or properties to rent.", "default": "for-sale" }, "locations": { "title": "Locations", "type": "array", "description": "One or more Zoopla location slugs to search, e.g. london, manchester, se15, bristol. Each becomes its own search.", "items": { "type": "string" } }, "searchUrls": { "title": "Zoopla search URLs (optional)", "type": "array", "description": "Optional. Paste full Zoopla search-results URLs (with your filters applied) instead of, or in addition to, locations. Copy the address-bar URL after searching on zoopla.co.uk. Example: https://www.zoopla.co.uk/for-sale/property/london/?price_max=750000", "items": { "type": "string" } }, "bedsMin": { "title": "Minimum bedrooms", "minimum": 0, "type": "integer", "description": "Optional filter: minimum number of bedrooms." }, "bedsMax": { "title": "Maximum bedrooms", "minimum": 0, "type": "integer", "description": "Optional filter: maximum number of bedrooms." }, "priceMin": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Optional filter: minimum price (GBP; per month for rentals)." }, "priceMax": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Optional filter: maximum price (GBP; per month for rentals)." }, "propertySubType": { "title": "Property type (optional)", "type": "string", "description": "Optional filter on property type, e.g. flats, terraced, detached, semi_detached, bungalow." }, "fetchDetail": { "title": "Fetch full property detail", "type": "boolean", "description": "When on, each listing is enriched from its property page: floor area, EPC rating, price history, full description, exact coordinates and the agent's phone. Turn off for faster, list-only runs.", "default": true }, "maxItems": { "title": "Max items total (0 = all)", "minimum": 0, "type": "integer", "description": "Overall cap on records pushed for the whole run. 0 = no limit.", "default": 100 }, "maxItemsPerSearch": { "title": "Max listings per search (0 = all)", "minimum": 0, "type": "integer", "description": "Cap the number of listings collected per location / search URL. Zoopla browsable results cap at ~1000 per search.", "default": 1000 }, "maxConcurrency": { "title": "Max concurrent searches", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many locations / search URLs to process in parallel. Keep low with residential proxies.", "default": 3 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Recommended: Apify Residential, country United Kingdom (GB). Zoopla is UK-focused and a UK residential proxy is the safest way to receive real data reliably.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "GB" } } } }, "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 } } } } } } } } } }