{ "openapi": "3.0.1", "info": { "title": "UK Estate Agent Leads (Rightmove & Zoopla)", "description": "Find UK estate agent and letting agent branch contacts by area or postcode: agent/branch name, phone number, office address, and logo — sourced live from Rightmove and Zoopla listings. Built for B2B lead generation, not property research.", "version": "0.1", "x-build-id": "jknhuDg0NYiq6oSJm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/xtracto~uk-agent-leads/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-xtracto-uk-agent-leads", "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/xtracto~uk-agent-leads/runs": { "post": { "operationId": "runs-sync-xtracto-uk-agent-leads", "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/xtracto~uk-agent-leads/run-sync": { "post": { "operationId": "run-sync-xtracto-uk-agent-leads", "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": [ "source" ], "properties": { "source": { "title": "Source", "enum": [ "rightmove", "zoopla" ], "type": "string", "description": "Which UK property site to pull agent/branch contacts from.", "default": "rightmove" }, "searchUrls": { "title": "Search area (URL or location)", "type": "array", "description": "For Rightmove: paste a full search-results URL (copy the address bar after searching on rightmove.co.uk). For Zoopla: paste a full search URL OR just a location slug (e.g. london, manchester, se15, bristol). Every listing found is scanned for its selling/letting agent, deduplicated into one lead per branch.", "items": { "type": "string" } }, "channel": { "title": "For sale or to rent (Zoopla only)", "enum": [ "for-sale", "to-rent" ], "type": "string", "description": "Zoopla only. Ignored for Rightmove (its search URL already encodes sale vs rent).", "default": "for-sale" }, "propertyUrls": { "title": "Direct property/listing URLs (optional)", "type": "array", "description": "Optional. Paste specific Rightmove property URLs or Zoopla listing URLs instead of, or in addition to, a search area. Each yields one enriched agent/branch lead.", "items": { "type": "string" } }, "maxItems": { "title": "Max agent/branch leads (0 = all found)", "minimum": 0, "type": "integer", "description": "Cap on the number of UNIQUE agent branches returned (not listings scanned). 0 = no limit.", "default": 100 }, "maxListingsPerSearch": { "title": "Max listings scanned per search area", "minimum": 25, "type": "integer", "description": "How many listings to page through per search area while looking for agent branches. Higher = more unique branches found, but more requests. Rightmove/Zoopla cap browsable results around 1000 per search.", "default": 500 }, "enrichBranches": { "title": "Enrich branches with full office address", "type": "boolean", "description": "When on, each Rightmove branch found via search gets one extra detail-page fetch to pull its full postal office address (Rightmove only — Zoopla does not expose a branch office address anywhere on the site).", "default": true }, "maxConcurrency": { "title": "Max concurrent workers", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many search areas / property pages to fetch in parallel. Keep low with residential proxies.", "default": 3 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "REQUIRED for Rightmove: it returns 403 to datacenter and non-UK IPs, so a UK (GB) residential proxy is mandatory. Recommended for Zoopla too. Default is Apify Residential, country GB.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "GB" } } } }, "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 } } } } } } } } } }