{ "openapi": "3.0.1", "info": { "title": "RealEstate[com.au & co.nz] 💰$1💰 Search By URLs and Keywords", "description": "realestate.com.au listings from official services APIs. Input: buy/rent/sold list URLs or direct property pages. Output: one row per listing with flat columns (title, price, agents, images, address) plus full listing and withIdsResponse; includes originalSearchUrl and apiRequestUrl.", "version": "0.0", "x-build-id": "9SlOvx8Alm66Ckear" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/memo23~realestate-au-listings/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-memo23-realestate-au-listings", "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/memo23~realestate-au-listings/runs": { "post": { "operationId": "runs-sync-memo23-realestate-au-listings", "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/memo23~realestate-au-listings/run-sync": { "post": { "operationId": "run-sync-memo23-realestate-au-listings", "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": "Start URLs", "type": "array", "description": "Scrape by URLs of realestate search or property pages. All options in the **Search by filters** section will be ignored when at least one URL is provided here (or in **`extraStartUrls`** / **`ttt`**). Instead of using structured filters, you can configure the search directly on the website, copy the final filtered URL from your browser, and paste it here. **Australia:** buy/rent/sold list pages or property URLs on `https://www.realestate.com.au/` (`/find-agent/...` and `/agent/...` are skipped). **New Zealand:** residential/rural/commercial search or listing URLs on `https://www.realestate.co.nz/`. For each NZ listing the actor calls **`GET …/search/v1/listings/{id}`** and **`GET …/listings/{id}/listing-fibre`**. Env `REALESTATE_MAX_SEARCH_PAGES` (default 500) caps search pages per chain.", "items": { "type": "string" } }, "searchByFilters": { "title": "Search by filters", "required": [ "country", "channel" ], "type": "object", "description": "Instead of scraping by URLs, search for listings using one shared location filter. If you use filters, leave the **Start URLs** section empty. The actor compiles this form into one website search URL and then scrapes that result page. **AU:** `cityOrRegion` is usually the state / region (for example `VIC`) and `district` is the market / city label (for example `Melbourne - Northern Region`). **NZ:** `cityOrRegion` = region, `district` = district / city, and `suburb` = suburb (all three are required). **NZ `sold`** is not supported and will be skipped.", "properties": { "country": { "title": "Country", "description": "Target site: **AU** builds URLs on `realestate.com.au`; **NZ** builds URLs on `realestate.co.nz`.", "type": "string", "enum": [ "AU", "NZ" ], "enumTitles": [ "Australia", "New Zealand" ], "editor": "select" }, "channel": { "title": "Channel", "description": "**Buy** or **rent** (and **sold** for AU only). NZ **sold** is skipped.", "type": "string", "enum": [ "buy", "rent", "sold" ], "enumTitles": [ "Buy", "Rent", "Sold" ], "editor": "select" }, "cityOrRegion": { "title": "City or region", "type": "string", "description": "Shared location field. AU: often state / region (for example `VIC`, `NSW`). NZ: region (for example `Auckland`, `Bay of Plenty`).", "editor": "textfield" }, "district": { "title": "District", "type": "string", "description": "AU: market / city label (for example `Melbourne - Northern Region`). NZ: district / city (for example `Auckland City`, `Manukau City`).", "editor": "textfield" }, "suburb": { "title": "Suburb", "type": "string", "description": "Optional for AU, recommended for NZ.", "editor": "textfield" } } }, "flattenOutput": { "title": "Flattened output", "type": "boolean", "description": "When enabled (default): **Australia** — flat columns, full `listing`, and `withIdsResponse`. **New Zealand** — flat fibre fields (`hasOnt`, `currentConnection`, `fibreProducts`, …) plus full `rawResponse`. When disabled, NZ items use `attributes` + `rawResponse` only (no wide flat fields).", "default": true }, "maxItems": { "title": "Results limit", "type": "integer", "description": "Maximum listings **per listing-search URL**. Direct property URLs always fetch one listing. Total rows can be up to `(listing search URLs × maxItems) + (property URLs)`.", "default": 10000 }, "maxConcurrency": { "title": "Max concurrency", "type": "integer", "description": "Maximum concurrent requests.", "default": 100 }, "minConcurrency": { "title": "Min concurrency", "type": "integer", "description": "Minimum concurrent requests.", "default": 1 }, "maxRequestRetries": { "title": "Max request retries", "type": "integer", "description": "Retries per failed request (includes HTTP 429 / 502 / 503 and 5xx from REA). Optional env REALESTATE_RETRY_BACKOFF_MS (default 2500) sets the base delay; waits grow exponentially between attempts.", "default": 100 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings for the crawler.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }