# Harcourts Property Scraper — buy, rent, sold & leased (`blackfalcondata/harcourts-scraper`) Actor Scrape harcourts.net property listings across Australia, New Zealand and Fiji — price, bedrooms, address and GPS coordinates as structured JSON. Includes open-home inspection times, auction dates and agent email and phone. - **URL**: https://apify.com/blackfalcondata/harcourts-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 $1.50 / 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/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 Harcourts Property Scraper do? Harcourts Property Scraper extracts structured property listings from [harcourts.net](https://harcourts.net) across Australia (`au`), New Zealand (`nz`) and Fiji (`fj`) — for sale, for rent, sold and leased. Every listing includes the address with GPS coordinates, price, bedrooms, bathrooms, car spaces, land size (normalised to m²), photo gallery, floorplan and video-tour links, open-home inspection times, auction dates and the listing agent's email and phone. It supports filtering by keyword, suburb or region (with optional surrounding suburbs), property type, price band, bedrooms, bathrooms, car spaces, land size and floor area, so you can run the same query consistently over time. **New to Apify?** [Sign up free](https://console.apify.com/sign-up?fpr=1h3gvi&fp_sid=ctaplain) and use the included $5 monthly platform credit to test this actor. ### Key features - **🌏 Three-market coverage** — one actor covers all 3 Harcourts markets: `au`, `nz`, `fj`. - **📅 Inspection & auction times** — open-home slots and auction datetimes as structured fields, not free text. - **📧 Agent contact details** — optional per-listing agent email, phone and bio via the agent's profile page. ### What data can you extract from harcourts.net? Each result includes Core property fields (`listingId`, `listingKey`, `title`, `subtitle`, `entityName`, `category`, `location`, and `priceText`, and more), detail fields when enrichment is enabled (`description`, `descriptionText`, `descriptionHtml`, `descriptionMarkdown`, and `descriptionLength`), and contact information (`agentPhone`, `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. Enable detail enrichment in the input to get richer fields such as full descriptions and contact information where the source provides them. ### Input The main inputs are a search keyword, an optional location filter, and a result limit. Additional filters and options are available in the input schema. Key parameters: - **`query`** — Free-text keywords matched against listing content (e.g. "pool", "renovated"). Use a JSON array for multi-query. Leave empty to browse everything in the category. - **`country`** — Which Harcourts market to search. (default: `"AU"`) - **`location`** — Suburb, district or region name (e.g. "South Perth", "Perth - Perth Metro"). Matched against Harcourts' own location list. Use a JSON array for multi-location. - **`listingCategory`** — Which set of listings to search. (default: `"buy"`) - **`propertyType`** — Restrict to one property type. (default: `""`) - **`includeSurroundingSuburbs`** — Widen a suburb search to neighbouring suburbs. (default: `false`) - **`minPrice`** — Minimum price in local currency. - **`maxPrice`** — Maximum price in local currency. - **`minBedrooms`** — Minimum number of bedrooms. - **`maxBedrooms`** — Maximum number of bedrooms. - **`minBathrooms`** — Minimum number of bathrooms. - **`maxBathrooms`** — Maximum number of bathrooms. - ...and 32 more parameters ### Input examples **Basic search** — Keyword-driven search scoped to a city with a tight radius. → Full payload per result — all standard fields populated where the source provides them. ```json { "query": "pool", "location": "South Perth", "maxResults": 50 } ```` **Incremental tracking** — Only emit properties that changed since the previous run with this `stateKey`. → First run builds the baseline state. Subsequent runs emit only records that are new or whose tracked content changed. Set `emitUnchanged: true` to include unchanged records as well. ```json { "query": "pool", "maxResults": 200, "incrementalMode": true, "stateKey": "pool-tracker" } ``` **Compact output for AI agents** — Return only core fields for AI-agent and MCP workflows. → Small payload with the most important fields — ideal for piping into LLMs without token overhead. ```json { "query": "pool", "maxResults": 50, "compact": true } ``` ### Output Each run produces a dataset of structured property records. Results can be downloaded as JSON, CSV, or Excel from the Dataset tab in Apify Console. ### Example property record ```json { "listingId": "0325e4387e7443f4c1424cb2b8a2aecb13de5752c946353eed251dc3f97614eb", "listingKey": "l22735501", "title": "35/150 Mill Point Road, SOUTH PERTH, WA 6151", "subtitle": "Fully Renovated Riverside Living with Stunning City Views", "entityName": "Ben Noakes", "category": "sale", "location": "35/150 Mill Point Road, SOUTH PERTH, WA 6151", "description": "Perfectly positioned just moments from the vibrant Mends Street precinct and with direct access to the picturesque South Perth foreshore, this beautifully renovated apartment presents an outstanding o...", "descriptionText": "Perfectly positioned just moments from the vibrant Mends Street precinct and with direct access to the picturesque South Perth foreshore, this beautifully renovated apartment presents an outstanding o...", "descriptionHtml": "\n

\n Perfectly positioned just moments from the vibrant Mends Street precinct and with direct access to the picturesque South Perth foreshore, this beautifully r...", "descriptionMarkdown": "Perfectly positioned just moments from the vibrant Mends Street precinct and with direct access to the picturesque South Perth foreshore, this beautifully renovated apartment presents an outstanding o...", "descriptionLength": 3913, "priceText": "Under Offer by Ben Noakes", "listingType": "sale", "publishedAt": "2026-07-14", "canonicalUrl": "https://harcourts.net/au/office/empire/listing/l22735501-35-150-mill-point-road-south-perth-wa-6151", "sourceUrl": "https://harcourts.net/au/office/empire/listing/l22735501-35-150-mill-point-road-south-perth-wa-6151", "sourceCountry": "AU", "sourceDomain": "harcourts.net", "searchUrl": "https://harcourts.net/au/listings/buy?location=5934&include-suburb=1", "isSponsored": false, "fetchedAt": "2026-07-17T13:29:28.904Z", "scrapedAt": "2026-07-17T13:29:28.904Z", "detailFetched": true, "contentQuality": "full", "imageUrl": "https://listings-photos.cloudhi.io/properties/594679/7b77ae9e-d7be-4a70-b734-29b8816828ba.jpg", "galleryUrls": [ "https://listings-photos.cloudhi.io/properties/594679/7b77ae9e-d7be-4a70-b734-29b8816828ba.jpg", "https://listings-photos.cloudhi.io/properties/594679/6f3b3283-ec15-435a-83b4-232145f04340.jpg", "https://listings-photos.cloudhi.io/properties/594679/187fd62c-9a34-4995-b8b8-ae9f31d472fb.jpg", "https://listings-photos.cloudhi.io/properties/594679/e8d847e2-9cec-486c-be86-1e3b34ff2829.jpg", "https://listings-photos.cloudhi.io/properties/594679/a2c56415-fc92-4794-b7af-832fa219d306.jpg", "... 27 more items" ], "floorplanUrl": "https://propertyphotos.vaultre.com.au/4713/209509529__1784002877-83418-WEB35150MillPointRoadSouthPerth.jpg", "videoTourUrl": "https://youtube.com/embed/cDWsqETsWGU", "propertyId": "61dbfaf2-291e-46e9-a5e8-7a73f5d78052", "streetAddress": "35/150 Mill Point Road", "suburb": "SOUTH PERTH", "state": "WA", "postcode": "6151", "latitude": -31.9745342, "longitude": 115.8561174, "propertyType": "Apartment", "bedrooms": 2, "bathrooms": 1, "carports": 1, "openSpaces": 0, "floorAreaSqm": 62, "status": "current", "inspectionTimes": [ { "startDate": "2026-07-18T12:00", "endDate": "2026-07-18T12:45" }, { "startDate": "2026-07-19T12:00", "endDate": "2026-07-19T12:45" } ], "listedDate": "2026-07-14", "agentName": "Ben Noakes", "agentUrl": "https://harcourts.net/au/office/empire/people/ben-noakes", "agentPhone": "0406724614", "agentId": "f0ababc7-4bdb-4559-b7de-6a927d480afc", "officeName": "Harcourts Empire", "officeSlug": "empire", "officeUrl": "https://harcourts.net/au/office/empire", "officeListingUrl": "https://harcourts.net/au/office/empire/listing/l22735501-35-150-mill-point-road-south-perth-wa-6151", "agentDescription": "Meet Ben Noakes, your trusted real estate agent in Wembley Downs and part of the Harcourts Empire team. Specialising in buying and selling residential property.", "contactEmail": "ben@harcourtsempire.com.au", "contactPhone": "0406724614" } ``` ### 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. - `firstSeenAt`, `lastSeenAt` — ISO-8601 timestamps tracking the listing across runs. - `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 harcourts.net 1. Go to [Harcourts Property Scraper](https://apify.com/blackfalcondata/harcourts-scraper?fpr=1h3gvi) in Apify Console. 2. Enter a search keyword and optional location filter. 3. Set `maxResults` to control how many results you need. 4. Enable `includeDetails` if you need full descriptions, contact info. 5. Click **Start** and wait for the run to finish. 6. Export the dataset as JSON, CSV, or Excel. ### Use cases - Extract property data from harcourts.net for market research and competitive analysis. - Track pricing trends across regions and categories over time. - Monitor new and changed properties 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 harcourts.net? Harcourts Property 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 result:** $0.0015 per property record Example costs: - 10 results: **$0.02** - 25 results: **$0.042** - 100 results: **$0.15** - 200 results: **$0.3** - 500 results: **$0.76** #### Example: recurring monitoring savings These examples compare full re-scrapes with incremental runs at different churn rates. Churn is the share of properties 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. | Churn rate | Full re-scrape run cost | Incremental run cost | Savings vs full re-scrape | Monthly cost after baseline | |---|---:|---:|---:|---:| | 5% — stable niche query | $0.15 | $0.01 | $0.14 (92%) | $0.38 | | 15% — moderate broad query | $0.15 | $0.03 | $0.13 (82%) | $0.82 | | 30% — high-volume aggregator | $0.15 | $0.05 | $0.11 (68%) | $1.50 | Full re-scrape monthly cost at daily polling: $4.65. First month with incremental costs $0.52 / $0.95 / $1.60 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 harcourts.net? The number of results depends on the search query and available properties on harcourts.net. Use the `maxResults` parameter to control how many results are returned per run. #### Does Harcourts Property Scraper support recurring monitoring? Yes. Enable incremental mode to only receive new or changed properties 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 Harcourts Property Scraper with other apps? Yes. Harcourts Property 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 Harcourts Property 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 Harcourts Property 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 harcourts.net? This actor extracts publicly available data from harcourts.net. 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/harcourts-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, rent and sold in every Texas. - [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. - [Realestate.co.nz Scraper — NZ Property Listings & Valuations](https://apify.com/blackfalcondata/realestate-co-nz-scraper?fpr=1h3gvi) — Scrape realestate.co.nz — New Zealand's property portal. Get the council valuation and sales. ### Getting started with Apify New to Apify? [Create a free account with $5 credit](https://console.apify.com/sign-up?fpr=1h3gvi\&fp_sid=ctaplain) — 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 ## `query` (type: `string`): Free-text keywords matched against listing content (e.g. "pool", "renovated"). Use a JSON array for multi-query. Leave empty to browse everything in the category. ## `country` (type: `string`): Which Harcourts market to search. ## `location` (type: `string`): Suburb, district or region name (e.g. "South Perth", "Perth - Perth Metro"). Matched against Harcourts' own location list. Use a JSON array for multi-location. ## `listingCategory` (type: `string`): Which set of listings to search. ## `propertyType` (type: `string`): Restrict to one property type. ## `includeSurroundingSuburbs` (type: `boolean`): Widen a suburb search to neighbouring suburbs. ## `minPrice` (type: `integer`): Minimum price in local currency. ## `maxPrice` (type: `integer`): Maximum price in local currency. ## `minBedrooms` (type: `integer`): Minimum number of bedrooms. ## `maxBedrooms` (type: `integer`): Maximum number of bedrooms. ## `minBathrooms` (type: `integer`): Minimum number of bathrooms. ## `maxBathrooms` (type: `integer`): Maximum number of bathrooms. ## `minCarspaces` (type: `integer`): Minimum number of car spaces. ## `minLand` (type: `integer`): Minimum land size in square metres. ## `maxLand` (type: `integer`): Maximum land size in square metres. ## `minFloor` (type: `integer`): Minimum floor area in square metres. ## `maxFloor` (type: `integer`): Maximum floor area in square metres. ## `startUrls` (type: `array`): Direct harcourts.net search or listing URLs. ## `maxResults` (type: `integer`): Maximum total listings to return (0 = unlimited). ## `maxPages` (type: `integer`): Maximum result pages to scrape per search. ## `includeDetails` (type: `boolean`): Fetch each listing detail page for full description and structured metadata. ## `includeRelatedEntity` (type: `boolean`): Fetch each listing agent's profile page to add their email address and bio. Adds one request per distinct agent (results are cached, so agents shared across listings are fetched once). ## `descriptionMaxLength` (type: `integer`): Truncate description to this many characters. 0 = no truncation. ## `compact` (type: `boolean`): Output only core fields (for AI-agent/MCP workflows). ## `incrementalMode` (type: `boolean`): Compare against the previous run and label each listing as new, updated or unchanged. State is kept separately for each distinct set of search inputs, so a narrow search never interferes with a broader one. ## `stateKey` (type: `string`): Optional. Stable name for the set of listings you are tracking (e.g. "perth-3bed"). Leave empty to derive one automatically from your search inputs. ## `emitUnchanged` (type: `boolean`): When incremental, also emit records that haven't changed. ## `emitExpired` (type: `boolean`): When incremental, also emit records no longer found. ## `skipReposts` (type: `boolean`): When incremental, skip listings whose content matches an expired listing from a prior run (cross-run duplicate detection). ## `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 outside incremental mode. ## `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. "436641234567"). 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 ..."}). ## `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. ## `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 { "query": "pool", "country": "AU", "location": "South Perth", "listingCategory": "buy", "propertyType": "", "includeSurroundingSuburbs": false, "maxResults": 5, "maxPages": 5, "includeDetails": true, "includeRelatedEntity": false, "descriptionMaxLength": 0, "compact": false, "incrementalMode": false, "emitUnchanged": false, "emitExpired": false, "skipReposts": false, "notificationLimit": 5, "notifyOnlyChanges": false, "descriptionFormat": "all", "excludeEmptyFields": 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 = { "query": "pool", "location": "South Perth", "maxResults": 5, "descriptionFormat": "all", "excludeEmptyFields": false }; // Run the Actor and wait for it to finish const run = await client.actor("blackfalcondata/harcourts-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 = { "query": "pool", "location": "South Perth", "maxResults": 5, "descriptionFormat": "all", "excludeEmptyFields": False, } # Run the Actor and wait for it to finish run = client.actor("blackfalcondata/harcourts-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 '{ "query": "pool", "location": "South Perth", "maxResults": 5, "descriptionFormat": "all", "excludeEmptyFields": false }' | apify call blackfalcondata/harcourts-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=blackfalcondata/harcourts-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Harcourts Property Scraper — buy, rent, sold & leased", "description": "Scrape harcourts.net property listings across Australia, New Zealand and Fiji — price, bedrooms, address and GPS coordinates as structured JSON. Includes open-home inspection times, auction dates and agent email and phone.", "version": "0.1", "x-build-id": "tCOgOroEIGTbySbbp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/blackfalcondata~harcourts-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-blackfalcondata-harcourts-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~harcourts-scraper/runs": { "post": { "operationId": "runs-sync-blackfalcondata-harcourts-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~harcourts-scraper/run-sync": { "post": { "operationId": "run-sync-blackfalcondata-harcourts-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": { "query": { "title": "🔍 Keywords", "type": "string", "description": "Free-text keywords matched against listing content (e.g. \"pool\", \"renovated\"). Use a JSON array for multi-query. Leave empty to browse everything in the category." }, "country": { "title": "🌍 Country", "enum": [ "AU", "NZ", "FJ" ], "type": "string", "description": "Which Harcourts market to search.", "default": "AU" }, "location": { "title": "📍 Location", "type": "string", "description": "Suburb, district or region name (e.g. \"South Perth\", \"Perth - Perth Metro\"). Matched against Harcourts' own location list. Use a JSON array for multi-location." }, "listingCategory": { "title": "🏷️ Listing Category", "enum": [ "buy", "rent", "sold", "leased" ], "type": "string", "description": "Which set of listings to search.", "default": "buy" }, "propertyType": { "title": "🏠 Property Type", "enum": [ "", "house", "unit", "townhouse", "apartment", "land", "villa", "acreage", "rural", "commercial" ], "type": "string", "description": "Restrict to one property type.", "default": "" }, "includeSurroundingSuburbs": { "title": "🗺️ Include Surrounding Suburbs", "type": "boolean", "description": "Widen a suburb search to neighbouring suburbs.", "default": false }, "minPrice": { "title": "💰 Min Price", "minimum": 0, "type": "integer", "description": "Minimum price in local currency." }, "maxPrice": { "title": "💰 Max Price", "minimum": 0, "type": "integer", "description": "Maximum price in local currency." }, "minBedrooms": { "title": "🛏️ Min Bedrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bedrooms." }, "maxBedrooms": { "title": "🛏️ Max Bedrooms", "minimum": 0, "type": "integer", "description": "Maximum number of bedrooms." }, "minBathrooms": { "title": "🛁 Min Bathrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bathrooms." }, "maxBathrooms": { "title": "🛁 Max Bathrooms", "minimum": 0, "type": "integer", "description": "Maximum number of bathrooms." }, "minCarspaces": { "title": "🚗 Min Car Spaces", "minimum": 0, "type": "integer", "description": "Minimum number of car spaces." }, "minLand": { "title": "📐 Min Land Size (m²)", "minimum": 0, "type": "integer", "description": "Minimum land size in square metres." }, "maxLand": { "title": "📐 Max Land Size (m²)", "minimum": 0, "type": "integer", "description": "Maximum land size in square metres." }, "minFloor": { "title": "📏 Min Floor Area (m²)", "minimum": 0, "type": "integer", "description": "Minimum floor area in square metres." }, "maxFloor": { "title": "📏 Max Floor Area (m²)", "minimum": 0, "type": "integer", "description": "Maximum floor area in square metres." }, "startUrls": { "title": "🔗 Start URLs", "type": "array", "description": "Direct harcourts.net search or listing URLs.", "items": { "type": "string" } }, "maxResults": { "title": "💯 Max Results", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum total listings to return (0 = unlimited).", "default": 25 }, "maxPages": { "title": "📄 Max Pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum result pages to scrape per search.", "default": 5 }, "includeDetails": { "title": "📋 Include Full Details", "type": "boolean", "description": "Fetch each listing detail page for full description and structured metadata.", "default": true }, "includeRelatedEntity": { "title": "📧 Include Agent Contact Details", "type": "boolean", "description": "Fetch each listing agent's profile page to add their email address and bio. Adds one request per distinct agent (results are cached, so agents shared across listings are fetched once).", "default": false }, "descriptionMaxLength": { "title": "✂️ Description Max Length", "minimum": 0, "type": "integer", "description": "Truncate description to this many characters. 0 = no truncation.", "default": 0 }, "compact": { "title": "📦 Compact Output", "type": "boolean", "description": "Output only core fields (for AI-agent/MCP workflows).", "default": false }, "incrementalMode": { "title": "♻️ Incremental Mode", "type": "boolean", "description": "Compare against the previous run and label each listing as new, updated or unchanged. State is kept separately for each distinct set of search inputs, so a narrow search never interferes with a broader one.", "default": false }, "stateKey": { "title": "🔑 State Key", "type": "string", "description": "Optional. Stable name for the set of listings you are tracking (e.g. \"perth-3bed\"). Leave empty to derive one automatically from your search inputs." }, "emitUnchanged": { "title": "♻️ Emit Unchanged Records", "type": "boolean", "description": "When incremental, also emit records that haven't changed.", "default": false }, "emitExpired": { "title": "⚰️ Emit Expired Records", "type": "boolean", "description": "When incremental, also emit records no longer found.", "default": false }, "skipReposts": { "title": "🚫 Skip Reposts", "type": "boolean", "description": "When incremental, skip listings whose content matches an expired listing from a prior run (cross-run duplicate detection).", "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 outside incremental mode.", "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. \"436641234567\"). 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 ...\"})." }, "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 }, "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 } } } } } } } } } } ```