{ "openapi": "3.0.1", "info": { "title": "๐Ÿš€ Zoopla Agents Scraper ยท 2,500 Free Branches/Month", "description": "Zoopla Agents Scraper gets you every estate agent branch in any UK location โšก fast and ๐ŸŽฏ 100% accurate โ€” phone, address, logo, listing stats, full profiles & live listings. Ready-to-call UK estate agent leads. ๐Ÿ’ฐ $2 per 1,000 branches, no start fee. First 2,500 branches free every month ๐Ÿš€", "version": "0.0", "x-build-id": "MSzKEjls71hX1SeSg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/omkar-cloud~zoopla-agents-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-omkar-cloud-zoopla-agents-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/omkar-cloud~zoopla-agents-scraper/runs": { "post": { "operationId": "runs-sync-omkar-cloud-zoopla-agents-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/omkar-cloud~zoopla-agents-scraper/run-sync": { "post": { "operationId": "run-sync-omkar-cloud-zoopla-agents-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": { "locations": { "title": "Locations", "type": "array", "description": "UK locations to find estate agents in, as free text (e.g. `London`, `Birmingham`, `Manchester`, `SW1A`). Rows carry a `location` field so you can tell searches apart. Leave empty to scrape only branch URLs.", "items": { "type": "string" } }, "searchType": { "title": "Agent Type", "enum": [ "", "sales", "lettings" ], "type": "string", "description": "Filter to sales or lettings agents. Leave on All for both.", "default": "" }, "branchUrls": { "title": "Branch URLs", "type": "array", "description": "Zoopla branch page URLs and/or numeric branch ids โ€” you can mix them. Branch pages are always scraped with the full profile (billed at the detailed-branch rate).", "items": { "type": "string" } }, "maxResultsPerLocation": { "title": "Max Branches per Location", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of branches to scrape per location. Use this to control your cost (1,000 branches โ‰ˆ $2). Zoopla paginates 25 branches per page, up to 200 pages per location. Ignored for branch URLs.", "default": 100 }, "scrapeBranchDetails": { "title": "Scrape Full Branch Profiles", "type": "boolean", "description": "When enabled, every search result is also fetched from its branch page and merged into the row โ€” postcode, outcode, latitude/longitude, memberships (e.g. The Property Ombudsman), social links, and opening times. Still one dataset row per branch, billed once at the detailed-branch rate instead of the standard rate (1,000 detailed branches โ‰ˆ $3 vs $2 standard). Runs take longer because each branch page is fetched individually.", "default": false }, "scrapeBranchListings": { "title": "Scrape Each Branch's Live Listings", "type": "boolean", "description": "When enabled, every branch's live listings are fetched too and pushed as their own dataset rows (`row_type: \"listing\"`) carrying the `branch_id` and `branch_name` they belong to โ€” title, price, bedrooms, bathrooms, living rooms, listed date, under-offer flag, phone, main photo, and link. Listing rows are billed at the standard rate (1,000 listings โ‰ˆ $2).", "default": false }, "listingsSection": { "title": "Listings Section", "enum": [ "for-sale", "to-rent" ], "type": "string", "description": "Which listings to return for each branch: properties for sale or properties to rent. Only used when Scrape Each Branch's Live Listings is enabled.", "default": "for-sale" }, "maxListingsPerBranch": { "title": "Max Listings per Branch", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of listing rows to push per branch. Zoopla's branch page exposes the branch's featured listings for the section, so a branch may return fewer than this cap. Only used when Scrape Each Branch's Live Listings is enabled.", "default": 25 } } }, "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 } } } } } } } } } }