{ "openapi": "3.0.1", "info": { "title": "Zoopla UK Properties Scraper", "description": "Scrape Zoopla.co.uk UK property listings for sale and to rent by location or URL. Returns price, beds, baths, address, coordinates, images; optional detail enrich. Cloudflare cleared via Apify Unblocker (GB). MCP-ready.", "version": "0.1", "x-build-id": "zes8gTeNTbOCW3LcL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khadinakbar~zoopla-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khadinakbar-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/khadinakbar~zoopla-scraper/runs": { "post": { "operationId": "runs-sync-khadinakbar-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/khadinakbar~zoopla-scraper/run-sync": { "post": { "operationId": "run-sync-khadinakbar-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 URLs to scrape. Auto-detects /for-sale/property/... and /to-rent/property/... search pages plus /for-sale/details/{id}/ and /to-rent/details/{id}/ detail pages. Pagination uses the pn query param. If empty, the Actor builds a search from searchLocation + channel. Only zoopla.co.uk URLs are supported.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchLocation": { "title": "Search Location", "type": "string", "description": "UK place name or area used when startUrls is empty (e.g. London, Manchester, Croydon). Converted to a Zoopla URL slug. For precise postcode areas, paste a Zoopla search URL into Start URLs instead.", "default": "London" }, "channel": { "title": "Search Channel", "enum": [ "BUY", "RENT" ], "type": "string", "description": "BUY = properties for sale. RENT = properties to rent. Used only when building a search from searchLocation; ignored when startUrls is set.", "default": "BUY" }, "minPrice": { "title": "Min Price (£)", "minimum": 0, "type": "integer", "description": "Minimum price in GBP. For BUY: asking price. For RENT: monthly rent. Leave empty for no minimum. Location searches only." }, "maxPrice": { "title": "Max Price (£)", "minimum": 0, "type": "integer", "description": "Maximum price in GBP. For BUY: asking price. For RENT: monthly rent. Leave empty for no maximum. Location searches only." }, "minBedrooms": { "title": "Min Bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Minimum bedrooms (0–10). Location searches only." }, "maxBedrooms": { "title": "Max Bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Maximum bedrooms (0–10). Location searches only." }, "propertyType": { "title": "Property Type Path", "enum": [ "", "houses", "flats", "bungalows", "land", "farms-land", "commercial" ], "type": "string", "description": "Optional Zoopla path segment replacing 'property' (houses, flats, bungalows, land, commercial, farms-land). Leave empty for all types. Location searches only.", "default": "" }, "includeSoldOrLet": { "title": "Include sold / let agreed", "type": "boolean", "description": "Include sold (BUY) or let-agreed (RENT) listings when Zoopla exposes them on the search. Defaults to false.", "default": false }, "sort": { "title": "Sort", "enum": [ "newest_listings", "highest_price", "lowest_price" ], "type": "string", "description": "Zoopla results_sort value for location searches.", "default": "newest_listings" }, "fetchPropertyDetails": { "title": "Fetch full property details", "type": "boolean", "description": "For each search hit, fetch the detail page to enrich description, tenure, and floor size when present. One extra Unblocker request per listing. Off by default — search JSON-LD already includes price, beds, baths, address, and coordinates.", "default": false }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum dataset rows to return (1–1000). Zoopla searches typically paginate ~25 listings per page and soft-cap near 1,000.", "default": 50 } } }, "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 } } } } } } } } } }