# OneRoof.co.nz Scraper — New Zealand Property Listings (`vladignatyev/oneroof-nz-scraper`) Actor Scrape OneRoof.co.nz property listings into clean JSON, CSV or Excel. Extract New Zealand real estate data — price, beds, baths, car spaces, address, suburb, region and geo — for residential, commercial, rural and business listings. A property dataset for investors and lead generation. - **URL**: https://apify.com/vladignatyev/oneroof-nz-scraper.md - **Developed by:** [Vladimir Ignatev](https://apify.com/vladignatyev) (community) - **Categories:** Real estate, Lead generation, Developer tools - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $0.85 / 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 ## OneRoof.co.nz Scraper — New Zealand Property Listings Scrape **oneroof.co.nz** property listings into clean JSON, CSV or Excel — price, beds, baths, car spaces, floor/land area, address, suburb, region, agent and geo across **residential, commercial, rural and business** for-sale / for-lease / rental listings in New Zealand. ### What you get | Field | Notes | |-------|-------| | `id`, `propertyId`, `url` | OneRoof uid + numeric id + direct link | | `category`, `saleType`, `listingType` | e.g. residential-for-sale; sale/rent/lease | | `propertyType` | House, Apartment, Section, Unit, … | | `priceDisplay`, `price`, `priceUnit`, `currency` | Display string + numeric NZD (null for auction/negotiation) | | `beds`, `baths`, `carspaces` | | | `floorAreaSqm`, `landAreaSqm` | | | `street`, `suburb`, `district`, `region`, `country` | Location | | `lat`, `lng` | Coordinates | | `agentName`, `officeName`, `listingRef` | Agent / agency / ref | | `listingDate`, `mainImage`, `imagesCount`, `description` | | | `scrapedAt`, `source` | Run metadata | ### Input ```json { "categories": ["residential-for-sale", "commercial-for-sale"], "maxItems": 500 } ```` - **categories** — residential-for-sale, rental, new-home, commercial-for-sale, commercial-for-lease, rural-for-sale, businesses-for-sale. - **maxItems** — stop after this many listings. - **proxyConfiguration** — residential New Zealand proxy recommended. ### How it works OneRoof publishes a sitemap index per category (see robots.txt) → region-sharded child sitemaps → listing detail pages. Detail pages are Next.js app-router: the listing object lives in the `self.__next_f` RSC stream. This actor walks the sitemaps, fetches each listing page, reassembles the RSC stream, brace-matches the listing object (matched to the page by its `uid`), and supplements address/geo/image from JSON-LD. Public listing pages only; respects robots.txt. # Actor input Schema ## `categories` (type: `array`): Which OneRoof listing categories to scrape (one sitemap each). ## `maxItems` (type: `integer`): Stop after this many listings. ## `proxyConfiguration` (type: `object`): Residential New Zealand proxy recommended. ## Actor input object example ```json { "categories": [ "residential-for-sale" ], "maxItems": 100, "proxyConfiguration": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "NZ" } } ``` # Actor output Schema ## `listings` (type: `string`): All listings scraped in this run, as dataset items. ## `listingsCsv` (type: `string`): Same dataset, ready to open in Excel / Google Sheets. ## `datasetInConsole` (type: `string`): Browse the results table in the UI. # 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 = {}; // Run the Actor and wait for it to finish const run = await client.actor("vladignatyev/oneroof-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 = {} # Run the Actor and wait for it to finish run = client.actor("vladignatyev/oneroof-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 '{}' | apify call vladignatyev/oneroof-nz-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=vladignatyev/oneroof-nz-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "OneRoof.co.nz Scraper — New Zealand Property Listings", "description": "Scrape OneRoof.co.nz property listings into clean JSON, CSV or Excel. Extract New Zealand real estate data — price, beds, baths, car spaces, address, suburb, region and geo — for residential, commercial, rural and business listings. A property dataset for investors and lead generation.", "version": "0.1", "x-build-id": "qDS21oummLSpakP1j" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vladignatyev~oneroof-nz-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vladignatyev-oneroof-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/vladignatyev~oneroof-nz-scraper/runs": { "post": { "operationId": "runs-sync-vladignatyev-oneroof-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/vladignatyev~oneroof-nz-scraper/run-sync": { "post": { "operationId": "run-sync-vladignatyev-oneroof-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", "properties": { "categories": { "title": "Categories", "type": "array", "description": "Which OneRoof listing categories to scrape (one sitemap each).", "items": { "type": "string", "enum": [ "residential-for-sale", "rental", "new-home", "commercial-for-sale", "commercial-for-lease", "rural-for-sale", "businesses-for-sale" ], "enumTitles": [ "Residential for sale", "Rental", "New homes", "Commercial for sale", "Commercial for lease", "Rural for sale", "Businesses for sale" ] }, "default": [ "residential-for-sale" ] }, "maxItems": { "title": "Max items", "type": "integer", "description": "Stop after this many listings.", "default": 100 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Residential New Zealand proxy recommended.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "NZ" } } } }, "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 } } } } } } } } } } ```