{ "openapi": "3.0.1", "info": { "title": "Realestate.com.au Scraper", "description": "Scrape Realestate.com.au for-sale, rent, and sold listings + full property details. Search by suburb/postcode/coordinates/polygon/URL with filters (price, beds, baths, property type, sort, etc.).", "version": "1.0", "x-build-id": "LAueognXvXSwgeziA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/one-api~realestate-com-au-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-one-api-realestate-com-au-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/one-api~realestate-com-au-scraper/runs": { "post": { "operationId": "runs-sync-one-api-realestate-com-au-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/one-api~realestate-com-au-scraper/run-sync": { "post": { "operationId": "run-sync-one-api-realestate-com-au-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": { "property_inputs": { "title": "Listing ID, Realestate.com.au URL, or full Address (one per line)", "type": "array", "description": "Auto-detects each entry: digits → listingId, http(s) URL → listing URL, anything else → address. Each row = 1 property detail call.", "items": { "type": "string" } }, "search_inputs": { "title": "Suburb, postcode, lat/lng radius, polygon, or Realestate.com.au search URL (one per line)", "type": "array", "description": "Auto-detects each entry. Examples:\n• `Bondi, NSW 2026` (suburb / location)\n• `2026` (4-digit AU postcode)\n• `-33.8915,151.2767,2` (lat,lng,radius_km)\n• `151.27 -33.89,151.29 -33.89,151.29 -33.87,151.27 -33.87` (polygon, lon-lat pairs — converted to bounding box)\n• `https://www.realestate.com.au/buy/in-bondi+nsw+2026/list-1` (search URL)\n\nFilters below apply to every search. Each LISTING is pushed as one dataset item.", "items": { "type": "string" } }, "searchType": { "title": "Search Type", "enum": [ "For_Sale", "For_Rent", "Sold" ], "type": "string", "description": "For_Sale (default) | For_Rent | Sold.", "default": "For_Sale" }, "propertyType": { "title": "Property Types", "type": "string", "description": "Comma-separated. Leave empty for all. Allowed: House, Apartment, Unit, Townhouse, Villa, Land, Acreage, Rural, Block_of_Units, Retirement.", "default": "" }, "priceRange": { "title": "Price Range", "type": "string", "description": "`min:500000`, `max:1500000`, or `min:500000,max:1500000`", "default": "" }, "bedsRange": { "title": "Beds Range", "type": "string", "description": "`min:3`, `max:5`, `min:3,max:5` (studio = `min:0`)", "default": "" }, "bathsRange": { "title": "Baths (min only)", "type": "string", "description": "Server only honours minimum. Use `min:2`. (Max ignored.)", "default": "" }, "carSpacesRange": { "title": "Car Spaces (min only)", "type": "string", "description": "Server only honours minimum. Use `min:1`.", "default": "" }, "landSizeRange": { "title": "Land Size (sqm)", "type": "string", "description": "`min:500`, `max:5000`, `min:500,max:5000`", "default": "" }, "surroundingSuburbs": { "title": "Include Surrounding Suburbs", "type": "boolean", "description": "Default: true. Untick to restrict results to the named suburb only.", "default": true }, "constructionStatus": { "title": "Construction Status", "enum": [ "any", "established", "new" ], "type": "string", "description": "any | established | new", "default": "any" }, "sortOrder": { "title": "Sort Order", "enum": [ "Recommended", "Newest", "Oldest", "Price_Low_to_High", "Price_High_to_Low", "Most_Recently_Sold", "Oldest_Sold" ], "type": "string", "description": "How to sort search results. Default: Recommended (Realestate.com.au's relevance bucket).", "default": "Recommended" }, "pages": { "title": "Pages to fetch per search", "minimum": 1, "maximum": 50, "type": "integer", "description": "1-based. Each page = up to `Result Count` listings.", "default": 1 }, "resultCount": { "title": "Results per page", "minimum": 1, "maximum": 200, "type": "integer", "description": "Min 1, Max 200. Default 30.", "default": 30 }, "excludeUnderContract": { "title": "Exclude Under Contract", "type": "boolean", "description": "Hide listings already marked under contract.", "default": false }, "excludeAuctions": { "title": "Exclude Auctions", "type": "boolean", "description": "Hide auction listings.", "default": false }, "excludePrivateSales": { "title": "Exclude Private Sales", "type": "boolean", "description": "Hide private-sale listings.", "default": false }, "excludeNoDisplayPrice": { "title": "Exclude listings without display price", "type": "boolean", "description": "Hide listings that don't show a price.", "default": false }, "excludeDepositTaken": { "title": "Exclude Deposit Taken", "type": "boolean", "description": "Hide rentals that already have a deposit taken.", "default": false }, "newListingOnly": { "title": "New Listings Only", "type": "boolean", "description": "Restrict to newly added listings.", "default": false }, "furnished": { "title": "Furnished only (rent)", "type": "boolean", "description": "Rent channel only — show furnished listings only.", "default": false }, "petsAllowed": { "title": "Pets Allowed only (rent)", "type": "boolean", "description": "Rent channel only — show listings that allow pets.", "default": false }, "keywords": { "title": "Keywords", "type": "string", "description": "Comma-separated amenities (e.g. `pool,garage,ocean view`).", "default": "" }, "maxSoldAge": { "title": "Max Sold Age (Sold channel only)", "type": "string", "description": "Format `value:unit` — e.g. `6:months`, `90:days`, `2:years`. Only meaningful when Search Type = Sold.", "default": "" }, "autocomplete_inputs": { "title": "Autocomplete query (one per line)", "type": "array", "description": "Realestate.com.au search-box suggestions: suburbs, postcodes, regions, addresses, listings.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }