{ "openapi": "3.0.1", "info": { "title": "Fast Zoopla Properties Scraper", "description": "Scrape houses and flats for sale and to rent from zoopla.co.uk in a couple of seconds.", "version": "0.0", "x-build-id": "ZGDyKSVMwG53MraRB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tri_angle~fast-zoopla-properties-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tri_angle-fast-zoopla-properties-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/tri_angle~fast-zoopla-properties-scraper/runs": { "post": { "operationId": "runs-sync-tri_angle-fast-zoopla-properties-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/tri_angle~fast-zoopla-properties-scraper/run-sync": { "post": { "operationId": "run-sync-tri_angle-fast-zoopla-properties-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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "List of Zoopla.co.uk URLs to start scraping from.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "locationQueries": { "title": "Location Queries", "type": "array", "description": "List of location queries to scrape. Example: London, Manchester, Birmingham, etc.", "default": [], "items": { "type": "string" } }, "locationQueryAutoComplete": { "title": "Location Query Auto-Complete", "type": "boolean", "description": "If set to true, we will use the auto-complete feature on zoopla.co.uk and select the first suggestion for each location query. Otherwise, we will use the provided query as is.", "default": false }, "radius": { "title": "Radius", "enum": [ "0", "0.25", "0.5", "1", "3", "5", "10", "15", "20", "30", "40" ], "type": "string", "description": "Radius in miles around the location to scrape.", "default": "0" }, "propertySearchType": { "title": "Property Search Type", "enum": [ "for-sale", "to-rent", "new-homes" ], "type": "string", "description": "Type of property search.", "default": "for-sale" }, "propertySortBy": { "title": "Property Sort By", "enum": [ "newest_listings", "highest_price", "lowest_price", "most_reduced" ], "type": "string", "description": "Sort properties by this field.", "default": "newest_listings" }, "propertyMinBedrooms": { "title": "Minimum Bedrooms", "enum": [ "", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10" ], "type": "string", "description": "Minimum number of bedrooms.", "default": "" }, "propertyMaxBedrooms": { "title": "Maximum Bedrooms", "enum": [ "", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10" ], "type": "string", "description": "Maximum number of bedrooms.", "default": "" }, "propertyMinPrice": { "title": "Minimum Price", "enum": [ "", "10000", "20000", "30000", "40000", "50000", "60000", "70000", "80000", "90000", "100000", "110000", "120000", "125000", "130000", "140000", "150000", "160000", "170000", "180000", "190000", "200000", "210000", "220000", "230000", "240000", "250000", "275000", "300000", "325000", "350000", "375000", "400000", "425000", "450000", "475000", "500000", "550000", "600000", "650000", "700000", "750000", "800000", "850000", "900000", "950000", "1000000", "1100000", "1200000", "1300000", "1400000", "1500000", "1600000", "1700000", "1800000", "1900000", "2000000", "2100000", "2200000", "2300000", "2400000", "2500000", "2750000", "3000000", "3250000", "3500000", "3750000", "4000000", "4250000", "4500000", "4750000", "5000000", "5500000", "6000000", "6500000", "7000000", "7500000", "8000000", "8500000", "9000000", "9500000", "10000000", "12500000", "15000000" ], "type": "string", "description": "Properties minimum price.", "default": "" }, "propertyMaxPrice": { "title": "Maximum Price", "enum": [ "", "10000", "20000", "30000", "40000", "50000", "60000", "70000", "80000", "90000", "100000", "110000", "120000", "125000", "130000", "140000", "150000", "160000", "170000", "180000", "190000", "200000", "210000", "220000", "230000", "240000", "250000", "275000", "300000", "325000", "350000", "375000", "400000", "425000", "450000", "475000", "500000", "550000", "600000", "650000", "700000", "750000", "800000", "850000", "900000", "950000", "1000000", "1100000", "1200000", "1300000", "1400000", "1500000", "1600000", "1700000", "1800000", "1900000", "2000000", "2100000", "2200000", "2300000", "2400000", "2500000", "2750000", "3000000", "3250000", "3500000", "3750000", "4000000", "4250000", "4500000", "4750000", "5000000", "5500000", "6000000", "6500000", "7000000", "7500000", "8000000", "8500000", "9000000", "9500000", "10000000", "12500000", "15000000" ], "type": "string", "description": "Properties maximum price.", "default": "" }, "propertyTypes": { "title": "Property Types (default: all)", "type": "array", "description": "The type of property. Default is all.", "items": { "type": "string", "enum": [ "detached", "semi_detached", "terraced", "flats", "bungalow", "farms_land", "park_home" ], "enumTitles": [ "Detached", "Semi-Detached", "Terraced", "Flats", "Bungalow", "Farms/Land", "Park Home" ] }, "default": [] }, "propertyMustHave": { "title": "Property Must Have (default: all)", "type": "array", "description": "Property must have these features. Default is all.", "items": { "type": "string", "enum": [ "has_garden", "has_parking_garage", "has_balcony_terrace", "pets_allowed", "bills_included" ], "enumTitles": [ "Garden", "Parking/Garage", "Balcony/Terrace", "Pets Allowed (only for rental properties)", "Bills Included (only for rental properties)" ] }, "default": [] }, "propertyStatus": { "title": "Property Status (default: all)", "type": "array", "description": "The status of the property. Default is all.", "items": { "type": "string", "enum": [ "chain_free", "reduced_price_only", "include_sold" ], "enumTitles": [ "Chain-free", "Price Reduced", "Under offer/Sold STC" ] }, "default": [] }, "propertyAddedToSite": { "title": "Property Added To Site", "enum": [ "", "24_hours", "3_days", "7_days", "14_days", "30_days" ], "type": "string", "description": "When was the property added to the site.", "default": "" }, "showLetOrLetAgreed": { "title": "Show Let or Let Agreed", "type": "boolean", "description": "Show Let or Let Agreed properties (rented).", "default": false }, "propertyPricePer": { "title": "Property Price Per", "enum": [ "per_month", "per_week" ], "type": "string", "description": "Property price per filter.", "default": "per_month" }, "propertyFurnishing": { "title": "Property Furnished", "enum": [ "", "furnished", "part_furnished", "unfurnished" ], "type": "string", "description": "Property furnished filter.", "default": "" }, "propertyAvailability": { "title": "Property Availability", "enum": [ "", "now", "1months", "3months", "6months", "12months" ], "type": "string", "description": "Property availability filter.", "default": "" }, "keywords": { "title": "Keywords", "type": "array", "description": "Search for phrases by using quotation marks e.g. “double garage”, or exclude terms by prefixing them with a minus sign e.g. -studio.", "default": [], "items": { "type": "string" } } } }, "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 } } } } } } } } } }