{ "openapi": "3.0.1", "info": { "title": "Zoopla Property Scraper", "description": "Scrape Zoopla listings for sale and to rent: price, address, bedrooms, property type, agent, listing date, images, floor area, EPC and price history. Works with any Zoopla search URL.", "version": "0.1", "x-build-id": "nAbupYh1ErFtFkynY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tortuga~zoopla-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tortuga-zoopla-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/tortuga~zoopla-scraper/runs": { "post": { "operationId": "runs-sync-tortuga-zoopla-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/tortuga~zoopla-scraper/run-sync": { "post": { "operationId": "run-sync-tortuga-zoopla-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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Zoopla search result pages to scrape, with any filters and sort applied in the browser, e.g. https://www.zoopla.co.uk/for-sale/property/london/ or https://www.zoopla.co.uk/to-rent/flats/manchester/?beds_min=2&price_max=1500. For-sale, to-rent and new-homes searches all work. A single listing URL (…/details/12345678/) is also accepted and returns that one listing with full details. Leave empty if you use Location instead.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "location": { "title": "Location", "type": "string", "description": "Alternative to Start URLs: a town, area, county or postcode, e.g. \"Manchester\", \"Kensington\", \"SW1A\", \"Leeds, West Yorkshire\". The actor asks Zoopla to resolve it; if several areas match (e.g. \"Newport\"), the first match is used and the alternatives are listed in the run summary." }, "listingType": { "title": "Listing type", "enum": [ "sale", "rent" ], "type": "string", "description": "Used with Location: properties for sale or to rent.", "default": "sale" }, "minPrice": { "title": "Min price (GBP)", "minimum": 0, "type": "integer", "description": "Used with Location. Sale price, or monthly rent for rentals." }, "maxPrice": { "title": "Max price (GBP)", "minimum": 0, "type": "integer", "description": "Used with Location. Sale price, or monthly rent for rentals." }, "minBeds": { "title": "Min bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Used with Location. 0 = studio." }, "maxBeds": { "title": "Max bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Used with Location." }, "propertyType": { "title": "Property type", "enum": [ "", "houses", "flats", "bungalows", "farms_land", "park_homes" ], "type": "string", "description": "Used with Location. Zoopla's property groups.", "default": "" }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Stop after this many listings in total (across all start URLs). Keeps cost predictable. Zoopla shows 25 listings per page (plus 3 featured) and caps any search at 40 pages, so narrow the search (price band, area) to get more than ~1,000 results.", "default": 100 }, "includeDetails": { "title": "Include listing details", "type": "boolean", "description": "Also open every listing page to get the full description, key features, floor plans, EPC rating, council tax band, tenure and lease details, service charge, utilities/parking, full postcode, brochure and video links, price history with prices, and nearby stations and schools. About 2 extra requests per listing; charged extra per listing (see pricing).", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Zoopla's Cloudflare protection blocks datacenter IPs, so residential Apify Proxy is the default. Proxy usage is billed to your account.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }