{ "openapi": "3.0.1", "info": { "title": "Zoopla Scraper - UK Real Estate Listings", "description": "UK real estate listings scraper for Zoopla.co.uk. Search towns, areas, and postcodes for sale or rent, then export prices, photos, floor area, agents, features, coordinates, and details to JSON, CSV, Excel, or API workflows. Built for research, lead generation, and housing analytics.", "version": "0.0", "x-build-id": "pDUhB6TqgxGmSWMLb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/igolaizola~zoopla-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-igolaizola-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/igolaizola~zoopla-scraper/runs": { "post": { "operationId": "runs-sync-igolaizola-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/igolaizola~zoopla-scraper/run-sync": { "post": { "operationId": "run-sync-igolaizola-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", "required": [ "operation", "maxItems" ], "properties": { "query": { "title": "Location or postcode", "type": "string", "description": "Enter a UK town, city, area, or postcode. You may leave this blank when latitude and longitude are provided." }, "locationType": { "title": "Location type", "enum": [ "", "area", "postTown", "countyArea", "alias" ], "type": "string", "description": "Optionally filter matching locations by category. Leave blank to choose the first match.", "default": "" }, "operation": { "title": "Looking to", "enum": [ "sale", "rent" ], "type": "string", "description": "Choose whether to find homes for sale or to rent.", "default": "sale" }, "maxItems": { "title": "Maximum listings", "minimum": 0, "type": "integer", "description": "Maximum listings to collect. Use 0 to continue through all available pages.", "default": 50 }, "sort": { "title": "Sort listings by", "enum": [ "newest", "priceHighToLow", "priceLowToHigh" ], "type": "string", "description": "Choose how matching listings are ordered.", "default": "newest" }, "listedWithin": { "title": "Listed within", "enum": [ "", "last24Hours", "last3Days", "last7Days", "last14Days" ], "type": "string", "description": "Limit results to homes added recently.", "default": "" }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Only include homes at or above this price." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Only include homes at or below this price." }, "minBeds": { "title": "Minimum bedrooms", "minimum": 0, "type": "integer", "description": "Only include homes with at least this many bedrooms." }, "maxBeds": { "title": "Maximum bedrooms", "minimum": 0, "type": "integer", "description": "Only include homes with no more than this many bedrooms." }, "minBaths": { "title": "Minimum bathrooms", "minimum": 0, "type": "integer", "description": "Only include homes with at least this many bathrooms." }, "maxBaths": { "title": "Maximum bathrooms", "minimum": 0, "type": "integer", "description": "Only include homes with no more than this many bathrooms." }, "homeTypes": { "title": "Home types", "type": "array", "description": "Enter one or more home types: House, Flat or apartment, Detached house, Semi-detached house, Terraced house, Bungalow, or Maisonette.", "items": { "type": "string" } }, "furnishing": { "title": "Furnishing", "enum": [ "", "furnished", "unfurnished", "partFurnished" ], "type": "string", "description": "Choose a furnishing preference for rental listings.", "default": "" }, "keywords": { "title": "Must-have words", "type": "string", "description": "Only include listings containing these words, such as garden or parking." }, "searchRadiusMiles": { "title": "Search radius", "enum": [ "", "1", "3", "5", "10", "20", "30", "40" ], "type": "string", "description": "Choose how far from the selected location to search.", "default": "" }, "tenure": { "title": "Tenure", "enum": [ "any", "freehold", "leasehold" ], "type": "string", "description": "Choose the ownership type for homes for sale.", "default": "any" }, "minimumFloorAreaSqft": { "title": "Minimum floor area", "minimum": 0, "type": "integer", "description": "Only include homes with at least this floor area in square feet." }, "newHomes": { "title": "New homes only", "type": "boolean", "description": "Only include newly built homes.", "default": false }, "reducedPriceOnly": { "title": "Reduced price only", "type": "boolean", "description": "Only include listings showing a price reduction.", "default": false }, "includeSold": { "title": "Include sold homes", "type": "boolean", "description": "Include sold homes when available.", "default": false }, "includeRented": { "title": "Include rented homes", "type": "boolean", "description": "Include already rented homes when available.", "default": false }, "includeRetirementHomes": { "title": "Include retirement homes", "type": "boolean", "description": "Include homes marketed for retirement living.", "default": false }, "includeSharedAccommodation": { "title": "Include shared accommodation", "type": "boolean", "description": "Include shared living accommodation.", "default": false }, "includeSharedOwnership": { "title": "Include shared ownership", "type": "boolean", "description": "Include shared-ownership homes.", "default": false }, "billsIncluded": { "title": "Bills included", "type": "boolean", "description": "Only include rentals where bills are included.", "default": false }, "petsAllowed": { "title": "Pets allowed", "type": "boolean", "description": "Only include pet-friendly rentals.", "default": false }, "isAuction": { "title": "Auction homes only", "type": "boolean", "description": "Only include homes offered for auction.", "default": false }, "isStudentAccommodation": { "title": "Student accommodation", "type": "boolean", "description": "Only include student accommodation.", "default": false }, "latitude": { "title": "Latitude", "minimum": -90, "maximum": 90, "type": "number", "description": "Center latitude for a radius search. Provide this together with longitude." }, "longitude": { "title": "Longitude", "minimum": -180, "maximum": 180, "type": "number", "description": "Center longitude for a radius search. Provide this together with latitude." }, "distanceMiles": { "title": "Distance", "minimum": 1, "maximum": 40, "type": "integer", "description": "Radius around the coordinate point in miles.", "default": 20 }, "fetchDetails": { "title": "Fetch listing details", "type": "boolean", "description": "Fetch additional description, pricing, media, floor-area, location, and listing-history data for each result. This adds one request per listing.", "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 } } } } } } } } } }