# Homes.co.nz $1💰 URL | Search | Property Scraper (`abotapi/homes-co-nz-scraper`) Actor From $1/1K. Scrape Homes.co.nz listings via search or URL. Supports multiple locations or links per run with forward pagination. Extract enriched data, including property details, agents, branch info, valuations, media, open homes, and filters for status, price, beds, and baths. - **URL**: https://apify.com/abotapi/homes-co-nz-scraper.md - **Developed by:** [AbotAPI](https://apify.com/abotapi) (community) - **Categories:** Real estate, Developer tools, Automation - **Stats:** 2 total users, 1 monthly users, 66.7% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $1.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. Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have. 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 ## Homes.co.nz Scraper Collect rich residential listing data from `homes.co.nz` using structured site data. ### What it does - Supports `search` mode from plain location names such as `Wellington`. - Supports `url` mode for detail URLs and map URLs. - Accepts multiple locations or multiple URLs in one run. - Advances forward across structured result pages without relying on DOM pagination. - Pulls structured listing data directly from the site's underlying data sources. - Enriches each listing with property card data, agent and branch details, title metadata, valuations, media, and open home schedules. - Applies structured filters for listing status, bedrooms, bathrooms, and price range. - Supports output sorting by publication time or numeric price when available. ### Why this actor is different The actor is structured-data first: - Detail pages are resolved from the page's server-rendered state and then enriched with listing data. - Map pages are resolved from the page's server-rendered state and then expanded into individual listings. - Property enrichment adds valuation, title, branch, and agent data. That keeps extraction faster and more stable than page-structure parsing. ### Input - `mode`: `search` or `url` - `locations`: one or more location names for search mode - `urls`: one or more Homes detail or map URLs for URL mode - `listingStatus`: `for_sale`, `for_rent`, `just_sold`, or `off_market` - `minBedrooms`, `minBathrooms`, `minPrice`, `maxPrice`: structured query filters - `sortBy`: default ordering, newest, oldest, highest price, or lowest price - `maxListings`: maximum number of listings to output - `maxPages`: maximum output pages per search target - `pageSize`: listings to emit per output page - `maxMapItems`: maximum listing candidates to collect from each map URL before detail enrichment - `fetchPropertyCards`: whether to include extra property enrichment - `includeRawApiResponses`: include raw structured payloads in output for debugging ### Output highlights Each item contains the standard listing fields plus richer structured sections such as: - `openHomes` - `images` - `media` - `agents` - `branch` - `propertyDetails` - `valuations` - `estimates` - `titleRecord` - `sourceEndpoints` - `seedContext` ### Notes - This actor is tuned for structured site data first. - If a Homes URL changes shape, the fallback is still the page's embedded state rather than page selectors. # Actor input Schema ## `mode` (type: `string`): Search mode resolves location names and expands them into listing results. URL mode accepts Homes detail URLs or map URLs directly. ## `locations` (type: `array`): One or more location names to resolve through Homes and collect listings from. ## `listingStatus` (type: `string`): Choose which Homes listing bucket to collect. ## `minBedrooms` (type: `integer`): Only include listings with at least this many bedrooms when the structured feed exposes that filter. ## `minBathrooms` (type: `integer`): Only include listings with at least this many bathrooms when the structured feed exposes that filter. ## `minPrice` (type: `integer`): Lower price bound to send to the structured Homes query when supported for the chosen listing status. ## `maxPrice` (type: `integer`): Upper price bound to send to the structured Homes query when supported for the chosen listing status. ## `sortBy` (type: `string`): Applies to the output ordering of collected listings. Price sorting only affects records where a numeric price can be derived from the structured listing data. ## `urls` (type: `array`): One or more homes.co.nz detail URLs or map URLs. Multi-URL supported. Detail URLs return a single enriched listing. Map URLs expand into structured result pages and walk forward — when used this way, the search filters and sort above also apply. ## `maxListings` (type: `integer`): Hard ceiling on listings output across the whole run — pagination stops as soon as this is hit, in both Search and URL modes. Use 0 for no explicit cap. ## `maxPages` (type: `integer`): Maximum output pages to emit for each search target or map URL. Defaults to the cap so pagination only stops at maxListings — lower it to throttle deep walks. ## `pageSize` (type: `integer`): Number of listings to emit on each output page. ## `fetchPropertyCards` (type: `boolean`): Include extra valuation, title, branch, and agent data when available. Adds one additional request per listing — disable to cut cost when you only need core fields. ## `includeRawApiResponses` (type: `boolean`): Include the raw structured API payloads in each output item for debugging. ## `proxyConfiguration` (type: `object`): Proxy configuration for Homes requests. Apify Proxy is recommended for production runs. ## Actor input object example ```json { "mode": "search", "locations": [ "Wellington", "Auckland Central" ], "listingStatus": "for_sale", "sortBy": "default", "urls": [ "https://homes.co.nz/address/wellington/te-aro/25-26-marion-street/o02G2", "https://homes.co.nz/map/wellington?lat=-41.2865&lng=174.7762&zoom=13" ], "maxListings": 20, "maxPages": 200, "pageSize": 20, "fetchPropertyCards": true, "includeRawApiResponses": false, "proxyConfiguration": { "useApifyProxy": true } } ```` # Actor output Schema ## `listings` (type: `string`): No description # 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 = { "locations": [ "Wellington", "Auckland Central" ], "urls": [ "https://homes.co.nz/address/wellington/te-aro/25-26-marion-street/o02G2", "https://homes.co.nz/map/wellington?lat=-41.2865&lng=174.7762&zoom=13" ], "proxyConfiguration": { "useApifyProxy": true } }; // Run the Actor and wait for it to finish const run = await client.actor("abotapi/homes-co-nz-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 = { "locations": [ "Wellington", "Auckland Central", ], "urls": [ "https://homes.co.nz/address/wellington/te-aro/25-26-marion-street/o02G2", "https://homes.co.nz/map/wellington?lat=-41.2865&lng=174.7762&zoom=13", ], "proxyConfiguration": { "useApifyProxy": True }, } # Run the Actor and wait for it to finish run = client.actor("abotapi/homes-co-nz-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 '{ "locations": [ "Wellington", "Auckland Central" ], "urls": [ "https://homes.co.nz/address/wellington/te-aro/25-26-marion-street/o02G2", "https://homes.co.nz/map/wellington?lat=-41.2865&lng=174.7762&zoom=13" ], "proxyConfiguration": { "useApifyProxy": true } }' | apify call abotapi/homes-co-nz-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=abotapi/homes-co-nz-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Homes.co.nz $1💰 URL | Search | Property Scraper", "description": "From $1/1K. Scrape Homes.co.nz listings via search or URL. Supports multiple locations or links per run with forward pagination. Extract enriched data, including property details, agents, branch info, valuations, media, open homes, and filters for status, price, beds, and baths.", "version": "1.0", "x-build-id": "55VOf0uJHVm4BgMqZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abotapi~homes-co-nz-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abotapi-homes-co-nz-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/abotapi~homes-co-nz-scraper/runs": { "post": { "operationId": "runs-sync-abotapi-homes-co-nz-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/abotapi~homes-co-nz-scraper/run-sync": { "post": { "operationId": "run-sync-abotapi-homes-co-nz-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": [ "mode" ], "properties": { "mode": { "title": "Collection Mode", "enum": [ "search", "url" ], "type": "string", "description": "Search mode resolves location names and expands them into listing results. URL mode accepts Homes detail URLs or map URLs directly.", "default": "search" }, "locations": { "title": "Locations", "type": "array", "description": "One or more location names to resolve through Homes and collect listings from.", "items": { "type": "string" } }, "listingStatus": { "title": "Listing Status", "enum": [ "for_sale", "for_rent", "just_sold", "off_market" ], "type": "string", "description": "Choose which Homes listing bucket to collect.", "default": "for_sale" }, "minBedrooms": { "title": "Min Bedrooms", "minimum": 0, "type": "integer", "description": "Only include listings with at least this many bedrooms when the structured feed exposes that filter." }, "minBathrooms": { "title": "Min Bathrooms", "minimum": 0, "type": "integer", "description": "Only include listings with at least this many bathrooms when the structured feed exposes that filter." }, "minPrice": { "title": "Min Price (NZD)", "minimum": 0, "type": "integer", "description": "Lower price bound to send to the structured Homes query when supported for the chosen listing status." }, "maxPrice": { "title": "Max Price (NZD)", "minimum": 0, "type": "integer", "description": "Upper price bound to send to the structured Homes query when supported for the chosen listing status." }, "sortBy": { "title": "Sort By", "enum": [ "default", "published_desc", "published_asc", "price_desc", "price_asc" ], "type": "string", "description": "Applies to the output ordering of collected listings. Price sorting only affects records where a numeric price can be derived from the structured listing data.", "default": "default" }, "urls": { "title": "Homes URLs", "type": "array", "description": "One or more homes.co.nz detail URLs or map URLs. Multi-URL supported. Detail URLs return a single enriched listing. Map URLs expand into structured result pages and walk forward — when used this way, the search filters and sort above also apply.", "items": { "type": "string" } }, "maxListings": { "title": "Max Listings (global cap)", "minimum": 0, "type": "integer", "description": "Hard ceiling on listings output across the whole run — pagination stops as soon as this is hit, in both Search and URL modes. Use 0 for no explicit cap.", "default": 20 }, "maxPages": { "title": "Max Pages Per Search", "minimum": 1, "maximum": 3000, "type": "integer", "description": "Maximum output pages to emit for each search target or map URL. Defaults to the cap so pagination only stops at maxListings — lower it to throttle deep walks.", "default": 200 }, "pageSize": { "title": "Listings Per Page", "minimum": 1, "maximum": 100, "type": "integer", "description": "Number of listings to emit on each output page.", "default": 20 }, "fetchPropertyCards": { "title": "Fetch Property Cards (extra cost)", "type": "boolean", "description": "Include extra valuation, title, branch, and agent data when available. Adds one additional request per listing — disable to cut cost when you only need core fields.", "default": true }, "includeRawApiResponses": { "title": "Include Raw Structured Payloads (debug)", "type": "boolean", "description": "Include the raw structured API payloads in each output item for debugging.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy configuration for Homes requests. Apify Proxy is recommended for production runs.", "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 } } }, "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 } } } } } } } } } } ```