{ "openapi": "3.0.1", "info": { "title": "Realestate.co.nz Scraper", "description": "[💰 $1.0 / 1K] Extract property listings from Realestate.co.nz, New Zealand's national real-estate portal. Search by URL or by region, category, property type, price and bedrooms. Get prices, areas, locations, photos, open-home times and agent details.", "version": "1.0", "x-build-id": "bPu2wbxbEqq9EEDFp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/solidcode~realestate-co-nz-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-solidcode-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/solidcode~realestate-co-nz-scraper/runs": { "post": { "operationId": "runs-sync-solidcode-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/solidcode~realestate-co-nz-scraper/run-sync": { "post": { "operationId": "run-sync-solidcode-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": { "startUrls": { "title": "Search URLs", "maxItems": 50, "type": "array", "description": "Paste one or more Realestate.co.nz search, category, or individual listing URLs (for example https://www.realestate.co.nz/residential/sale/auckland). This is the fastest way to get exactly the results you see on the site. When you provide URLs here, the guided 'Build a Search' fields below are ignored.", "items": { "type": "string" } }, "searchType": { "title": "Listing Category", "enum": [ "residential-sale", "residential-rent", "new-homes", "lifestyle", "rural", "commercial-sale", "commercial-lease", "business" ], "type": "string", "description": "Which kind of listings to search. Used only when no Search URLs are provided.", "default": "residential-sale" }, "region": { "title": "Region", "type": "string", "description": "New Zealand region or area to search — for example 'Auckland', 'Wellington', 'Canterbury' or 'Otago'. Leave empty to search all of New Zealand." }, "district": { "title": "District", "type": "string", "description": "Optional: a district within the selected region (for example 'Auckland City' or 'North Shore'). Leave empty to include the whole region." }, "suburb": { "title": "Suburb", "type": "string", "description": "Optional: a suburb within the selected district (for example 'Ponsonby'). Leave empty to include the whole district." }, "propertyType": { "title": "Property Type", "uniqueItems": true, "type": "array", "description": "Only include these property types. Select several to combine. Leave empty for all types. Used only with the guided 'Build a Search' fields.", "items": { "type": "string", "enum": [ "house", "apartment", "townhouse", "unit", "studio", "section", "lifestyle", "lifestyle-section", "home-income", "carpark" ], "enumTitles": [ "House", "Apartment", "Townhouse", "Unit", "Studio", "Section (land)", "Lifestyle property", "Lifestyle section", "Home & Income", "Carpark" ] }, "default": [] }, "priceMin": { "title": "Minimum Price (NZD)", "minimum": 0, "type": "integer", "description": "Only include listings at or above this price in New Zealand dollars — total price when buying, weekly rent when renting. Leave empty for no minimum. Note: Commercial for Lease listings are priced on application, so price filters don't apply to that category." }, "priceMax": { "title": "Maximum Price (NZD)", "minimum": 0, "type": "integer", "description": "Only include listings at or below this price in New Zealand dollars. Leave empty for no maximum. Note: Commercial for Lease listings are priced on application, so price filters don't apply to that category." }, "bedroomsMin": { "title": "Minimum Bedrooms", "minimum": 0, "type": "integer", "description": "Only include listings with at least this many bedrooms. Leave empty for any number." }, "bedroomsMax": { "title": "Maximum Bedrooms", "minimum": 0, "type": "integer", "description": "Only include listings with at most this many bedrooms. Leave empty for any number." }, "maxResults": { "title": "Max Results", "minimum": 0, "type": "integer", "description": "Maximum number of listings to collect per search or URL. Use 50-100 for a quick scan or a higher number for deep research. Results are collected in full pages, so the final page may overshoot this number by a few rows — rows are never trimmed mid-page. Set to 0 for no cap (an internal safety limit of 50,000 is then applied).", "default": 100 } } }, "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 } } } } } } } } } }