{ "openapi": "3.0.1", "info": { "title": "Realestate.com.au Scraper", "description": "Scrape Australian property listings and real estate agents from realestate.com.au — buy, rent, sold, and new homes, plus agent profiles, reviews, and sold properties.", "version": "1.0", "x-build-id": "dNEeviewWp64v6pOL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rigelbytes~realestate-com-au-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rigelbytes-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/rigelbytes~realestate-com-au-scraper/runs": { "post": { "operationId": "runs-sync-rigelbytes-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/rigelbytes~realestate-com-au-scraper/run-sync": { "post": { "operationId": "run-sync-rigelbytes-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": { "scrapeMode": { "title": "Scrape", "enum": [ "properties", "agents" ], "type": "string", "description": "Choose properties (buy/rent/sold/new homes) or real estate agents.", "default": "properties" }, "propertyChannel": { "title": "Property type", "enum": [ "buy", "rent", "sold", "new-homes" ], "type": "string", "description": "Market used with search queries. Ignored for start URLs (those already include buy, rent, sold, or new homes) and when scraping agents.", "default": "buy" }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Locations to search — e.g. \"Sydney CBD, NSW\", \"Melbourne VIC\", or \"4000\". Used when scrape mode is Properties.", "items": { "type": "string" } }, "startUrls": { "title": "Property URLs", "type": "array", "description": "Paste search or listing URLs from realestate.com.au — e.g. https://www.realestate.com.au/buy/in-sydney+cbd,+nsw/list-1 or a /property-… listing page.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "extractPropertyDetails": { "title": "Extract listing details", "type": "boolean", "description": "Open each listing page for the full description, gallery, inspections, and agency info. Charges property-details once per listing.", "default": false }, "extractAgentDetails": { "title": "Extract agent details", "type": "boolean", "description": "Open each listing agent's profile for bio, ratings, and experience. Charges the same agent-details event used in Agents mode, once per agent profile.", "default": false }, "extractAgentContact": { "title": "Extract agent contact", "type": "boolean", "description": "Include agent and agency phone numbers from the listing page. Charges agent-contact once per listing when a phone number is found.", "default": false }, "agentSearchQueries": { "title": "Agent search queries", "type": "array", "description": "Locations to find agents — e.g. \"Sydney CBD, NSW\". Used when scrape mode is Agents.", "items": { "type": "string" } }, "agentUrls": { "title": "Agent URLs", "type": "array", "description": "Paste find-agent search pages or agent profile URLs — e.g. https://www.realestate.com.au/find-agent/sydney-cbd-nsw or https://www.realestate.com.au/agent/emma-vadas-4016604.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "extractAgentProfile": { "title": "Extract full agent profile", "type": "boolean", "description": "Open each agent profile for details, reviews, and sold properties. Charges agent-details once per profile, agent-reviews once per review, and sold-properties once per sold listing.", "default": false }, "maxItems": { "title": "Max items", "minimum": 0, "type": "integer", "description": "Maximum properties or agents to scrape (0 = unlimited).", "default": 10 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential proxies are required for reliable access to realestate.com.au. Australian residential IPs work best.", "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 } } } } } } } } } }