{ "openapi": "3.0.1", "info": { "title": "Real Estate AU NZ Search by URLs and Keywords", "description": "Search public Australian and New Zealand real-estate listings by saved URL or place keyword. Returns structured listing data from realestate.com.au and realestate.co.nz for market research, lead workflows, property monitoring, and AI-agent use.", "version": "1.0", "x-build-id": "ZxGvOaJpn9yTSC2j7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/muhammadafzal~realestate-au-nz-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-muhammadafzal-realestate-au-nz-search", "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/muhammadafzal~realestate-au-nz-search/runs": { "post": { "operationId": "runs-sync-muhammadafzal-realestate-au-nz-search", "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/muhammadafzal~realestate-au-nz-search/run-sync": { "post": { "operationId": "run-sync-muhammadafzal-realestate-au-nz-search", "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 or listing URLs", "type": "array", "description": "Use this when you already have a realestate.com.au or realestate.co.nz search/listing URL. Example: https://www.realestate.com.au/buy/in-sydney/list-1. URLs are scraped as public pages; use searchQueries for keyword discovery.", "items": { "type": "object", "properties": { "url": { "title": "URL", "description": "A public realestate.com.au or realestate.co.nz search or listing URL.", "type": "string" } }, "required": [ "url" ] } }, "searchQueries": { "title": "Keyword searches", "type": "array", "description": "Use this when you want the Actor to build a public property search URL from a place or suburb keyword. Example: Sydney NSW or Auckland. These are not arbitrary Google queries; they target residential listing searches.", "default": [], "items": { "type": "string" } }, "country": { "title": "Country", "enum": [ "au", "nz" ], "type": "string", "description": "Use this to choose the keyword-search website. Use au for realestate.com.au or nz for realestate.co.nz. Defaults to au; explicit URLs are detected by domain.", "default": "au" }, "listingType": { "title": "Listing type", "enum": [ "sale", "rent", "sold" ], "type": "string", "description": "Use this to select the intent for keyword-generated URLs. sale returns properties for sale; rent returns rental searches; sold is accepted where the website supports it.", "default": "sale" }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Use this to cap billable dataset rows across all sources. Must be 1–1000; defaults to 25. This is not a page count.", "default": 25 }, "maxPagesPerSource": { "title": "Pages per source", "minimum": 1, "maximum": 50, "type": "integer", "description": "Use this to control pagination for each search URL. Defaults to 3 and is capped at 50. Detail URLs do not paginate.", "default": 3 }, "responseFormat": { "title": "Response format", "enum": [ "concise", "detailed" ], "type": "string", "description": "Use concise for smaller agent-friendly rows or detailed for longer descriptions and more images. Defaults to detailed.", "default": "detailed" } } }, "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 } } } } } } } } } }