{ "openapi": "3.0.1", "info": { "title": "UK Property Tracker: Rightmove, Zoopla, OnTheMarket", "description": "Scrape UK homes for sale or rent from Rightmove, OnTheMarket and Zoopla in one run. Merges the same home across portals and tracks new listings, price drops, price rises and removed homes.", "version": "0.1", "x-build-id": "HUKfATG7dsD3e5alK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apizilla~uk-property-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apizilla-uk-property-tracker", "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/apizilla~uk-property-tracker/runs": { "post": { "operationId": "runs-sync-apizilla-uk-property-tracker", "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/apizilla~uk-property-tracker/run-sync": { "post": { "operationId": "run-sync-apizilla-uk-property-tracker", "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": [ "searches" ], "properties": { "searches": { "title": "Searches", "type": "array", "description": "What to search. Each entry is either a search page URL copied from Rightmove, Zoopla or OnTheMarket, or a simple search object like {\"location\": \"Manchester\", \"operation\": \"sale\", \"propertyType\": \"flat\", \"minPrice\": 150000, \"maxPrice\": 300000, \"minRooms\": 2, \"minSize\": 50}. A simple search runs on every portal you turn on. operation is \"sale\" or \"rent\". propertyType is one of any, flat, house, detached, semi-detached, terraced, bungalow, land. minRooms means bedrooms. minSize is in square metres. Rent prices are per month.", "default": [ { "location": "Kennington, London", "operation": "sale", "propertyType": "flat", "maxPrice": 800000, "minRooms": 2 } ] }, "portals": { "title": "Portals", "type": "array", "description": "Which portals to scrape. Zoopla is in beta: it has strong bot protection and needs a residential proxy, so it is off by default.", "items": { "type": "string", "enum": [ "rightmove", "onthemarket", "zoopla" ], "enumTitles": [ "Rightmove", "OnTheMarket", "Zoopla (beta, needs residential proxy)" ] }, "default": [ "rightmove", "onthemarket" ] }, "maxListingsPerPortal": { "title": "Max listings per portal", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop after this many listings on each portal. Results are sorted newest first. To get \"removed\" events in monitor mode, set this higher than the number of results of your search.", "default": 200 }, "includeDetails": { "title": "Include details", "type": "boolean", "description": "Open every listing page to get the full description, tenure, lease length, council tax band, EPC rating, service charge, ground rent and exact size. Slower and costs more. Off means list page data only.", "default": false }, "browserForBeta": { "title": "Use a real browser for the beta portal", "type": "boolean", "description": "Zoopla (beta) blocks plain requests. When this is on, the Actor opens Zoopla in a real browser (Firefox) with a residential proxy, like a normal visitor. It is slower and costs more. It does not solve captchas: if Zoopla asks for one, Zoopla is skipped. Other portals always use fast plain requests.", "default": true }, "monitor": { "title": "Monitor changes", "type": "boolean", "description": "Compare with the previous run and mark each home as new, price_drop, price_rise, removed, back or unchanged. Run it on a schedule to get a change feed.", "default": false }, "monitorId": { "title": "Monitor ID", "type": "string", "description": "Name for the saved state of this tracker. Use the same name on every scheduled run. Leave empty to build a name from your searches." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy is used by default. Zoopla uses UK residential proxies automatically unless you pick proxy groups here.", "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 } } } } } } } } } }