{ "openapi": "3.0.1", "info": { "title": "Zoopla Scraper", "description": "[💰 $5 / 1K] Extract UK for-sale property listings from Zoopla — asking price, full address, postcode, beds, baths, property type, tenure, energy rating, photos, floor plans, GPS coordinates, plus estate-agent name and phone. Filter by location, price, beds, and type, or paste Zoopla URLs.", "version": "1.0", "x-build-id": "7nHFg1wszryl5MoLd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/solidcode~zoopla-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-solidcode-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/solidcode~zoopla-scraper/runs": { "post": { "operationId": "runs-sync-solidcode-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/solidcode~zoopla-scraper/run-sync": { "post": { "operationId": "run-sync-solidcode-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": { "searchLocations": { "title": "Search Locations", "type": "array", "description": "UK locations to search for properties for sale — a town, city, borough, or postcode (e.g. 'London', 'Manchester', 'SW1A'). Each entry runs its own search. Leave empty if you are pasting Start URLs below.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Power-user input. Paste Zoopla for-sale search-result URLs (e.g. https://www.zoopla.co.uk/for-sale/property/london/) or individual listing URLs. When provided, these override the Search Locations and Filters above — any filters in the URL are used as-is.", "items": { "type": "string" } }, "propertyType": { "title": "Property Type", "enum": [ "any", "houses", "flats", "detached", "semi-detached", "terraced", "bungalows", "land" ], "type": "string", "description": "Filter by property type. Choose 'Any' to include all. Only applies to Search Locations — ignored when using Start URLs.", "default": "any" }, "priceMin": { "title": "Minimum Price (£)", "minimum": 0, "type": "integer", "description": "Only include listings at or above this asking price in GBP. Leave empty for no minimum." }, "priceMax": { "title": "Maximum Price (£)", "minimum": 0, "type": "integer", "description": "Only include listings at or below this asking price in GBP. Leave empty for no maximum." }, "bedsMin": { "title": "Minimum Bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Only include properties with at least this many bedrooms (0 = studio). Leave empty for no minimum." }, "bedsMax": { "title": "Maximum Bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Only include properties with at most this many bedrooms. Leave empty for no upper limit." }, "addedToSite": { "title": "Listed Within", "enum": [ "anytime", "1", "3", "7", "14" ], "type": "string", "description": "Only include listings added to Zoopla within this period. Choose 'Any time' for no recency filter.", "default": "anytime" }, "sort": { "title": "Sort Order", "enum": [ "newest", "price-asc", "price-desc" ], "type": "string", "description": "How Zoopla orders results before we collect them.", "default": "newest" }, "maxResults": { "title": "Max Results", "minimum": 0, "type": "integer", "description": "Maximum number of listings to collect across all searches and URLs. Set to 0 for unlimited. Results are collected in full pages of about 25, so the final page may overshoot this cap by a few records. A single broad location search tops out near 1,000 results — add price, bedroom, or property-type filters to reach more, or the scraper will automatically split a wide search into price ranges to collect beyond that limit. Tip: start with 10-50 to test, then increase.", "default": 100 }, "includeDetails": { "title": "Include Full Property Details", "type": "boolean", "description": "Visit each property's own page to add the full description, tenure (freehold/leasehold), energy (EPC) rating, floor plans, exact room counts, and postcode. Leave off for a faster run — the standard fields (price, address, beds/baths, agent contact, photos, coordinates) are always included.", "default": false } } }, "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 } } } } } } } } } }