{ "openapi": "3.0.1", "info": { "title": "Realestate.com.au Scraper - Listings, Agents, Prices & GPS", "description": "Scrape realestate.com.au listings for sale, rent and sold by suburb, postcode or search URL: price and price guide, address, GPS, beds/baths/cars, land size, photos, inspections, auctions, agency, agents and their phones, date listed, features. No login, no browser.", "version": "0.1", "x-build-id": "1h8IX7HB8WfhSO16G" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapersdelight~realestate-com-au-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapersdelight-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/scrapersdelight~realestate-com-au-scraper/runs": { "post": { "operationId": "runs-sync-scrapersdelight-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/scrapersdelight~realestate-com-au-scraper/run-sync": { "post": { "operationId": "run-sync-scrapersdelight-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": { "locations": { "title": "Locations", "type": "array", "description": "Where to search, as you would type it on realestate.com.au, e.g. \"Richmond, VIC 3121\", \"Bondi Beach, NSW 2026\", \"3000\", \"Sydney Region, NSW\" or \"vic\". Each line is its own search.", "items": { "type": "string" } }, "startUrls": { "title": "Search or listing URLs", "type": "array", "description": "realestate.com.au search URLs (list or map view, with your filters - the filter fields below are ignored for these), listing URLs, or listing ids, e.g. 152474812. A listing URL or id is read from its listing page (billed with the details add-on).", "items": { "type": "string" } }, "listingType": { "title": "Listing type", "enum": [ "buy", "rent", "sold" ], "type": "string", "description": "Buy (for sale), rent or sold. Applies to the locations above.", "default": "buy" }, "resultSource": { "title": "Result source", "enum": [ "list", "map" ], "type": "string", "description": "Search list = the full listing card (description, all photos, agents, inspections, auction, price guide). Map index = 8x fewer page loads per row: core fields + GPS only.", "default": "list" }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Leave empty for all types.", "items": { "type": "string", "enum": [ "house", "apartment", "townhouse", "villa", "land", "acreage", "rural", "block-of-units", "retirement" ], "enumTitles": [ "House", "Apartment & unit", "Townhouse", "Villa", "Land", "Acreage", "Rural", "Block of units", "Retirement living" ] } }, "minPrice": { "title": "Min price (AUD)", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Buy/sold: sale price. Rent: weekly rent, e.g. 400." }, "maxPrice": { "title": "Max price (AUD)", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Buy/sold: sale price, e.g. 1500000. Rent: weekly rent, e.g. 900." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "0 = studio." }, "maxBedrooms": { "title": "Max bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Upper bedroom limit, e.g. 4." }, "minBathrooms": { "title": "Min bathrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "At least this many bathrooms." }, "minParkingSpaces": { "title": "Min parking spaces", "minimum": 0, "maximum": 10, "type": "integer", "description": "At least this many car spaces." }, "minLandSize": { "title": "Min land size (m²)", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Land area in square metres, e.g. 300." }, "maxLandSize": { "title": "Max land size (m²)", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Land area in square metres, e.g. 1000." }, "includeSurroundingSuburbs": { "title": "Include surrounding suburbs", "type": "boolean", "description": "Off: only the suburb you named. On: realestate.com.au adds nearby suburbs after the exact matches (rows carry surroundingSuburb: true).", "default": false }, "constructionStatus": { "title": "New or established", "enum": [ "any", "new", "established" ], "type": "string", "description": "Buy and rent only.", "default": "any" }, "exclude": { "title": "Exclude", "type": "array", "description": "Hide these listings, as the site's own checkboxes do. Under contract / auctions / private sales apply to buy; deposit taken to rent.", "items": { "type": "string", "enum": [ "under-contract", "auctions", "private-sales", "no-display-price", "deposit-taken" ], "enumTitles": [ "Under contract", "Auctions", "Private sales", "No display price", "Deposit taken (rent)" ] } }, "keywords": { "title": "Keywords", "type": "array", "description": "Features or words the listing must mention, matched by the site, e.g. \"pool\", \"garage\", \"air conditioning\", \"water views\".", "items": { "type": "string" } }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "newest", "oldest", "price-low", "price-high", "next-inspection", "next-auction" ], "type": "string", "description": "The site's sort order. Next inspection/auction exist for buy (inspection also rent); sold supports newest and price.", "default": "relevance" }, "soldWithin": { "title": "Sold within (sold only)", "enum": [ "any", "last-month", "last-3-months", "last-6-months", "last-12-months" ], "type": "string", "description": "Sold searches only: how recent the sale must be.", "default": "any" }, "rentFurnishedOnly": { "title": "Furnished only (rent)", "type": "boolean", "description": "Rent searches only.", "default": false }, "rentPetsAllowed": { "title": "Pets allowed (rent)", "type": "boolean", "description": "Rent searches only.", "default": false }, "availableBefore": { "title": "Available before (rent)", "type": "string", "description": "Rent searches only: available on or before this date (YYYY-MM-DD)." }, "includeProjects": { "title": "Include new-development projects", "type": "boolean", "description": "Buy searches return off-the-plan projects as their own rows (project name, developer, price range, child listings). Turn off to keep only individual listings.", "default": true }, "onlyWithInspections": { "title": "Only listings with an inspection booked", "type": "boolean", "description": "Skip listings with no upcoming open-for-inspection time.", "default": false }, "onlyWithPhotos": { "title": "Only listings with photos", "type": "boolean", "description": "Skip listings that publish no photo.", "default": false }, "includeCoordinates": { "title": "Add GPS coordinates", "type": "boolean", "description": "Adds latitude/longitude to search-list rows from the site's map view (one extra page per 200 listings, no extra charge).", "default": true }, "includeDetails": { "title": "Add listing-page details", "type": "boolean", "description": "Opens each listing page for agent mobile + office phones, date listed, property features, highlights and NBN type. Billed as the listing-details add-on per listing; adds time.", "default": false }, "monitorMode": { "title": "Only new or changed listings", "type": "boolean", "description": "Remember what earlier runs delivered for these inputs and deliver only listings that are new or whose price/status changed (changeType, previousPriceText).", "default": false }, "monitorKey": { "title": "Monitor name", "type": "string", "description": "Optional name for the monitor memory, e.g. \"richmond-houses\". Leave empty to key it on the inputs." }, "maxResults": { "title": "Max listings", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Total listings to deliver across all inputs. realestate.com.au serves at most 2,000 per search (80 pages); 0 = no limit.", "default": 100 }, "maxResultsPerSearch": { "title": "Max listings per search", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Cap for each location or URL; 0 = no per-search cap.", "default": 0 }, "compact": { "title": "Compact output", "type": "boolean", "description": "Core fields only (id, price, address, GPS, beds/baths/cars, land, agency, agents, inspection, auction) - trimmed for AI/MCP pipelines.", "default": false }, "descriptionMaxLength": { "title": "Description max length", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Trim the description to this many characters; 0 = full text.", "default": 0 }, "maxConcurrency": { "title": "Max pages in flight", "minimum": 1, "maximum": 20, "type": "integer", "description": "Pages loaded at the same time. Each page takes 15-50 s to unlock, so more in flight = a faster run.", "default": 8 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }