{ "openapi": "3.0.1", "info": { "title": "Homes.co.nz Scraper | Fast & Reliable | $2.5 / 1k", "description": "Extract structured homes.co.nz property listings with prices, full descriptions, all images, detailed property attributes, agency details and contact numbers,. Built for enterprise-grade New Zealand real estate intelligence, listing monitoring, and automated analytics pipelines.", "version": "1.0", "x-build-id": "NQry9e3GyZbA6mhGp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fatihtahta~homes-co-nz-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fatihtahta-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/fatihtahta~homes-co-nz-scraper/runs": { "post": { "operationId": "runs-sync-fatihtahta-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/fatihtahta~homes-co-nz-scraper/run-sync": { "post": { "operationId": "run-sync-fatihtahta-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": [ "location" ], "properties": { "deal_type": { "title": "Choose Which Deals to Collect", "enum": [ "all_homes", "for_sale", "sold", "for_rent", "not_listed" ], "type": "string", "description": "Choose whether to collect all homes, homes for sale, recently sold homes, rentals, or homes that are not currently listed. The default keeps the search broad.", "default": "all_homes" }, "location": { "title": "Choose Search Location (suburb, town, city, region, or area name)", "type": "string", "description": "Enter a suburb, town, city, region, or area name. This field is required." }, "min_price": { "title": "Set a Minimum Price", "minimum": 0, "type": "integer", "description": "Enter the lowest price you want included in the results. For rental searches, this value represents weekly rent." }, "max_price": { "title": "Set a Maximum Price", "minimum": 0, "type": "integer", "description": "Enter the highest price you want included in the results. For rental searches, this value represents weekly rent." }, "min_bedroom": { "title": "Set Minimum Bedrooms", "enum": [ "1", "2", "3", "4", "5+" ], "type": "string", "description": "Choose the fewest bedrooms a property should have. This helps exclude smaller homes from the dataset." }, "max_bedroom": { "title": "Set Maximum Bedrooms", "enum": [ "1", "2", "3", "4", "5+" ], "type": "string", "description": "Choose the most bedrooms a property should have. This helps keep the dataset focused on smaller or mid-sized homes." }, "min_bathroom": { "title": "Set Minimum Bathrooms", "enum": [ "1", "2", "3", "4", "5+" ], "type": "string", "description": "Choose the fewest bathrooms a property should have. This is useful when collecting homes that meet a minimum comfort or capacity requirement." }, "max_bathroom": { "title": "Set Maximum Bathrooms", "enum": [ "1", "2", "3", "4", "5+" ], "type": "string", "description": "Choose the most bathrooms a property should have. This helps remove larger properties that are outside your target profile." }, "limit": { "title": "Set a Maximum Result Count", "minimum": 1, "type": "integer", "description": "Enter the maximum number of listings to save for each URL or location. Leave it empty to collect as many matching results as the actor can reach." }, "sold_within_months": { "title": "Limit Recently Sold Results", "enum": [ "1_month", "2_month", "3_month", "4_month", "5_month", "6_month", "7_month", "8_month", "9_month", "10_month", "11_month", "12_month" ], "type": "string", "description": "When collecting sold properties, choose how far back the sale history should go. This setting is ignored for deal types other than Sold.", "default": "12_month" } } }, "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 } } } } } } } } } }