{ "openapi": "3.0.1", "info": { "title": "Zoopla UK Property Listings Scraper", "description": "Extract UK property listings from Zoopla — prices, bedrooms, bathrooms, square footage, property type, tenure, agent info, images, and full descriptions. Free preview caps at 10 listings. Perfect for estate agents, property researchers, and data analysts.", "version": "1.0", "x-build-id": "vSsJSJA9sF9bYaIzl" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~zoopla-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-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/parseforge~zoopla-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-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/parseforge~zoopla-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-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": { "startUrl": { "title": "Start URL", "type": "string", "description": "Direct Zoopla listing page URL to scrape. If provided, all filters below are ignored." }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000." }, "listingType": { "title": "Listing Type", "enum": [ "for-sale", "to-rent" ], "type": "string", "description": "Whether to search properties for sale or to rent." }, "location": { "title": "Location", "type": "string", "description": "City, area, or postcode to search in (e.g. 'London', 'Manchester', 'SW1A 1AA')." }, "minPrice": { "title": "Min Price (£)", "minimum": 0, "type": "integer", "description": "Minimum property price in GBP." }, "maxPrice": { "title": "Max Price (£)", "minimum": 0, "type": "integer", "description": "Maximum property price in GBP." }, "minBedrooms": { "title": "Min Bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Minimum number of bedrooms." }, "maxBedrooms": { "title": "Max Bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Maximum number of bedrooms." }, "propertyType": { "title": "Property Type", "enum": [ "", "detached", "semi-detached", "terraced", "flat", "bungalow", "land", "park-home" ], "type": "string", "description": "Type of property to search for." }, "radius": { "title": "Radius (miles)", "minimum": 0, "maximum": 40, "type": "number", "description": "Search radius in miles from the specified location (e.g. 0.25, 0.5, 1, 3, 5, 10, 20)." }, "addedSince": { "title": "Added Since", "enum": [ "", "24-hours", "3-days", "1-week", "2-weeks", "1-month" ], "type": "string", "description": "Only show listings added within this time period." }, "keywords": { "title": "Keywords", "type": "string", "description": "Keywords to search within property descriptions (e.g. 'garden', 'garage', 'period')." }, "furnishingType": { "title": "Furnishing Type (Rentals Only)", "enum": [ "", "furnished", "unfurnished", "part-furnished" ], "type": "string", "description": "Furnishing preference for rental properties only." }, "includeDetails": { "title": "Include Full Details", "type": "boolean", "description": "When enabled, fetches the full property detail page for each listing to extract additional fields (description, features, floor plans, transport links, nearby schools).", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Residential proxies are required for Zoopla (Cloudflare-protected)." } } }, "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 } } } } } } } } } }