{ "openapi": "3.0.1", "info": { "title": "UK Property Scraper - Rightmove, Zoopla, OnTheMarket", "description": "Scrape UK property listings from Rightmove, OnTheMarket & Zoopla in one run — sale, rent, and sold prices — normalized to one schema.", "version": "0.1", "x-build-id": "ipu4n7JSpuKBalFfd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/illehius~property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-illehius-property-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/illehius~property-scraper/runs": { "post": { "operationId": "runs-sync-illehius-property-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/illehius~property-scraper/run-sync": { "post": { "operationId": "run-sync-illehius-property-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": [ "locations" ], "properties": { "locations": { "title": "Locations", "type": "array", "description": "Place names or postcodes (e.g. \"London\", \"Manchester\", \"SW1A\"). Auto-resolved per portal.", "items": { "type": "string" } }, "channel": { "title": "Channel", "enum": [ "for-sale", "to-rent" ], "type": "string", "description": "Listing type to scrape.", "default": "for-sale" }, "portals": { "title": "Portals", "type": "array", "description": "Portals to scrape (default: Rightmove + OnTheMarket). Zoopla is experimental — it is blocked by Cloudflare from Apify cloud runs and will be skipped.", "items": { "type": "string", "enum": [ "rightmove", "onthemarket", "zoopla" ] }, "default": [ "rightmove", "onthemarket" ] }, "minPrice": { "title": "Min price", "type": "integer", "description": "Minimum price (£)." }, "maxPrice": { "title": "Max price", "type": "integer", "description": "Maximum price (£)." }, "minBeds": { "title": "Min beds", "type": "integer", "description": "Minimum number of bedrooms." }, "maxBeds": { "title": "Max beds", "type": "integer", "description": "Maximum number of bedrooms." }, "propertyType": { "title": "Property types", "type": "array", "description": "Property types to include (e.g. detached, flat, terraced). Applied where the portal supports it.", "items": { "type": "string" } }, "radius": { "title": "Radius (miles)", "type": "number", "description": "Search radius in miles from each location." }, "addedSinceDays": { "title": "Added since (days)", "type": "integer", "description": "Only listings added within the last N days." }, "keywords": { "title": "Keywords", "type": "array", "description": "Only listings whose text matches any keyword.", "items": { "type": "string" } }, "features": { "title": "Features", "type": "array", "description": "Only listings whose text mentions any feature (e.g. garden, parking).", "items": { "type": "string" } }, "newBuild": { "title": "New build only", "type": "boolean", "description": "Restrict to new-build listings (where the portal supports it).", "default": false }, "chainFree": { "title": "Chain-free only", "type": "boolean", "description": "Restrict to chain-free listings (where the portal supports it).", "default": false }, "includeDetails": { "title": "Include detail pages", "type": "boolean", "description": "Fetch each listing's page for full description + all photos (slower).", "default": false }, "maxListings": { "title": "Max listings", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Hard cap on listings returned across all portals/locations.", "default": 1000 }, "failOnError": { "title": "Fail on error", "type": "boolean", "description": "If true, a portal/location failure aborts the run; otherwise it is skipped.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify proxy (RESIDENTIAL recommended for Zoopla at volume).", "default": { "useApifyProxy": 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 } } } } } } } } } }