{ "openapi": "3.0.1", "info": { "title": "ZOOPLA | Buy | Rent | Sell | House Price | Agent | UPRN Scraper", "description": "Scrape Zoopla buy, rent, new homes, sold house prices, and estate agents. Search by town or postcode — no URL required. Full listing rows with UPRN price history, branch phone and address, optional agent emails, and an instant UK agent database when you skip the live crawl.", "version": "0.1", "x-build-id": "n1tivTcfVqt11z9y0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/memo23~zoopla-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-memo23-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/memo23~zoopla-scraper/runs": { "post": { "operationId": "runs-sync-memo23-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/memo23~zoopla-scraper/run-sync": { "post": { "operationId": "run-sync-memo23-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": { "locationQueries": { "title": "Locations (no URL needed)", "type": "array", "description": "Town, city, region, or UK postcode to search. One per line. Example: London, Manchester, NW3, Oxfordshire. Combined with Search type and the filters below. You can also paste Zoopla URLs in Start URLs instead (or as well).", "items": { "type": "string" } }, "searchType": { "title": "Search type", "enum": [ "for-sale", "to-rent", "new-homes", "sold", "agents" ], "type": "string", "description": "What to collect for each location query. for-sale = listings for sale. to-rent = rentals. new-homes = new-build listings. sold = Zoopla house-prices / sold-price pages. agents = estate-agent directory. Default: for-sale. Ignored for pasted Start URLs, which keep their own path.", "default": "for-sale" }, "minBeds": { "title": "Min bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Minimum bedrooms for location searches. Applied to for-sale, to-rent, and new-homes only. Example: 2. Leave empty for any." }, "maxBeds": { "title": "Max bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Maximum bedrooms for location searches. Applied to for-sale, to-rent, and new-homes only. Example: 4. Leave empty for any." }, "minPrice": { "title": "Min price (£)", "minimum": 0, "type": "integer", "description": "Minimum price in GBP for location searches. Sale = asking price. Rent = monthly rent. Example: 300000. Leave empty for any." }, "maxPrice": { "title": "Max price (£)", "minimum": 0, "type": "integer", "description": "Maximum price in GBP for location searches. Sale = asking price. Rent = monthly rent. Example: 750000. Leave empty for any." }, "radiusMiles": { "title": "Radius (miles)", "minimum": 0, "maximum": 40, "type": "integer", "description": "Search radius in miles around the location. Applied to for-sale, to-rent, and new-homes only. Example: 1. Leave empty to keep Zoopla's default (exact area)." }, "startUrls": { "title": "Start URLs (optional)", "type": "array", "description": "Zoopla URLs to start with. Accepts for-sale and to-rent search pages, listing detail pages, /new-homes/, /find-agents/, and /house-prices/. Example: https://www.zoopla.co.uk/for-sale/property/london/. Optional if Locations is set.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "includeWholePriceHistory": { "title": "Include full price history (UPRN)", "type": "boolean", "description": "If true, fetch Zoopla's property history for each listing that has a UPRN. Adds sold and listing-price history on the row. Default: true. Extra page per listing.", "default": true }, "enrichEmails": { "title": "Find agent contact emails", "type": "boolean", "description": "If true, look up a contact email for the listing's estate agent from the agent's public website (or by discovering the site from the branch name). Adds contactEmail, contactWebsite, and emailEnrichment. Best-effort, not guaranteed. Default: false.", "default": false }, "instantDatabase": { "title": "Instant agent database (no live scrape)", "type": "boolean", "description": "If true, return pre-collected UK estate-agent branches (office, phone, address, brand) from the accumulated database and exit. No Zoopla crawl, no proxy. Combine with the db* filters below. Default: false.", "default": false }, "dbBranchName": { "title": "DB filter — branch/agency name contains", "type": "string", "description": "Instant-database mode only. Return branches whose name contains this text. Example: Foxtons." }, "dbHasPhone": { "title": "DB filter — only branches with a phone", "type": "boolean", "description": "Instant-database mode only. If true, return only branches that have a phone number. Default: false.", "default": false }, "dbHasEmail": { "title": "DB filter — only branches with an email", "type": "boolean", "description": "Instant-database mode only. If true, return only branches that have an enriched email. Default: false.", "default": false }, "maxItems": { "title": "Max listings / items", "type": "integer", "description": "Maximum listings, sold-price rows, or agent branches to push per run. Default: 100. Always set this — an uncapped city-wide search can be tens of thousands of rows.", "default": 100 }, "maxConcurrency": { "title": "Max concurrency", "type": "integer", "description": "Maximum pages processed at the same time. Default: 10. Lower this if you see blocks.", "default": 10 }, "minConcurrency": { "title": "Min concurrency", "type": "integer", "description": "Minimum pages processed at the same time. Default: 1.", "default": 1 }, "maxRequestRetries": { "title": "Max request retries", "type": "integer", "description": "Times to retry a failed request before giving up. Default: 100.", "default": 100 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Proxy used for live Zoopla requests. Residential is the default. Instant-database mode does not use a proxy.", "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 } } } } } } } } } }