{ "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 } } } } } } } } } }