{ "openapi": "3.0.1", "info": { "title": "Homes.co.nz $1💰 URL | Search | Property Scraper", "description": "From $1/1K. Scrape Homes.co.nz listings via search or URL. Supports multiple locations or links per run with forward pagination. Extract enriched data, including property details, agents, branch info, valuations, media, open homes, and filters for status, price, beds, and baths.", "version": "1.0", "x-build-id": "55VOf0uJHVm4BgMqZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abotapi~homes-co-nz-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abotapi-homes-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/abotapi~homes-co-nz-scraper/runs": { "post": { "operationId": "runs-sync-abotapi-homes-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/abotapi~homes-co-nz-scraper/run-sync": { "post": { "operationId": "run-sync-abotapi-homes-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", "required": [ "mode" ], "properties": { "mode": { "title": "Collection Mode", "enum": [ "search", "url" ], "type": "string", "description": "Search mode resolves location names and expands them into listing results. URL mode accepts Homes detail URLs or map URLs directly.", "default": "search" }, "locations": { "title": "Locations", "type": "array", "description": "One or more location names to resolve through Homes and collect listings from.", "items": { "type": "string" } }, "listingStatus": { "title": "Listing Status", "enum": [ "for_sale", "for_rent", "just_sold", "off_market" ], "type": "string", "description": "Choose which Homes listing bucket to collect.", "default": "for_sale" }, "minBedrooms": { "title": "Min Bedrooms", "minimum": 0, "type": "integer", "description": "Only include listings with at least this many bedrooms when the structured feed exposes that filter." }, "minBathrooms": { "title": "Min Bathrooms", "minimum": 0, "type": "integer", "description": "Only include listings with at least this many bathrooms when the structured feed exposes that filter." }, "minPrice": { "title": "Min Price (NZD)", "minimum": 0, "type": "integer", "description": "Lower price bound to send to the structured Homes query when supported for the chosen listing status." }, "maxPrice": { "title": "Max Price (NZD)", "minimum": 0, "type": "integer", "description": "Upper price bound to send to the structured Homes query when supported for the chosen listing status." }, "sortBy": { "title": "Sort By", "enum": [ "default", "published_desc", "published_asc", "price_desc", "price_asc" ], "type": "string", "description": "Applies to the output ordering of collected listings. Price sorting only affects records where a numeric price can be derived from the structured listing data.", "default": "default" }, "urls": { "title": "Homes URLs", "type": "array", "description": "One or more homes.co.nz detail URLs or map URLs. Multi-URL supported. Detail URLs return a single enriched listing. Map URLs expand into structured result pages and walk forward — when used this way, the search filters and sort above also apply.", "items": { "type": "string" } }, "maxListings": { "title": "Max Listings (global cap)", "minimum": 0, "type": "integer", "description": "Hard ceiling on listings output across the whole run — pagination stops as soon as this is hit, in both Search and URL modes. Use 0 for no explicit cap.", "default": 20 }, "maxPages": { "title": "Max Pages Per Search", "minimum": 1, "maximum": 3000, "type": "integer", "description": "Maximum output pages to emit for each search target or map URL. Defaults to the cap so pagination only stops at maxListings — lower it to throttle deep walks.", "default": 200 }, "pageSize": { "title": "Listings Per Page", "minimum": 1, "maximum": 100, "type": "integer", "description": "Number of listings to emit on each output page.", "default": 20 }, "fetchPropertyCards": { "title": "Fetch Property Cards (extra cost)", "type": "boolean", "description": "Include extra valuation, title, branch, and agent data when available. Adds one additional request per listing — disable to cut cost when you only need core fields.", "default": true }, "includeRawApiResponses": { "title": "Include Raw Structured Payloads (debug)", "type": "boolean", "description": "Include the raw structured API payloads in each output item for debugging.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy configuration for Homes requests. Apify Proxy is recommended for production runs.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }