# Realestate.co.nz Scraper โ NZ Property Listings & Valuations (`blackfalcondata/realestate-co-nz-scraper`) Actor
Scrape realestate.co.nz โ New Zealand's property portal. Get the council valuation and sales history behind every address, school zones and open homes, plus each listing's price and the agent's email and phone.
- **URL**: https://apify.com/blackfalcondata/realestate-co-nz-scraper.md
- **Developed by:** [Black Falcon Data](https://apify.com/blackfalcondata) (community)
- **Categories:** Real estate, Lead generation, Automation
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet
## Pricing
from $0.40 / 1,000 property listings
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/docs.md):
```bash
npm install apify-client
```
In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.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/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
### What does Realestate.co.nz Scraper do?
Realestate.co.nz Scraper collects property listings from realestate.co.nz, New Zealand's property portal. Every record carries the price, address, bedrooms and bathrooms, full-resolution photos, the agent's email and phone โ and the data that usually sits behind paid tools: the council valuation (RV/CV), an estimated value, and the dwelling's full sales history.
Filter by suburb, price band, property type or map area, watch for price drops, and export structured JSON, CSV or Excel.
### How to use this actor
- ๐ **Register for a free Apify account** โ no credit card required.
- ๐ Just click **[Sign up free on Apify โ](https://console.apify.com/sign-up?fpr=1h3gvi&fp_sid=ctarich)** and complete a quick signup.
- ๐ฐ A free Apify account includes $5 in monthly credits โ enough to test this actor.
- โณ Scrape during the free trial, with no commitment or upfront payment required.
### Key features
- **๐ฆ Council valuation, estimated value & sales history** โ council rating valuation (capital, land, improvements), an estimated value with low/mid/high range, and the dwelling's full sale history on every listing โ 98% and 95% fill. Toggle with `includeValuation`.
- **๐ School zones, in-zone flagged** โ up to 30 nearby schools and childcare centres per listing, each with its distance and whether the property falls inside the enrolment zone.
- **๐ต Structured pricing** โ listing price parsed into `priceMin` / `priceMax` / `priceCurrency` with period (per night / per month / total) where applicable. Hidden-price flag preserved.
- **โป๏ธ Incremental mode** โ daily runs emit only listings that are new or whose price/condition changed since last run. Perfect for inventory-diff dashboards and competitive pricing alerts. Saves 80โ95% on recurring monitoring.
- **๐ Notifications** โ telegram / Slack / Discord / WhatsApp / webhook alerts on each run. Combine with incremental to ping only when prices or inventory actually move.
- **๐ Paste-mode** โ paste any realestate.co.nz URL โ single-listing pages, search-results, or category SEO URLs. Build the filter you want in the browser, copy, paste; the actor parses every query param.
- **๐จ Auction, deadline & tender dates** โ auction, deadline-sale and tender dates with venues, plus every scheduled open home โ or track only listings whose asking price moved.
- **๐ง Email + phone extraction** โ best-effort regex extraction of contact emails and phone numbers from descriptions โ emitted as `extractedEmails[]` and `extractedPhones[]` on every record.
- **๐ฆ Compact mode** โ light payload with core fields only โ comparable rows across listings without HTML or metadata overhead. Perfect for pricing dashboards.
### What data can you extract from realestate.co.nz?
Each result includes Core listing fields (`listingId`, `listingKey`, `propertyShortId`, `title`, `url`, `category`, `propertyType`, and `listingStatus`, and more), detail fields when enrichment is enabled (`description`, `descriptionText`, `descriptionHtml`, and `descriptionMarkdown`), and contact information (`contactEmail` and `contactPhone`). In standard mode, all fields are always present โ unavailable data points are returned as `null`, never omitted. In compact mode, only core fields are returned.
### Input
The main inputs are a search keyword and a result limit. Additional filters and options are available in the input schema.
Key parameters:
- **`category`** โ What kind of listings to collect. Use a JSON array for several at once, e.g. ["res_sale","res_rent"]. (default: `"res_sale"`)
- **`region`** โ Region name, e.g. "Auckland" or "Otago". Pass a JSON array to cover several at once, e.g. ["Auckland","Waikato"]. Leave every location field empty to search all of New Zealand.
- **`district`** โ District name, e.g. "Auckland City" or "Christchurch City". A JSON array covers several districts in one run.
- **`suburb`** โ Suburb name, e.g. "Ponsonby". Pass a JSON array to cover a shortlist. Some suburb names repeat around the country โ every match is searched.
- **`query`** โ Optional free-text keyword, e.g. "waterfront" or "renovated". Leave empty to browse everything in the selected area.
- **`startUrls`** โ Paste search URLs from the site, e.g. https://www.realestate.co.nz/residential/sale/auckland/auckland-city. Each becomes its own search; results are merged and deduplicated. When provided, these replace the fields above. (default: `[]`)
- **`minPrice`** โ Minimum price in NZD โ weekly rent when the listing type is a rental.
- **`maxPrice`** โ Maximum price in NZD (weekly rent for rentals). Listings advertised as "Auction" or "Deadline Sale" carry no number, so a price filter leaves them out.
- **`propertyType`** โ e.g. "House", "Apartment", "Townhouse", "Unit", "Section". A JSON array selects more than one. Which types exist depends on the listing type selected above.
- **`minBedrooms`** โ Only listings with at least this many bedrooms.
- **`maxBedrooms`** โ Only listings with at most this many bedrooms.
- **`minBathrooms`** โ Only listings with at least this many bathrooms.
- ...and 40 more parameters
### Input examples
**Houses in Auckland with the valuation behind every address** โ 3+ bedroom houses for sale, each with the council valuation, estimated value and full sales history joined on.
โ Up to 100 listings with price, features, photos, school zones, agent contacts and valuation data.
```json
{
"category": "res_sale",
"region": "Auckland",
"propertyType": "House",
"minBedrooms": 3,
"includeValuation": true,
"maxResults": 100
}
````
**Keyword search โ waterfront listings under $2m** โ The keyword narrows to listings mentioning "waterfront"; the price band drops anything advertised without a number (auctions, deadline sales).
โ Waterfront properties priced $500kโ$2m, newest first.
```json
{
"query": "waterfront",
"category": "res_sale",
"minPrice": 500000,
"maxPrice": 2000000,
"sort": "latest",
"maxResults": 50
}
```
**Paste a search URL straight from the site** โ Any realestate.co.nz search page works โ the actor reads the category and location out of the URL.
โ Every current listing in Ponsonby, Auckland City.
```json
{
"startUrls": [
"https://www.realestate.co.nz/residential/sale/auckland/auckland-city/ponsonby"
],
"maxResults": 100
}
```
**Price-drop tracker** โ Only listings whose asking price changed on or after the date โ the price history shows the old and new figure.
โ Recently repriced listings with their price history and council valuation.
```json
{
"category": "res_sale",
"priceChangedSince": "2026-06-19",
"sort": "latest",
"maxResults": 100
}
```
**Daily new-listings monitor** โ Run on a schedule: each run returns only what is NEW or UPDATED since the last one, and re-listed properties are flagged.
โ Fresh Wellington rentals only โ unchanged listings are skipped, so repeat runs stay cheap.
```json
{
"category": "res_rent",
"region": "Wellington",
"petsAllowed": true,
"incrementalMode": true,
"notifyOnlyChanges": true,
"maxResults": 200
}
```
### Output
Each run produces a dataset of structured listing records. Results can be downloaded as JSON, CSV, or Excel from the Dataset tab in Apify Console.
### Example listing record
```json
{
"listingId": "b27fb5a61d13e123629cc694c636860ff73fdb193ae779374bad9abdcfe9472c",
"listingKey": "01435",
"propertyShortId": "jwq2x8vxc",
"title": "Move in, live beautifully",
"url": "https://www.realestate.co.nz/43082994/residential/sale/3-norfolk-street-ponsonby",
"category": "res_sale",
"propertyType": "House",
"listingStatus": "active",
"titleType": 1,
"description": "Behind its timeless villa faรงade lies something truly unexpected.
Completely reimagined, this is a residence where every finish, fixture and detail has been elevated. The work is done. T...",
"descriptionHtml": "
Behind its timeless villa faรงade lies something truly unexpected.
Completely reimagined, this is a residence where every finish, fixture and detail has been elevated. The work is done. T...",
"priceText": "Auction",
"priceCurrency": "NZD",
"priceCode": 5,
"auctionDate": "2026-07-29T15:00:00+12:00",
"auctionLocation": "On Site",
"openHomes": [
{
"start": "2026-07-12T12:00:00+12:00",
"end": "2026-07-12T12:45:00+12:00"
},
{
"start": "2026-07-16T17:30:00+12:00",
"end": "2026-07-16T18:00:00+12:00"
},
{
"start": "2026-07-19T12:00:00+12:00",
"end": "2026-07-19T12:45:00+12:00"
},
{
"start": "2026-07-22T12:30:00+12:00",
"end": "2026-07-22T13:00:00+12:00"
},
{
"start": "2026-07-26T12:00:00+12:00",
"end": "2026-07-26T12:45:00+12:00"
}
],
"address": "3 Norfolk Street, Ponsonby, Auckland City, Auckland",
"displayAddress": "3 Norfolk Street, Ponsonby",
"streetNumber": "3",
"streetName": "Norfolk Street",
"suburb": "Ponsonby",
"district": "Auckland City",
"region": "Auckland",
"postcode": "1021",
"latitude": -36.854791,
"longitude": 174.7452905,
"bedrooms": 3,
"bathrooms": 2,
"bathroomsMain": 2,
"bathroomsEnsuite": 0,
"bathroomsFull": 2,
"bathroomsWc": 0,
"landArea": 392,
"landAreaUnit": "SQM",
"parkingGarage": 2,
"parkingCovered": 0,
"parkingOther": 1,
"hasSwimmingPool": true,
"isNewConstruction": false,
"isCoastalWaterfront": false,
"isMortgageeSale": false,
"isPrivateListing": false,
"imageUrl": "https://mediaserver.realestate.co.nz/listings/43082994/b8fff691ec701615da121aa6fe7ed578.jpg",
"galleryUrls": [
"https://mediaserver.realestate.co.nz/listings/43082994/b8fff691ec701615da121aa6fe7ed578.jpg",
"https://mediaserver.realestate.co.nz/listings/43082994/792c90a21e690fa7351c65c7b8d6c2dc.jpg",
"https://mediaserver.realestate.co.nz/listings/43082994/b81f178b298cb5ba18f6cbe1dc98d7bd.jpg",
"https://mediaserver.realestate.co.nz/listings/43082994/585d7bc56606e8f35777c2db9b596d46.jpg",
"https://mediaserver.realestate.co.nz/listings/43082994/1d479091b7f08a01b1cfeb3c3e8ac2b0.jpg",
"... 20 more items"
],
"additionalWebsiteUrls": [
"https://www.kellands.co.nz/01435"
],
"schools": [
{
"name": "Richmond Road School",
"slug": "richmond-road-school",
"distanceKm": 0.51,
"hasZone": true,
"inZone": true,
"latitude": -36.856164,
"longitude": 174.739777
},
{
"name": "Auckland Girls' Grammar School",
"slug": "auckland-girls-grammar-school",
"distanceKm": 0.78,
"hasZone": true,
"inZone": true,
"latitude": -36.856867,
"longitude": 174.753659
},
{
"name": "Ponsonby Intermediate",
"slug": "ponsonby-intermediate",
"distanceKm": 0.9,
"hasZone": true,
"inZone": true,
"latitude": -36.848062,
"longitude": 174.739685
},
{
"name": "Western Springs College",
"slug": "western-springs-college",
"distanceKm": 2.6,
"hasZone": true,
"inZone": true,
"latitude": -36.861976,
"longitude": 174.717535
},
{
"name": "Freemans Bay School",
"slug": "freemans-bay-school",
"distanceKm": 0.74,
"hasZone": true,
"inZone": false,
"latitude": -36.852048,
"longitude": 174.75281
},
"... 25 more items"
],
"childCares": [
{
"name": "Kindercare Auckland CBD",
"slug": "kindercare-auckland-cbd",
"distanceKm": 2.12,
"hasZone": false,
"inZone": false,
"latitude": -36.843853,
"longitude": 174.764801
},
{
"name": "Kindercare Three Kings",
"slug": "kindercare-three-kings",
"distanceKm": 4.8,
"hasZone": false,
"inZone": false,
"latitude": -36.89690781,
"longitude": 174.757019
},
{
"name": "Kindercare Grey Lynn",
"slug": "kindercare-grey-lynn",
"distanceKm": 1.21,
"hasZone": false,
"inZone": false,
"latitude": -36.86559296,
"longitude": 174.7465668
},
{
"name": "ACG Parnell Early Learning School",
"slug": "acg-parnell-early-learning-school",
"distanceKm": 2.57,
"hasZone": false,
"inZone": false,
"latitude": -36.86439133,
"longitude": 174.7715759
},
{
"name": "The Learning Space - Eden Terrace",
"slug": "the-learning-space-eden-terrace",
"distanceKm": 1.37,
"hasZone": false,
"inZone": false,
"latitude": -36.86342239,
"longitude": 174.7562714
},
"... 25 more items"
],
"agents": [
{
"name": "Charles Collins",
"email": "charles@kellands.co.nz",
"phone": "021 376 095",
"jobTitle": "Licensee Salesperson",
"profileUrl": "https://www.realestate.co.nz/agent/charles-collins",
"listingCount": 6
},
{
"name": "Martin Dobson",
"email": "martin.dobson@kellands.co.nz",
"phone": "021 376 952",
"jobTitle": "Licensee Salesperson",
"profileUrl": "https://www.realestate.co.nz/agent/martin-dobson",
"listingCount": 7
}
],
"office": {
"name": "Kellands Real Estate Ltd (Licensed: REAA 2008) - Freemans Bay",
"email": "michelle@kellands.co.nz",
"phone": "09 300 4001",
"websiteUrl": "https://www.kellands.co.nz",
"profileUrl": "https://www.realestate.co.nz/office/kellands-real-estate-ltd-licensed-reaa-2008-freemans-bay",
"listingCount": 0
},
"sellerName": "Kellands Real Estate Ltd (Licensed: REAA 2008) - Freemans Bay",
"sellerUrl": "https://www.realestate.co.nz/office/kellands-real-estate-ltd-licensed-reaa-2008-freemans-bay",
"sellerWebsite": "https://www.kellands.co.nz",
"contactEmail": "charles@kellands.co.nz",
"contactPhone": "021 376 095",
"estimatedValue": {
"low": 3651000,
"mid": 4167000,
"high": 4566000,
"confidence": 4,
"asAt": "2026-07-01"
},
"councilValuation": {
"capitalValue": 3975000,
"landValue": 2025000,
"improvementsValue": 1950000,
"valuedAt": "2024-07-01"
},
"salesHistory": [
{
"saleDate": "2023-01-13",
"salePrice": 4650000,
"netSalePrice": 4650000,
"salePriceDisplay": "$4,650,000",
"saleMethod": "P - Private Treaty(Neg.)",
"isSettled": true
},
{
"saleDate": "2002-09-20",
"salePrice": 505000,
"netSalePrice": 505000,
"salePriceDisplay": "$505,000",
"isSettled": true
},
{
"saleDate": "1998-11-30",
"salePrice": 400000,
"netSalePrice": 400000,
"salePriceDisplay": "$400,000",
"saleMethod": "A - Auction",
"isSettled": true
}
],
"lastSale": {
"saleDate": "2023-01-13",
"salePrice": 4650000,
"netSalePrice": 4650000,
"salePriceDisplay": "$4,650,000",
"saleMethod": "P - Private Treaty(Neg.)",
"isSettled": true
},
"buildingAge": 1900,
"nearbyRecentSales": [
{
"saleDate": "2026-06-18",
"salePriceDisplay": "$3,000,000.0",
"isSettled": false
},
{
"saleDate": "2026-05-06",
"salePriceDisplay": "$3,900,000.0",
"isSettled": true
},
{
"saleDate": "2026-04-08",
"salePriceDisplay": "$2,300,000.0",
"isSettled": true
},
{
"saleDate": "2026-04-07",
"salePriceDisplay": "$1,200,000.0",
"isSettled": true
},
{
"saleDate": "2026-04-01",
"salePriceDisplay": "$3,325,000.0",
"isSettled": false
},
"... 34 more items"
],
"publishedAt": "2026-07-07T16:34:07+12:00",
"createdAt": "2026-07-07T16:34:07+12:00",
"searchQuery": "res_sale / Ponsonby",
"contentQuality": "full",
"scrapedAt": "2026-07-17T11:36:49.208Z",
"source": "realestate.co.nz"
}
```
### Incremental fields
When incremental mode is on, each record also carries:
- `changeType` โ one of `NEW`, `UPDATED`, `UNCHANGED`, `REAPPEARED`, `EXPIRED`. Default output covers `NEW` / `UPDATED` / `REAPPEARED`; set `emitUnchanged: true` or `emitExpired: true` to opt into the others.
- `isRepost`, `repostOfId`, `repostDetectedAt` โ populated when a new listing matches the tracked content of a previously expired one. Set `skipReposts: true` to drop detected reposts from the output.
### How to scrape realestate.co.nz
1. Go to [Realestate.co.nz Scraper](https://apify.com/blackfalcondata/realestate-co-nz-scraper?fpr=1h3gvi) in Apify Console.
2. Enter a search keyword.
3. Set `maxResults` to control how many results you need.
4. Click **Start** and wait for the run to finish.
5. Export the dataset as JSON, CSV, or Excel.
### Use cases
- Extract listing data from realestate.co.nz for market research and competitive analysis.
- Track pricing trends across regions and categories over time.
- Monitor new and changed listings on scheduled runs without processing the full dataset every time.
- Use structured location data for regional analysis, mapping, and geo-targeting.
- Feed structured data into AI agents, MCP tools, and automated pipelines using compact mode.
- Export clean, structured data to dashboards, spreadsheets, or data warehouses.
### How much does it cost to scrape realestate.co.nz?
Realestate.co.nz Scraper uses [pay-per-event](https://docs.apify.com/platform/actors/paid-actors/pay-per-event) pricing. You pay a small fee when the run starts and then for each result that is actually produced.
- **Run start:** $0.005 per run
- **Per listing (primary event):** $0.0004
You are billed only for the events your run actually triggers. Prices below are the Free plan tier.
| Event | Price (Free tier) | Charged when |
|---|---|---|
| Run start | $0.005 (one-time) | Charged once per run. |
| Property listing (primary) | $0.0004 | Charged for each property returned, with its price, address, features, photos, open homes, school zones and listing agent. |
| Valuation & sales history | $0.001 | Charged only for properties that come back with valuation data โ the council valuation, the estimated value and past sales. Turn it off with the valuation setting. |
Example costs (primary event only โ other events above add cost when they fire):
- 10 results: **$0.009**
- 25 results: **$0.015**
- 100 results: **$0.045**
- 200 results: **$0.085**
- 500 results: **$0.21**
#### Example: recurring monitoring savings
These examples compare full re-scrapes with incremental runs at different churn rates. Churn is the share of listings that are new or whose tracked content changed since the previous run. Actual churn depends on your query breadth, source activity, and polling frequency โ the scenarios below are examples, not predictions.
Example setup: 100 results per run, daily polling (30 runs/month). Event-pricing examples scale linearly with result count.
Numbers below are for the primary **Property listing** event. Other events (**Valuation & sales history**) are billed separately when they fire.
| Churn rate | Full re-scrape run cost | Incremental run cost | Savings vs full re-scrape | Monthly cost after baseline |
|---|---:|---:|---:|---:|
| 5% โ stable niche query | $0.04 | $0.007 | $0.04 (84%) | $0.21 |
| 15% โ moderate broad query | $0.04 | $0.01 | $0.03 (76%) | $0.33 |
| 30% โ high-volume aggregator | $0.04 | $0.02 | $0.03 (62%) | $0.51 |
Full re-scrape monthly cost at daily polling: $1.35. First month with incremental costs $0.25 / $0.36 / $0.54 for the 5% / 15% / 30% scenarios because the first run builds baseline state at full cost before incremental savings apply.
Platform usage is included in the per-result fee shown above.
### FAQ
#### How many results can I get from realestate.co.nz?
The number of results depends on the search query and available listings on realestate.co.nz. Use the `maxResults` parameter to control how many results are returned per run.
#### Does Realestate.co.nz Scraper support recurring monitoring?
Yes. Enable incremental mode to only receive new or changed listings on subsequent runs. This is ideal for scheduled monitoring where you want to track changes over time without re-processing the full dataset.
#### Can I integrate Realestate.co.nz Scraper with other apps?
Yes. Realestate.co.nz Scraper works with Apify's [integrations](https://apify.com/integrations?fpr=1h3gvi) to connect with tools like Zapier, Make, Google Sheets, Slack, and more. You can also use webhooks to trigger actions when a run completes.
#### Can I use Realestate.co.nz Scraper with the Apify API?
Yes. You can start runs, manage inputs, and retrieve results programmatically through the [Apify API](https://docs.apify.com/api/v2). Client libraries are available for JavaScript, Python, and other languages.
#### Can I use Realestate.co.nz Scraper through an MCP Server?
Yes. Apify provides an [MCP Server](https://apify.com/apify/actors-mcp-server?fpr=1h3gvi) that lets AI assistants and agents call this actor directly. Use compact mode, `descriptionMaxLength`, a single `descriptionFormat`, and `excludeEmptyFields` to keep payloads manageable for LLM context windows.
#### Is it legal to scrape realestate.co.nz?
This actor extracts publicly available data from realestate.co.nz. Web scraping of public information is generally considered legal, but you should always review the target site's terms of service and ensure your use case complies with applicable laws and regulations, including GDPR where relevant.
#### Your feedback
If you have questions, need a feature, or found a bug, please [open an issue](https://apify.com/blackfalcondata/realestate-co-nz-scraper/issues?fpr=1h3gvi) on the actor's page in Apify Console. Your feedback helps us improve.
### You might also like
- [Comparis.ch Real Estate Scraper - Property Listings](https://apify.com/blackfalcondata/comparis-scraper?fpr=1h3gvi) โ Scrape comparis.ch real estate listings with deal type, property type, rooms, price, living space.
- [HAR Texas Real Estate Scraper](https://apify.com/blackfalcondata/har-scraper?fpr=1h3gvi) โ Scrape har.com โ the largest Texas MLS portal โ for homes for sale, for rent and sold across.
- [Harcourts Property Scraper โ buy, rent, sold & leased](https://apify.com/blackfalcondata/harcourts-scraper?fpr=1h3gvi) โ Scrape harcourts.net property listings across Australia, New Zealand and Fiji โ buy, rent, sold.
- [Idealista Scraper โ Spain, Portugal & Italy](https://apify.com/blackfalcondata/idealista-scraper?fpr=1h3gvi) โ Scrape idealista.com / .pt / .it property listings with prices, photos, GPS, agent phone numbers.
### Getting started with Apify
New to Apify? [Create a free account with $5 credit](https://console.apify.com/sign-up?fpr=1h3gvi\&fp_sid=ctarich) โ no credit card required.
1. Sign up โ $5 platform credit included
2. Open this actor and configure your input
3. Click **Start** โ export results as JSON, CSV, or Excel
Need more later? [See Apify pricing](https://apify.com/pricing?fpr=1h3gvi).
# Actor input Schema
## `category` (type: `string`):
What kind of listings to collect. Use a JSON array for several at once, e.g. \["res\_sale","res\_rent"].
## `region` (type: `string`):
Region name, e.g. "Auckland" or "Otago". Pass a JSON array to cover several at once, e.g. \["Auckland","Waikato"]. Leave every location field empty to search all of New Zealand.
## `district` (type: `string`):
District name, e.g. "Auckland City" or "Christchurch City". A JSON array covers several districts in one run.
## `suburb` (type: `string`):
Suburb name, e.g. "Ponsonby". Pass a JSON array to cover a shortlist. Some suburb names repeat around the country โ every match is searched.
## `query` (type: `string`):
Optional free-text keyword, e.g. "waterfront" or "renovated". Leave empty to browse everything in the selected area.
## `startUrls` (type: `array`):
Paste search URLs from the site, e.g. https://www.realestate.co.nz/residential/sale/auckland/auckland-city. Each becomes its own search; results are merged and deduplicated. When provided, these replace the fields above.
## `minPrice` (type: `integer`):
Minimum price in NZD โ weekly rent when the listing type is a rental.
## `maxPrice` (type: `integer`):
Maximum price in NZD (weekly rent for rentals). Listings advertised as "Auction" or "Deadline Sale" carry no number, so a price filter leaves them out.
## `propertyType` (type: `string`):
e.g. "House", "Apartment", "Townhouse", "Unit", "Section". A JSON array selects more than one. Which types exist depends on the listing type selected above.
## `minBedrooms` (type: `integer`):
Only listings with at least this many bedrooms.
## `maxBedrooms` (type: `integer`):
Only listings with at most this many bedrooms.
## `minBathrooms` (type: `integer`):
Only listings with at least this many bathrooms.
## `maxBathrooms` (type: `integer`):
Only listings with at most this many bathrooms.
## `minCarparks` (type: `integer`):
Only listings with at least this many carparks, counting garages, carports and open spaces.
## `minLandArea` (type: `integer`):
Minimum land area in square metres.
## `maxLandArea` (type: `integer`):
Maximum land area in square metres.
## `minFloorArea` (type: `integer`):
Minimum floor area in square metres.
## `maxFloorArea` (type: `integer`):
Maximum floor area in square metres.
## `hasSwimmingPool` (type: `boolean`):
Only listings with a swimming pool.
## `isNewConstruction` (type: `boolean`):
Only newly built properties.
## `isCoastalWaterfront` (type: `boolean`):
Only properties on the coast or waterfront.
## `isMortgageeSale` (type: `boolean`):
Forced sales by a lender โ often priced below market.
## `isOpenHome` (type: `boolean`):
Only listings with an open home coming up.
## `petsAllowed` (type: `boolean`):
Rentals only.
## `includeNearbySuburbs` (type: `boolean`):
Widen a suburb search to neighbouring suburbs.
## `priceChangedSince` (type: `string`):
Only listings whose asking price changed on or after this date (YYYY-MM-DD). Use it to track price drops.
## `geoBoundingBox` (type: `string`):
Search inside a map rectangle: "lat,lng|lat,lng" giving the north-west corner then the south-east corner, e.g. "-36.8,174.7|-36.9,174.9".
## `sort` (type: `string`):
How results are ordered. Listings advertised without a number ("Auction", "Deadline Sale") group together when sorting by price.
## `maxResults` (type: `integer`):
Maximum listings to return (0 = as many as possible).
## `includeValuation` (type: `boolean`):
Add the council valuation (RV/CV), the estimated value, past sales and building age to each listing. Adds roughly a minute per 1,000 listings, and costs extra only for listings that come back with valuation data. Turn it off for the fastest, cheapest run.
## `descriptionMaxLength` (type: `integer`):
Truncate the description to N characters. 0 = no truncation.
## `compact` (type: `boolean`):
Core fields only (for AI-agent/MCP workflows).
## `descriptionFormat` (type: `string`):
Pick a single description representation. `all` keeps every variant; `text` / `html` / `markdown` drop the others.
## `excludeEmptyFields` (type: `boolean`):
Drop null, empty-string, and empty-array fields from each record before push. Smaller payloads for AI agents and dashboards.
## `incrementalMode` (type: `boolean`):
Compare against the previous run and label each listing NEW, UPDATED, UNCHANGED or EXPIRED. The state key is optional โ it is derived from your search settings, so different filters never share state.
## `stateKey` (type: `string`):
Optional. Stable identifier for the tracked search. Leave empty to generate one from the search inputs.
## `emitUnchanged` (type: `boolean`):
When incremental mode is on, also return listings that have not changed since the last run.
## `emitExpired` (type: `boolean`):
When incremental mode is on, also return listings that have disappeared since the last run, marked EXPIRED.
## `skipReposts` (type: `boolean`):
When incremental mode is on, drop properties that were withdrawn and listed again under a new ID. Every record is flagged either way, so leave this off to see them.
## `telegramToken` (type: `string`):
Telegram bot token (from @BotFather). Required for Telegram notifications.
## `telegramChatId` (type: `string`):
Telegram chat or channel ID (e.g. "-100123456789"). Required when telegramToken is set.
## `discordWebhookUrl` (type: `string`):
Discord incoming webhook URL. Server Settings โ Integrations โ Webhooks โ New Webhook.
## `slackWebhookUrl` (type: `string`):
Slack incoming webhook URL. api.slack.com/messaging/webhooks.
## `notificationLimit` (type: `integer`):
Maximum number of listings included in each notification message (1โ20).
## `notifyOnlyChanges` (type: `boolean`):
When incremental mode is on, only send notifications for NEW and UPDATED listings. Has no effect otherwise.
## `whatsappAccessToken` (type: `string`):
WhatsApp Cloud API permanent access token (System User token from Meta Business). Recipient must have messaged the business number within the last 24h (service-conversation window โ free since Nov 2024).
## `whatsappPhoneNumberId` (type: `string`):
Your WhatsApp Business phone-number ID (numeric, from Meta dashboard). Required when whatsappAccessToken is set.
## `whatsappTo` (type: `string`):
Recipient phone in E.164 format without + (e.g. "6421234567"). Recipient must have messaged your business number within last 24h.
## `webhookUrl` (type: `string`):
Receives a JSON POST with {metadata, items} after each run. Universal escape hatch for n8n / Make / Zapier / custom backends.
## `webhookHeaders` (type: `object`):
Optional JSON object of custom headers (e.g. {"Authorization":"Bearer ..."}).
## `appConnector` (type: `string`):
Optional. Pick a connected app under Settings โ API & Integrations to receive your results (including any contact details). Best-effort across MCP connectors as Apify expands its catalog.
## `mcpIssueTeam` (type: `string`):
Only when the connected app is an issue tracker: the team (name or ID) the summary issue is created under, if that app requires one.
## Actor input object example
```json
{
"category": "res_sale",
"region": "Auckland",
"startUrls": [],
"hasSwimmingPool": false,
"isNewConstruction": false,
"isCoastalWaterfront": false,
"isMortgageeSale": false,
"isOpenHome": false,
"petsAllowed": false,
"includeNearbySuburbs": false,
"maxResults": 5,
"includeValuation": true,
"descriptionMaxLength": 0,
"compact": false,
"descriptionFormat": "all",
"excludeEmptyFields": false,
"incrementalMode": false,
"emitUnchanged": false,
"emitExpired": false,
"skipReposts": false,
"notificationLimit": 5,
"notifyOnlyChanges": false
}
```
# Actor output Schema
## `results` (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 = {
"category": "res_sale",
"region": "Auckland",
"hasSwimmingPool": false,
"isNewConstruction": false,
"isCoastalWaterfront": false,
"isMortgageeSale": false,
"isOpenHome": false,
"petsAllowed": false,
"includeNearbySuburbs": false,
"maxResults": 5,
"includeValuation": true,
"compact": false,
"descriptionFormat": "all",
"excludeEmptyFields": false,
"incrementalMode": false,
"emitUnchanged": false,
"emitExpired": false,
"skipReposts": false,
"notifyOnlyChanges": false
};
// Run the Actor and wait for it to finish
const run = await client.actor("blackfalcondata/realestate-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 = {
"category": "res_sale",
"region": "Auckland",
"hasSwimmingPool": False,
"isNewConstruction": False,
"isCoastalWaterfront": False,
"isMortgageeSale": False,
"isOpenHome": False,
"petsAllowed": False,
"includeNearbySuburbs": False,
"maxResults": 5,
"includeValuation": True,
"compact": False,
"descriptionFormat": "all",
"excludeEmptyFields": False,
"incrementalMode": False,
"emitUnchanged": False,
"emitExpired": False,
"skipReposts": False,
"notifyOnlyChanges": False,
}
# Run the Actor and wait for it to finish
run = client.actor("blackfalcondata/realestate-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 '{
"category": "res_sale",
"region": "Auckland",
"hasSwimmingPool": false,
"isNewConstruction": false,
"isCoastalWaterfront": false,
"isMortgageeSale": false,
"isOpenHome": false,
"petsAllowed": false,
"includeNearbySuburbs": false,
"maxResults": 5,
"includeValuation": true,
"compact": false,
"descriptionFormat": "all",
"excludeEmptyFields": false,
"incrementalMode": false,
"emitUnchanged": false,
"emitExpired": false,
"skipReposts": false,
"notifyOnlyChanges": false
}' |
apify call blackfalcondata/realestate-co-nz-scraper --silent --output-dataset
```
## MCP server setup
```json
{
"mcpServers": {
"apify": {
"command": "npx",
"args": [
"mcp-remote",
"https://mcp.apify.com/?tools=blackfalcondata/realestate-co-nz-scraper",
"--header",
"Authorization: Bearer "
]
}
}
}
```
## OpenAPI specification
```json
{
"openapi": "3.0.1",
"info": {
"title": "Realestate.co.nz Scraper โ NZ Property Listings & Valuations",
"description": "Scrape realestate.co.nz โ New Zealand's property portal. Get the council valuation and sales history behind every address, school zones and open homes, plus each listing's price and the agent's email and phone.",
"version": "0.1",
"x-build-id": "NH3NALKuWfffCkMeH"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/blackfalcondata~realestate-co-nz-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-blackfalcondata-realestate-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/blackfalcondata~realestate-co-nz-scraper/runs": {
"post": {
"operationId": "runs-sync-blackfalcondata-realestate-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/blackfalcondata~realestate-co-nz-scraper/run-sync": {
"post": {
"operationId": "run-sync-blackfalcondata-realestate-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",
"properties": {
"category": {
"title": "๐ท๏ธ Listing type",
"enum": [
"res_sale",
"res_rent",
"lifestyle_sale",
"lifestyle_lease",
"rural_sale",
"com_sale",
"com_lease",
"biz_sale"
],
"type": "string",
"description": "What kind of listings to collect. Use a JSON array for several at once, e.g. [\"res_sale\",\"res_rent\"].",
"default": "res_sale"
},
"region": {
"title": "๐บ๏ธ Region",
"type": "string",
"description": "Region name, e.g. \"Auckland\" or \"Otago\". Pass a JSON array to cover several at once, e.g. [\"Auckland\",\"Waikato\"]. Leave every location field empty to search all of New Zealand."
},
"district": {
"title": "๐๏ธ District",
"type": "string",
"description": "District name, e.g. \"Auckland City\" or \"Christchurch City\". A JSON array covers several districts in one run."
},
"suburb": {
"title": "๐ Suburb",
"type": "string",
"description": "Suburb name, e.g. \"Ponsonby\". Pass a JSON array to cover a shortlist. Some suburb names repeat around the country โ every match is searched."
},
"query": {
"title": "๐ Keyword",
"type": "string",
"description": "Optional free-text keyword, e.g. \"waterfront\" or \"renovated\". Leave empty to browse everything in the selected area."
},
"startUrls": {
"title": "๐ Start URLs",
"type": "array",
"description": "Paste search URLs from the site, e.g. https://www.realestate.co.nz/residential/sale/auckland/auckland-city. Each becomes its own search; results are merged and deduplicated. When provided, these replace the fields above.",
"items": {
"type": "string"
},
"default": []
},
"minPrice": {
"title": "๐ฐ Min price",
"minimum": 0,
"type": "integer",
"description": "Minimum price in NZD โ weekly rent when the listing type is a rental."
},
"maxPrice": {
"title": "๐ฐ Max price",
"minimum": 0,
"type": "integer",
"description": "Maximum price in NZD (weekly rent for rentals). Listings advertised as \"Auction\" or \"Deadline Sale\" carry no number, so a price filter leaves them out."
},
"propertyType": {
"title": "๐ Property type",
"type": "string",
"description": "e.g. \"House\", \"Apartment\", \"Townhouse\", \"Unit\", \"Section\". A JSON array selects more than one. Which types exist depends on the listing type selected above."
},
"minBedrooms": {
"title": "๐๏ธ Min bedrooms",
"minimum": 0,
"maximum": 20,
"type": "integer",
"description": "Only listings with at least this many bedrooms."
},
"maxBedrooms": {
"title": "๐๏ธ Max bedrooms",
"minimum": 0,
"maximum": 20,
"type": "integer",
"description": "Only listings with at most this many bedrooms."
},
"minBathrooms": {
"title": "๐ Min bathrooms",
"minimum": 0,
"maximum": 20,
"type": "integer",
"description": "Only listings with at least this many bathrooms."
},
"maxBathrooms": {
"title": "๐ Max bathrooms",
"minimum": 0,
"maximum": 20,
"type": "integer",
"description": "Only listings with at most this many bathrooms."
},
"minCarparks": {
"title": "๐ Min carparks",
"minimum": 0,
"maximum": 20,
"type": "integer",
"description": "Only listings with at least this many carparks, counting garages, carports and open spaces."
},
"minLandArea": {
"title": "๐ณ Min land area",
"minimum": 0,
"type": "integer",
"description": "Minimum land area in square metres."
},
"maxLandArea": {
"title": "๐ณ Max land area",
"minimum": 0,
"type": "integer",
"description": "Maximum land area in square metres."
},
"minFloorArea": {
"title": "๐ Min floor area",
"minimum": 0,
"type": "integer",
"description": "Minimum floor area in square metres."
},
"maxFloorArea": {
"title": "๐ Max floor area",
"minimum": 0,
"type": "integer",
"description": "Maximum floor area in square metres."
},
"hasSwimmingPool": {
"title": "๐ Swimming pool only",
"type": "boolean",
"description": "Only listings with a swimming pool.",
"default": false
},
"isNewConstruction": {
"title": "๐๏ธ New builds only",
"type": "boolean",
"description": "Only newly built properties.",
"default": false
},
"isCoastalWaterfront": {
"title": "๐ Coastal / waterfront only",
"type": "boolean",
"description": "Only properties on the coast or waterfront.",
"default": false
},
"isMortgageeSale": {
"title": "โ๏ธ Mortgagee sales only",
"type": "boolean",
"description": "Forced sales by a lender โ often priced below market.",
"default": false
},
"isOpenHome": {
"title": "๐ช Open home scheduled only",
"type": "boolean",
"description": "Only listings with an open home coming up.",
"default": false
},
"petsAllowed": {
"title": "๐ Pets allowed only",
"type": "boolean",
"description": "Rentals only.",
"default": false
},
"includeNearbySuburbs": {
"title": "โ Include nearby suburbs",
"type": "boolean",
"description": "Widen a suburb search to neighbouring suburbs.",
"default": false
},
"priceChangedSince": {
"title": "๐ Price changed since",
"type": "string",
"description": "Only listings whose asking price changed on or after this date (YYYY-MM-DD). Use it to track price drops."
},
"geoBoundingBox": {
"title": "๐บ๏ธ Map area",
"type": "string",
"description": "Search inside a map rectangle: \"lat,lng|lat,lng\" giving the north-west corner then the south-east corner, e.g. \"-36.8,174.7|-36.9,174.9\"."
},
"sort": {
"title": "โ๏ธ Sort order",
"enum": [
"best-match",
"featured",
"latest",
"oldest",
"lowest-price",
"highest-price",
"lowest-land-area",
"highest-land-area"
],
"type": "string",
"description": "How results are ordered. Listings advertised without a number (\"Auction\", \"Deadline Sale\") group together when sorting by price."
},
"maxResults": {
"title": "๐ฏ Max results",
"minimum": 0,
"maximum": 100000,
"type": "integer",
"description": "Maximum listings to return (0 = as many as possible).",
"default": 25
},
"includeValuation": {
"title": "๐ฆ Include valuation & sales history",
"type": "boolean",
"description": "Add the council valuation (RV/CV), the estimated value, past sales and building age to each listing. Adds roughly a minute per 1,000 listings, and costs extra only for listings that come back with valuation data. Turn it off for the fastest, cheapest run.",
"default": true
},
"descriptionMaxLength": {
"title": "โ๏ธ Description max length",
"minimum": 0,
"type": "integer",
"description": "Truncate the description to N characters. 0 = no truncation.",
"default": 0
},
"compact": {
"title": "๐ฆ Compact output",
"type": "boolean",
"description": "Core fields only (for AI-agent/MCP workflows).",
"default": false
},
"descriptionFormat": {
"title": "Description format",
"enum": [
"all",
"text",
"html",
"markdown"
],
"type": "string",
"description": "Pick a single description representation. `all` keeps every variant; `text` / `html` / `markdown` drop the others.",
"default": "all"
},
"excludeEmptyFields": {
"title": "Exclude empty fields from output",
"type": "boolean",
"description": "Drop null, empty-string, and empty-array fields from each record before push. Smaller payloads for AI agents and dashboards.",
"default": false
},
"incrementalMode": {
"title": "โป๏ธ Incremental mode",
"type": "boolean",
"description": "Compare against the previous run and label each listing NEW, UPDATED, UNCHANGED or EXPIRED. The state key is optional โ it is derived from your search settings, so different filters never share state.",
"default": false
},
"stateKey": {
"title": "๐ State key",
"type": "string",
"description": "Optional. Stable identifier for the tracked search. Leave empty to generate one from the search inputs."
},
"emitUnchanged": {
"title": "๐ค Include unchanged listings",
"type": "boolean",
"description": "When incremental mode is on, also return listings that have not changed since the last run.",
"default": false
},
"emitExpired": {
"title": "๐ค Include gone listings",
"type": "boolean",
"description": "When incremental mode is on, also return listings that have disappeared since the last run, marked EXPIRED.",
"default": false
},
"skipReposts": {
"title": "๐ซ Skip re-listed properties",
"type": "boolean",
"description": "When incremental mode is on, drop properties that were withdrawn and listed again under a new ID. Every record is flagged either way, so leave this off to see them.",
"default": false
},
"telegramToken": {
"title": "๐ Telegram Bot Token",
"type": "string",
"description": "Telegram bot token (from @BotFather). Required for Telegram notifications."
},
"telegramChatId": {
"title": "๐ฌ Telegram Chat ID",
"type": "string",
"description": "Telegram chat or channel ID (e.g. \"-100123456789\"). Required when telegramToken is set."
},
"discordWebhookUrl": {
"title": "๐ฎ Discord Webhook URL",
"type": "string",
"description": "Discord incoming webhook URL. Server Settings โ Integrations โ Webhooks โ New Webhook."
},
"slackWebhookUrl": {
"title": "๐ผ Slack Webhook URL",
"type": "string",
"description": "Slack incoming webhook URL. api.slack.com/messaging/webhooks."
},
"notificationLimit": {
"title": "๐ Max listings per notification",
"minimum": 1,
"maximum": 20,
"type": "integer",
"description": "Maximum number of listings included in each notification message (1โ20).",
"default": 5
},
"notifyOnlyChanges": {
"title": "๐ Notify only new/updated",
"type": "boolean",
"description": "When incremental mode is on, only send notifications for NEW and UPDATED listings. Has no effect otherwise.",
"default": false
},
"whatsappAccessToken": {
"title": "๐ฑ WhatsApp Access Token",
"type": "string",
"description": "WhatsApp Cloud API permanent access token (System User token from Meta Business). Recipient must have messaged the business number within the last 24h (service-conversation window โ free since Nov 2024)."
},
"whatsappPhoneNumberId": {
"title": "๐ WhatsApp Phone Number ID",
"type": "string",
"description": "Your WhatsApp Business phone-number ID (numeric, from Meta dashboard). Required when whatsappAccessToken is set."
},
"whatsappTo": {
"title": "๐ฒ WhatsApp Recipient",
"type": "string",
"description": "Recipient phone in E.164 format without + (e.g. \"6421234567\"). Recipient must have messaged your business number within last 24h."
},
"webhookUrl": {
"title": "๐ช Generic Webhook URL",
"type": "string",
"description": "Receives a JSON POST with {metadata, items} after each run. Universal escape hatch for n8n / Make / Zapier / custom backends."
},
"webhookHeaders": {
"title": "๐ Webhook Headers",
"type": "object",
"description": "Optional JSON object of custom headers (e.g. {\"Authorization\":\"Bearer ...\"})."
},
"appConnector": {
"title": "Send results to a connected app",
"type": "string",
"description": "Optional. Pick a connected app under Settings โ API & Integrations to receive your results (including any contact details). Best-effort across MCP connectors as Apify expands its catalog."
},
"mcpIssueTeam": {
"title": "Issue tracker team",
"type": "string",
"description": "Only when the connected app is an issue tracker: the team (name or ID) the summary issue is created under, if that app requires one."
}
}
},
"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
}
}
}
}
}
}
}
}
}
}
```