{ "openapi": "3.0.1", "info": { "title": "Zoopla Scraper", "description": "This Apify actor scrapes Zoopla UK property listings in three categories:\n\n List of location slugs for properties for sale.\n List of location slugs for rental properties.\n Direct URLs for complete property details. list of location slugs and retrieves rental property cards.", "version": "0.0", "x-build-id": "1ht4Jw2Us6WEP9zgz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/moving_beacon-owner1~zoopla-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-moving_beacon-owner1-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/moving_beacon-owner1~zoopla-scraper/runs": { "post": { "operationId": "runs-sync-moving_beacon-owner1-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/moving_beacon-owner1~zoopla-scraper/run-sync": { "post": { "operationId": "run-sync-moving_beacon-owner1-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": { "searchesForSale": { "title": "🏠 Locations — For sale", "type": "array", "description": "Zoopla location slugs to search for **properties for sale**. Examples: `london/islington`, `manchester`, `bristol/clifton`. Verify a slug works by visiting `https://www.zoopla.co.uk/for-sale/property/` first.", "default": [], "items": { "type": "string" } }, "searchesToRent": { "title": "🏘️ Locations — To rent", "type": "array", "description": "Zoopla location slugs to search for **rental properties**. Examples: `london/camden`, `birmingham`, `edinburgh/new-town`.", "default": [], "items": { "type": "string" } }, "maxSearchPages": { "title": "Max pages per search", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many search-result pages to scrape per location. Each page is browser-rendered (~6–10s of Chromium warmup), so values >10 can take many minutes per location.", "default": 1 }, "scrapeAllPages": { "title": "Scrape ALL available pages", "type": "boolean", "description": "If enabled, ignore `Max pages per search` and walk every available result page. Use with caution — large locations can have hundreds of pages.", "default": false }, "propertyUrls": { "title": "🏷️ Property URLs", "type": "array", "description": "Direct Zoopla property detail page URLs, e.g. `https://www.zoopla.co.uk/new-homes/details/70337559/`. Returns the rich property object including images, agent details, key features, and (when available) price history.", "default": [], "items": { "type": "string" } }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Zoopla applies anti-bot measures and is GB-locked for some content. Apify Proxy → Residential (UK) is recommended.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "GB" } }, "perTaskTimeoutSeconds": { "title": "Per-task timeout", "minimum": 60, "maximum": 900, "type": "integer", "description": "Max seconds to wait for any one search/URL before giving up and moving on.", "default": 240 }, "maxRetries": { "title": "Max retries on empty result", "minimum": 0, "maximum": 10, "type": "integer", "description": "If a search/URL returns 0 results, retry this many times (Zoopla intermittently serves blank pages to scrapers — retries usually fix it).", "default": 2 }, "retryDelaySeconds": { "title": "Delay between retries", "minimum": 0, "maximum": 120, "type": "integer", "description": "Seconds to wait between retry attempts. Gives the proxy pool time to rotate IPs.", "default": 5 } } }, "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 } } } } } } } } } }