{ "openapi": "3.0.1", "info": { "title": "Rightmove & Zoopla Scraper — UK Property, Sale & Rent", "description": "Scrape both Rightmove and Zoopla in one run. Search by location or URL with price, beds, type, radius and date filters. Full details: price-per-sqft, tenure, EPC, size, council tax, floorplans, nearest stations, agent and price history — plus deal scoring, days-on-market, monitoring and dedup.", "version": "0.0", "x-build-id": "BuHb9rSxfmDtaHRaW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/brilliant_gum~uk-realestate-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-brilliant_gum-uk-realestate-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/brilliant_gum~uk-realestate-scraper/runs": { "post": { "operationId": "runs-sync-brilliant_gum-uk-realestate-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/brilliant_gum~uk-realestate-scraper/run-sync": { "post": { "operationId": "run-sync-brilliant_gum-uk-realestate-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": { "site": { "title": "Site(s)", "enum": [ "both", "rightmove", "zoopla" ], "type": "string", "description": "Which portal(s) to scrape: Rightmove, Zoopla, or both. 'Both' returns a unified, normalized record for each site.", "default": "both" }, "listingType": { "title": "Listing type", "type": "array", "description": "What to search: properties for Sale, to Rent, or New homes. You can combine several. Ignored for direct property/search URLs (their type is auto-detected). Note: sold-price history (Rightmove/Zoopla 'house-prices') is out of scope — use a dedicated sold-price actor.", "items": { "type": "string", "enum": [ "sale", "rent", "newHomes" ], "enumTitles": [ "For sale", "To rent", "New homes" ] }, "default": [ "sale" ] }, "searchLocation": { "title": "Location", "type": "string", "description": "A single location to search: town, area, or postcode/outcode (e.g. \"London\", \"Manchester\", \"SW1A\"). Resolved automatically on each site. Leave empty if you use Locations or Start URLs." }, "searchLocations": { "title": "Locations (multiple)", "type": "array", "description": "Multiple locations to search. Each location is run for each selected listing type on each selected site. Overrides the single Location field when set.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs (search or property pages)", "type": "array", "description": "Ready-made Rightmove/Zoopla URLs: search-result pages (paginated automatically) or direct property pages. Site and listing type are auto-detected from the URL. Advanced alternative to Location.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchRadius": { "title": "Search radius (miles)", "type": "integer", "description": "Include properties within this many miles of the location (e.g. 0, 1, 3, 5, 10, 15, 20, 30, 40). 0 = this area only.", "default": 0 }, "minPrice": { "title": "Min price (£)", "minimum": 0, "type": "integer", "description": "Minimum price. For rentals this is per the chosen price frequency (default per month)." }, "maxPrice": { "title": "Max price (£)", "minimum": 0, "type": "integer", "description": "Maximum price. For rentals this is per the chosen price frequency (default per month)." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bedrooms." }, "maxBedrooms": { "title": "Max bedrooms", "minimum": 0, "type": "integer", "description": "Maximum number of bedrooms." }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Keep only these property types (mapped to each site's own categories). Empty = any type.", "items": { "type": "string", "enum": [ "detached", "semi-detached", "terraced", "flat", "bungalow", "land", "park-home", "farm" ], "enumTitles": [ "Detached", "Semi-detached", "Terraced", "Flat / apartment", "Bungalow", "Land", "Park home", "Farm / barn" ] } }, "addedSince": { "title": "Added to site since", "enum": [ "", "24h", "3d", "7d", "14d", "30d" ], "type": "string", "description": "Only listings added within this window.", "default": "" }, "sortBy": { "title": "Sort by", "enum": [ "", "newest", "oldest", "priceAsc", "priceDesc", "mostReduced" ], "type": "string", "description": "Result ordering (mapped to each site's sort).", "default": "" }, "includeSSTC": { "title": "Include SSTC / sold", "type": "boolean", "description": "For sale: include properties marked Sold STC / Under Offer.", "default": false }, "includeUnderOffer": { "title": "Include Let Agreed / Under Offer", "type": "boolean", "description": "For rent: include properties marked Let Agreed / Under Offer.", "default": false }, "priceFrequency": { "title": "Rent price frequency", "enum": [ "per_month", "per_week" ], "type": "string", "description": "For rentals: whether min/max price are per month or per week.", "default": "per_month" }, "furnishType": { "title": "Furnishing (rent)", "enum": [ "", "furnished", "unfurnished", "partFurnished" ], "type": "string", "description": "For rentals: filter by furnishing state.", "default": "" }, "letType": { "title": "Let type (rent)", "enum": [ "", "longTerm", "shortTerm" ], "type": "string", "description": "For rentals on Rightmove: long-term or short-term lets.", "default": "" }, "mustHave": { "title": "Must have", "type": "array", "description": "Only listings that have these features (garden, parking, new home, retirement).", "items": { "type": "string", "enum": [ "garden", "parking", "newHome", "retirement" ], "enumTitles": [ "Garden", "Parking / garage", "New home", "Retirement" ] } }, "dontShow": { "title": "Don't show", "type": "array", "description": "Exclude these listing categories (Rightmove): new homes, retirement, shared ownership.", "items": { "type": "string", "enum": [ "newHome", "retirement", "sharedOwnership" ], "enumTitles": [ "New homes", "Retirement", "Shared ownership" ] } }, "keywords": { "title": "Keywords", "type": "array", "description": "Only listings whose description/features contain these keywords (e.g. \"garden\", \"garage\", \"period\").", "items": { "type": "string" } }, "maxItems": { "title": "Max properties per search", "minimum": 0, "type": "integer", "description": "Maximum properties per location + listing-type + site. 0 = all available (safety-capped by Max pages).", "default": 50 }, "maxPagesPerSearch": { "title": "Max search pages", "minimum": 0, "type": "integer", "description": "Maximum result pages to fetch per search (about 24-25 properties per page). 0 = until Max properties is reached or results run out.", "default": 0 }, "fetchDetails": { "title": "Fetch full property details", "type": "boolean", "description": "Open each property page for the full record (description, floorplans, EPC, nearest stations, council tax, size, tenure, price history on Zoopla). Turn off for a faster/cheaper run using only search-card fields.", "default": true }, "includePriceHistory": { "title": "Include price history", "type": "boolean", "description": "Include price-change history and price-change analytics when available (requires full details). Available on Zoopla; Rightmove listing pages don't publish per-date price history (only the added/reduced date, returned in listingUpdate/firstListed).", "default": true }, "dealAnalytics": { "title": "Deal analytics & scoring", "type": "boolean", "description": "Compute price-per-sqft, days-on-market, and an area-relative deal score / undervalued % (comparing each property to the run's median £/sqft for its outcode + bedroom count). No external AI or keys.", "default": true }, "deduplicate": { "title": "Deduplicate", "type": "boolean", "description": "Drop properties already produced (within the run, and across runs when a dedup key store is set).", "default": true }, "deduplicateKeyStore": { "title": "Cross-run dedup key store", "type": "string", "description": "Named key-value store to remember seen property IDs across scheduled runs. Empty = in-run dedup only." }, "monitoringMode": { "title": "Monitoring mode (new only)", "type": "boolean", "description": "Output only properties not seen in a previous run (requires a dedup key store). Ideal for new-listing alerts.", "default": false }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 30, "type": "integer", "description": "Parallel property-detail requests. Zoopla is heavier — 5-10 is a good range.", "default": 8 }, "maxRequestRetries": { "title": "Max request retries", "minimum": 0, "maximum": 10, "type": "integer", "description": "Retries with a fresh proxy session on temporary blocks, timeouts or server errors.", "default": 4 }, "proxy": { "title": "Proxy", "type": "object", "description": "Proxy configuration. Leave as-is — proxies are tuned automatically for reliable results on both sites. Advanced users can override this.", "default": { "useApifyProxy": true } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }