# Zoopla Property Scraper (`one-api/zoopla-property-scraper`) Actor Scrape Zoopla.co.uk listings, full property details, sold-price history, sale & rent estimates, EV charging, agents, and autocomplete. Search by location / UK postcode / lat-lng / Zoopla URL with the full filter set (price, beds, sqft, tenure, new builds, chain-free, auction, furnished). - **URL**: https://apify.com/one-api/zoopla-property-scraper.md - **Developed by:** [ONE API](https://apify.com/one-api) (community) - **Categories:** Lead generation, Real estate - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 1 bookmarks - **User rating**: No ratings yet ## Pricing from $3.00 / 1,000 results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Zoopla.co.uk Property Scraper Scrape **Zoopla.co.uk** UK property listings, full property details, sold-price history, sale & rent estimates, EV charging stations, agent / branch lookup, and search-box autocomplete ā€” all from one Actor. Backed by [realtyapi.io](https://realtyapi.io)'s real-time Zoopla API. ā­ļø Found this useful? Please leave 5 stars! Issues / requests: šŸ“¬ **oneapi.project@gmail.com** --- ### What you can do | Section | What it does | Input format | |---|---|---| | šŸ  **Property Details** | Full details for a specific listing or property | `listingId` digits, Zoopla URL, or full UK address (must include postcode) ā€” auto-detected per row | | šŸ”Ž **Search Listings** | Paginated UK property search with full filter set | location string, UK postcode, `lat,lng,radius_mi`, or Zoopla search URL | | šŸ” **Autocomplete** | Search-box suggestions: neighbourhoods, towns, postcodes, counties | partial query string | | šŸ’· **Sold Prices** | Land Registry sold-price browser by area / postcode / coordinates / bbox | `geoId` slug, `lat,lon`, `ne_lat,ne_lon,sw_lat,sw_lon` bbox, or postcode | | āš” **EV Charging** | Charging stations near a property | `listingId` (resolved to coords) or `lat,lon` | | šŸ’° **Sale & Rent Estimates** | Zoopla automated valuation per property | UK address with postcode, or UPRN | | šŸ“œ **Sales History** | Historic listings + Land Registry sales for one property | UK address with postcode, or UPRN | | šŸ‘¤ **Agent Search** | Find estate-agent branches by single-token UK location | `oxford`, `london`, `nw3`, `manchester` | | šŸ¢ **Agent Details + Listings** | Branch info plus optional full pages of for-sale + to-rent listings | `branchId` from any search response | You can fill any combination of sections in a single run ā€” leave the others empty. --- ### Output Each listing / property / agent / station / suggestion is pushed as **one dataset row**, flattened to friendly columns plus a `Raw` column with the original JSON. | Mode | Listing ID | Status | Price | Beds | Baths | Sqft | Type | Tenure | Town | Postcode | Branch | Listing URL | |---|---|---|---|---|---|---|---|---|---|---|---|---| | `search/byzip` | 73093625 | Just added | 820000 | 3 | 2 | 1157 | 3 bed flat for sale | Leasehold | London | NW3 | Foxtons - Hampstead | https://www.zoopla.co.uk/... | | `details/byid` | 72743732 | published | 1050000 | 4 | 2 | 1543 | Terraced house | Freehold | London | NW3 2JR | Kinleigh Folkard & Hayward | https://www.zoopla.co.uk/... | | `details/byaddress` | ā€” | estimate | 980000 | 3 | 2 | ā€” | Flat/Maisonette | Freehold | London | W2 4AW | ā€” | ā€” | Plus: `UPRN`, `Receptions`, `Floor Area Sqft`, `Outcode`, `County`, `Region`, `Latitude`, `Longitude`, `Published`, `Furnished`, `Chain Free`, `New Home`, `Retirement`, `Shared Ownership`, `Auction`, `Photos` (cover URL), `Photo Count`, `Branch ID`, `Branch Phone`. For nested fields (full photo arrays, points of interest, transports, EPC, price history etc.), the complete upstream JSON is in the `Raw` column. --- ### Sample input ```json { "property_inputs": [ "72743732", "https://www.zoopla.co.uk/for-sale/details/72743732/", "10 Mansfield Road, NW3 2HN" ], "search_inputs": ["NW3", "Hampstead, London", "51.5074,-0.1278,1"], "searchType": "For_Sale", "propertyType": "flat,house", "priceRange": "min:500000,max:1500000", "bedsRange": "min:2", "tenure": "freehold", "sortOrder": "Newest", "pages": 2, "autocomplete_inputs": ["Oxford"], "soldprices_inputs": ["london/elm-row/nw3-1aa"], "ev_inputs": ["71295522"], "estimates_inputs": ["10 Mansfield Road, NW3 2HN"], "history_inputs": ["Caroline Place, London W2 4AW"], "agent_search_inputs": ["nw3"], "agent_inputs": ["2879"], "agent_listings_section": false } ```` *** ### Search filters (apply to every `search_inputs` row) - **searchType** ā€” `For_Sale` (default) | `To_Rent` | `Sold` (UK convention is `To_Rent`). - **propertyType** ā€” comma list of `flat, house, bungalow, terraced, semi_detached, detached, land, park_home, farm`. Empty = all. - **priceRange / bedsRange / bathsRange / sizeSqftRange** ā€” `min:X` | `max:Y` | `min:X,max:Y`. - **tenure** ā€” `freehold`, `leasehold`, `share_of_freehold`, or empty (any). - **sortOrder** ā€” `Newest`, `Price_High_to_Low`, `Price_Low_to_High`, `Most_Reduced`. - **pages** ā€” pages to fetch (1ā€“50). Each page = 25 listings (Zoopla's fixed page size). - **newHomes** ā€” `only` | `false` (exclude) | empty (include both ā€” Zoopla default). - **chainFree, retirement, sharedOwnership, auction** ā€” booleans, true = filter to only. - **includeSold** ā€” true to also include sold-STC / under-offer when `searchType=For_Sale`. - **furnished** ā€” `furnished`, `unfurnished`, `part_furnished`, or empty (any). Used with `searchType=To_Rent`. - **petsAllowed, billsIncluded, sharedLiving, studentHousing** ā€” rent-only booleans. - **keywords** ā€” free-text amenities (e.g. `garden,parking,period features`). *** ### Pricing **Pay per result** ā€” $3 per 1,000 items pushed. Failed inputs return a row with `Status: ERROR: ...` and are billed the same as a successful row. To cap spend, set `Max paid dataset items` on the run page. *** ### Tips - **Need just one property?** Use `property_inputs` ā€” auto-detects `listingId`, URL, or address. - **Pull all listings in an area?** Use `search_inputs: ["NW3"]` (outward postcode preferred over full postcode) with `pages: 5` for ~125 listings. - **Use a lat/lng circle?** Format: `51.5074,-0.1278,1` (last value is radius in miles). - **Property estimates only?** Use `estimates_inputs` (faster than `details/byaddress` if you only need the AVM). - **Agent's full inventory?** Set `agent_inputs: ["2879"]` and toggle `agent_listings_section` on, with `pages` for how many pages of each (for-sale + to-rent). - **Resolve a Zoopla URL?** Drop a search URL or detail URL into the matching section ā€” both `byurl` modes parse the URL into the right call internally. # Actor input Schema ## `property_inputs` (type: `array`): Auto-detects each entry: digits ā†’ listingId, http(s) URL ā†’ Zoopla listing URL, anything else ā†’ UK address (must include full postcode, e.g. `NW3 2HN`). Each row = 1 property detail call. ## `search_inputs` (type: `array`): Auto-detects each entry. Examples: ā€¢ `NW3` (UK postcode outward code ā€” preferred over full postcodes) ā€¢ `Hampstead, London` or `Oxford, Oxfordshire` (free-text location) ā€¢ `51.5074,-0.1278,1` (lat,lng,radius\_miles) ā€¢ `https://www.zoopla.co.uk/for-sale/property/london/` (search URL) Filters below apply to every search. Each LISTING is pushed as one dataset item. ## `searchType` (type: `string`): For\_Sale (default) | To\_Rent | Sold. UK convention uses `To_Rent`. ## `propertyType` (type: `string`): Comma-separated UK property types. Empty for all. Allowed: `flat, house, bungalow, terraced, semi_detached, detached, land, park_home, farm` ## `priceRange` (type: `string`): `min:500000`, `max:1500000`, or `min:500000,max:1500000` ## `bedsRange` (type: `string`): `min:2`, `max:5`, `min:2,max:5` (studio = `min:0`) ## `bathsRange` (type: `string`): `min:1`, `max:3`, `min:1,max:3` ## `sizeSqftRange` (type: `string`): `min:600`, `max:2000`, `min:600,max:2000` ## `tenure` (type: `string`): UK-specific. Empty = any tenure. ## `sortOrder` (type: `string`): How to sort search results. Default: Newest. ## `pages` (type: `integer`): Each page = up to 25 listings (Zoopla's fixed page size). ## `newHomes` (type: `string`): `only` (only new builds) | `false` (exclude) | empty (include both, Zoopla default). ## `chainFree` (type: `boolean`): Only listings advertised as chain-free (no onward chain). ## `retirement` (type: `boolean`): Only retirement / over-55 properties. ## `sharedOwnership` (type: `boolean`): Only shared-ownership listings (buy a share, rent the rest from a housing association). ## `auction` (type: `boolean`): Only auction listings. ## `includeSold` (type: `boolean`): When `searchType` = `For_Sale`, also include sold-STC / under-offer alongside live listings. ## `furnished` (type: `string`): Used when `searchType` = `To_Rent`. Empty = any. ## `petsAllowed` (type: `boolean`): Only pet-friendly rentals. Used with `searchType` = `To_Rent`. ## `billsIncluded` (type: `boolean`): Only rentals with bills included in rent. ## `sharedLiving` (type: `boolean`): Only shared accommodation / flatshare listings. ## `studentHousing` (type: `boolean`): Only student accommodation listings. ## `keywords` (type: `string`): Free-text amenities (e.g. `garden,parking,period features`). ## `autocomplete_inputs` (type: `array`): Zoopla search-box suggestions: neighbourhoods, towns, postcodes, counties. ## `soldprices_inputs` (type: `array`): Browse Zoopla's Land Registry sold-price database. Auto-detects each row: ā€¢ `london`, `london/elm-row/nw3-1aa` ā†’ geoId (slug from /autocomplete) ā€¢ `51.5074,-0.1278` ā†’ exact lat,lon ā€¢ `51.56,-0.15,51.54,-0.18` ā†’ bbox (ne\_lat,ne\_lon,sw\_lat,sw\_lon) ā€¢ Anything else ā†’ tried as `postcode` (less reliable; Zoopla often returns 0) ## `ev_inputs` (type: `array`): Find charging stations near a property. Digits ā†’ listingId (we resolve coords); `lat,lon` ā†’ direct. ## `estimates_inputs` (type: `array`): Zoopla's automated valuation. UK address with full postcode, OR a UPRN (Unique Property Reference Number, all-digits). ## `history_inputs` (type: `array`): Historic listings + Land Registry sales for one property. ## `agent_search_inputs` (type: `array`): Find estate-agent branches by single-token UK location slug. Examples: `oxford`, `london`, `nw3`, `se17`, `manchester`. Multi-word slugs (`oxford-oxfordshire`) return an error. ## `agent_inputs` (type: `array`): branchId from any /search/\* result (`branch.id`) or /agent/search response. Returns branch info plus a sample of for-sale + to-rent listings. To pull the FULL listings page, set the `agent_listings_section` toggle below. ## `agent_listings_section` (type: `boolean`): When checked, each branchId in the section above also runs /agent/forsaleproperties and /agent/forrentproperties (paginated by `pages`). ## Actor input object example ```json { "property_inputs": [ "72743732", "https://www.zoopla.co.uk/for-sale/details/72743732/", "10 Mansfield Road, NW3 2HN" ], "search_inputs": [ "NW3" ], "searchType": "For_Sale", "propertyType": "", "priceRange": "", "bedsRange": "", "bathsRange": "", "sizeSqftRange": "", "tenure": "", "sortOrder": "Newest", "pages": 1, "newHomes": "", "chainFree": false, "retirement": false, "sharedOwnership": false, "auction": false, "includeSold": false, "furnished": "", "petsAllowed": false, "billsIncluded": false, "sharedLiving": false, "studentHousing": false, "keywords": "", "agent_listings_section": false } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "property_inputs": [ "72743732", "https://www.zoopla.co.uk/for-sale/details/72743732/", "10 Mansfield Road, NW3 2HN" ], "search_inputs": [ "NW3" ] }; // Run the Actor and wait for it to finish const run = await client.actor("one-api/zoopla-property-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`šŸ’¾ Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // šŸ“š Want to learn more šŸ“–? Go to ā†’ https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "property_inputs": [ "72743732", "https://www.zoopla.co.uk/for-sale/details/72743732/", "10 Mansfield Road, NW3 2HN", ], "search_inputs": ["NW3"], } # Run the Actor and wait for it to finish run = client.actor("one-api/zoopla-property-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("šŸ’¾ Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # šŸ“š Want to learn more šŸ“–? Go to ā†’ https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "property_inputs": [ "72743732", "https://www.zoopla.co.uk/for-sale/details/72743732/", "10 Mansfield Road, NW3 2HN" ], "search_inputs": [ "NW3" ] }' | apify call one-api/zoopla-property-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=one-api/zoopla-property-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Zoopla Property Scraper", "description": "Scrape Zoopla.co.uk listings, full property details, sold-price history, sale & rent estimates, EV charging, agents, and autocomplete. Search by location / UK postcode / lat-lng / Zoopla URL with the full filter set (price, beds, sqft, tenure, new builds, chain-free, auction, furnished).", "version": "1.0", "x-build-id": "ebwfL260exiNh3wMR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/one-api~zoopla-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-one-api-zoopla-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/one-api~zoopla-property-scraper/runs": { "post": { "operationId": "runs-sync-one-api-zoopla-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/one-api~zoopla-property-scraper/run-sync": { "post": { "operationId": "run-sync-one-api-zoopla-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", "properties": { "property_inputs": { "title": "Listing ID, Zoopla URL, or full UK address (one per line)", "type": "array", "description": "Auto-detects each entry: digits ā†’ listingId, http(s) URL ā†’ Zoopla listing URL, anything else ā†’ UK address (must include full postcode, e.g. `NW3 2HN`). Each row = 1 property detail call.", "items": { "type": "string" } }, "search_inputs": { "title": "Location, UK postcode, lat/lng radius, or Zoopla search URL (one per line)", "type": "array", "description": "Auto-detects each entry. Examples:\nā€¢ `NW3` (UK postcode outward code ā€” preferred over full postcodes)\nā€¢ `Hampstead, London` or `Oxford, Oxfordshire` (free-text location)\nā€¢ `51.5074,-0.1278,1` (lat,lng,radius_miles)\nā€¢ `https://www.zoopla.co.uk/for-sale/property/london/` (search URL)\n\nFilters below apply to every search. Each LISTING is pushed as one dataset item.", "items": { "type": "string" } }, "searchType": { "title": "Search Type", "enum": [ "For_Sale", "To_Rent", "Sold" ], "type": "string", "description": "For_Sale (default) | To_Rent | Sold. UK convention uses `To_Rent`.", "default": "For_Sale" }, "propertyType": { "title": "Property Types", "type": "string", "description": "Comma-separated UK property types. Empty for all. Allowed: `flat, house, bungalow, terraced, semi_detached, detached, land, park_home, farm`", "default": "" }, "priceRange": { "title": "Price Range (Ā£)", "type": "string", "description": "`min:500000`, `max:1500000`, or `min:500000,max:1500000`", "default": "" }, "bedsRange": { "title": "Beds Range", "type": "string", "description": "`min:2`, `max:5`, `min:2,max:5` (studio = `min:0`)", "default": "" }, "bathsRange": { "title": "Baths Range", "type": "string", "description": "`min:1`, `max:3`, `min:1,max:3`", "default": "" }, "sizeSqftRange": { "title": "Floor Area (sqft)", "type": "string", "description": "`min:600`, `max:2000`, `min:600,max:2000`", "default": "" }, "tenure": { "title": "Tenure", "enum": [ "", "freehold", "leasehold", "share_of_freehold" ], "type": "string", "description": "UK-specific. Empty = any tenure.", "default": "" }, "sortOrder": { "title": "Sort Order", "enum": [ "Newest", "Price_High_to_Low", "Price_Low_to_High", "Most_Reduced" ], "type": "string", "description": "How to sort search results. Default: Newest.", "default": "Newest" }, "pages": { "title": "Pages to fetch per search", "minimum": 1, "maximum": 50, "type": "integer", "description": "Each page = up to 25 listings (Zoopla's fixed page size).", "default": 1 }, "newHomes": { "title": "New-Build filter", "enum": [ "", "only", "false" ], "type": "string", "description": "`only` (only new builds) | `false` (exclude) | empty (include both, Zoopla default).", "default": "" }, "chainFree": { "title": "Chain Free Only", "type": "boolean", "description": "Only listings advertised as chain-free (no onward chain).", "default": false }, "retirement": { "title": "Retirement / Over-55 Only", "type": "boolean", "description": "Only retirement / over-55 properties.", "default": false }, "sharedOwnership": { "title": "Shared Ownership Only", "type": "boolean", "description": "Only shared-ownership listings (buy a share, rent the rest from a housing association).", "default": false }, "auction": { "title": "Auction Only", "type": "boolean", "description": "Only auction listings.", "default": false }, "includeSold": { "title": "Include Sold-STC / Under Offer", "type": "boolean", "description": "When `searchType` = `For_Sale`, also include sold-STC / under-offer alongside live listings.", "default": false }, "furnished": { "title": "Furnished State (rent only)", "enum": [ "", "furnished", "unfurnished", "part_furnished" ], "type": "string", "description": "Used when `searchType` = `To_Rent`. Empty = any.", "default": "" }, "petsAllowed": { "title": "Pets Allowed (rent only)", "type": "boolean", "description": "Only pet-friendly rentals. Used with `searchType` = `To_Rent`.", "default": false }, "billsIncluded": { "title": "Bills Included (rent only)", "type": "boolean", "description": "Only rentals with bills included in rent.", "default": false }, "sharedLiving": { "title": "Shared Accommodation (rent only)", "type": "boolean", "description": "Only shared accommodation / flatshare listings.", "default": false }, "studentHousing": { "title": "Student Accommodation (rent only)", "type": "boolean", "description": "Only student accommodation listings.", "default": false }, "keywords": { "title": "Keywords", "type": "string", "description": "Free-text amenities (e.g. `garden,parking,period features`).", "default": "" }, "autocomplete_inputs": { "title": "Autocomplete query (one per line)", "type": "array", "description": "Zoopla search-box suggestions: neighbourhoods, towns, postcodes, counties.", "items": { "type": "string" } }, "soldprices_inputs": { "title": "Sold-prices geo selectors (one per line)", "type": "array", "description": "Browse Zoopla's Land Registry sold-price database. Auto-detects each row:\nā€¢ `london`, `london/elm-row/nw3-1aa` ā†’ geoId (slug from /autocomplete)\nā€¢ `51.5074,-0.1278` ā†’ exact lat,lon\nā€¢ `51.56,-0.15,51.54,-0.18` ā†’ bbox (ne_lat,ne_lon,sw_lat,sw_lon)\nā€¢ Anything else ā†’ tried as `postcode` (less reliable; Zoopla often returns 0)", "items": { "type": "string" } }, "ev_inputs": { "title": "EV charging ā€” listingId or `lat,lon` (one per line)", "type": "array", "description": "Find charging stations near a property. Digits ā†’ listingId (we resolve coords); `lat,lon` ā†’ direct.", "items": { "type": "string" } }, "estimates_inputs": { "title": "Address (with full UK postcode) or UPRN (one per line)", "type": "array", "description": "Zoopla's automated valuation. UK address with full postcode, OR a UPRN (Unique Property Reference Number, all-digits).", "items": { "type": "string" } }, "history_inputs": { "title": "Address (with full UK postcode) or UPRN (one per line)", "type": "array", "description": "Historic listings + Land Registry sales for one property.", "items": { "type": "string" } }, "agent_search_inputs": { "title": "Agent location slug (one per line)", "type": "array", "description": "Find estate-agent branches by single-token UK location slug. Examples: `oxford`, `london`, `nw3`, `se17`, `manchester`. Multi-word slugs (`oxford-oxfordshire`) return an error.", "items": { "type": "string" } }, "agent_inputs": { "title": "Agent branchId (one per line)", "type": "array", "description": "branchId from any /search/* result (`branch.id`) or /agent/search response. Returns branch info plus a sample of for-sale + to-rent listings. To pull the FULL listings page, set the `agent_listings_section` toggle below.", "items": { "type": "string" } }, "agent_listings_section": { "title": "Also fetch agent's full listings (for-sale + to-rent)", "type": "boolean", "description": "When checked, each branchId in the section above also runs /agent/forsaleproperties and /agent/forrentproperties (paginated by `pages`).", "default": 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 } } } } } } } } } } ```