{ "openapi": "3.0.1", "info": { "title": "๐Ÿš€ Zoopla Scraper ยท 5,000 Free Listings/Month", "description": "Zoopla Scraper gets you Zoopla data โšก fast, ๐ŸŽฏ 100% accurate and ๐Ÿ” ridiculously detailed โ€” UK homes for sale, to rent & new homes, full listing details, EPC, floor plans & agent phone. ๐Ÿ’ฐ $1 per 1,000 listings, no start fee. Scrape your first 5,000 listings free every month ๐Ÿš€", "version": "0.0", "x-build-id": "6CJ6IS2mDJUiEPOtk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/omkar-cloud~zoopla-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-omkar-cloud-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/omkar-cloud~zoopla-scraper/runs": { "post": { "operationId": "runs-sync-omkar-cloud-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/omkar-cloud~zoopla-scraper/run-sync": { "post": { "operationId": "run-sync-omkar-cloud-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": { "locations": { "title": "Locations", "type": "array", "description": "UK towns, areas, postcodes or outcodes (`London`, `Manchester`, `NW3`), Zoopla location slugs (`notting-hill`, `london/croydon`), or pasted zoopla.co.uk search-results URLs (their embedded filters and section are applied). Each is searched separately. Rows carry a `search_location` field so you can tell locations apart. Leave empty to scrape only listing URLs.", "items": { "type": "string" } }, "section": { "title": "Section", "enum": [ "for-sale", "to-rent", "new-homes" ], "type": "string", "description": "Which Zoopla listings to search: homes for sale, homes to rent, or new-build homes. A pasted search URL uses its own section.", "default": "for-sale" }, "priceMin": { "title": "Price โ€” Min (ยฃ)", "minimum": 1, "type": "integer", "description": "Minimum price (GBP). For rentals this is the monthly rent." }, "priceMax": { "title": "Price โ€” Max (ยฃ)", "minimum": 1, "type": "integer", "description": "Maximum price (GBP). For rentals this is the monthly rent." }, "bedsMin": { "title": "Bedrooms โ€” Min", "minimum": 0, "maximum": 15, "type": "integer", "description": "Minimum number of bedrooms." }, "bedsMax": { "title": "Bedrooms โ€” Max", "minimum": 0, "maximum": 15, "type": "integer", "description": "Maximum number of bedrooms." }, "propertyType": { "title": "Property Type", "enum": [ "", "detached", "semi_detached", "terraced", "flats", "bungalow", "park_home", "farms_land", "detached_bungalow", "semi_detached_bungalow", "terraced_bungalow" ], "type": "string", "description": "Filter by property type. Leave on Any for all types.", "default": "" }, "furnishedState": { "title": "Furnished State (to rent only)", "enum": [ "", "furnished", "part_furnished", "unfurnished" ], "type": "string", "description": "Filter rentals by furnishing. Only applies to the To rent section โ€” ignored for sales and new homes.", "default": "" }, "added": { "title": "Added Within", "enum": [ "", "24_hours", "3_days", "7_days", "14_days", "30_days" ], "type": "string", "description": "Only properties added within this window.", "default": "" }, "keywords": { "title": "Keywords", "type": "string", "description": "Free-text keywords to match in the listing (e.g. `garden`, `garage`, `chain free`)." }, "radius": { "title": "Radius (miles)", "minimum": 0, "maximum": 40, "type": "integer", "description": "Search radius in miles around the location (0โ€“40)." }, "sortBy": { "title": "Sort By", "enum": [ "newest", "highest_price", "lowest_price", "most_reduced", "most_popular" ], "type": "string", "description": "Result ordering.", "default": "newest" }, "listingUrls": { "title": "Listing URLs", "type": "array", "description": "Zoopla listing URLs like `https://www.zoopla.co.uk/for-sale/details/74017763/` or bare listing ids like `74017763`. Always scraped with full details (billed at the detailed-listing rate).", "items": { "type": "string" } }, "maxResultsPerLocation": { "title": "Max Listings per Location", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of listings to scrape per location or search URL. Use this to control your cost (1,000 listings โ‰ˆ $1). Ignored for listing URLs.", "default": 100 }, "scrapeListingDetails": { "title": "Scrape Full Listing Details", "type": "boolean", "description": "When enabled, every search result is also scraped in full โ€” description, features, tenure, price history, EPC rating, coordinates, postcode & UPRN, nearest stations, service charge / council tax / ground rent, all photos, floor plans, and the agent's brand & lettings phone. Still one dataset row per listing, billed once at the detailed-listing rate instead of the standard rate (1,000 detailed listings โ‰ˆ $2.50 vs $1 standard). Runs take longer because each listing page is fetched individually.", "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 } } } } } } } } } }