{ "openapi": "3.0.1", "info": { "title": "realestate.com.au Agents & Agencies Scraper", "description": "🧑‍💼 Scrape realestate.com.au real estate agents & agencies by suburb, postcode or search URL — names, emails, phones, agency, listing counts, median sold price & active suburbs. Built for lead lists & market research.", "version": "0.0", "x-build-id": "LyQQvYxalsUHp46CE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dz_omar~realestate-com-au-agents-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dz_omar-realestate-com-au-agents-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/dz_omar~realestate-com-au-agents-scraper/runs": { "post": { "operationId": "runs-sync-dz_omar-realestate-com-au-agents-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/dz_omar~realestate-com-au-agents-scraper/run-sync": { "post": { "operationId": "run-sync-dz_omar-realestate-com-au-agents-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": { "mode": { "title": "🧭 Mode", "enum": [ "location", "url" ], "type": "string", "description": "How you want to find agents. 'location' walks the listings in the suburbs you list; 'url' walks the realestate.com.au search URLs you paste. Fields belonging to the other mode are ignored (announced in the log).", "default": "location" }, "locations": { "title": "📍 Locations", "type": "array", "description": "location mode — one entry per area, as \"Suburb, STATE, Postcode\" (postcode optional), e.g. \"Sydney, NSW, 2000\" or \"Richmond, VIC\". The actor finds every agent and agency currently listing there.", "default": [], "items": { "type": "string" } }, "channels": { "title": "🔀 Listing types to search", "type": "array", "description": "location mode — which listing types to walk when finding agents. 'sold' adds recently-sold agents and real sold-price stats. Default: all three.", "items": { "type": "string", "enum": [ "buy", "rent", "sold" ], "enumTitles": [ "For sale (buy)", "For rent", "Sold" ] }, "default": [ "buy", "rent", "sold" ] }, "includeSurrounding": { "title": "➕ Include surrounding suburbs", "type": "boolean", "description": "location mode — also include agents from suburbs neighbouring the ones you listed (realestate.com.au's own 'surrounding suburbs' behaviour).", "default": true }, "startUrls": { "title": "🔗 Search URLs", "type": "array", "description": "url mode — one or more realestate.com.au search URLs (buy / rent / sold, including map-drawn searches). Copy straight from the browser after applying filters. Every agent and agency appearing in those results is returned.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "includeAgencies": { "title": "🏢 Also return agencies", "type": "boolean", "description": "In addition to individual agent records, emit one record per agency found — with its contact details, team roster, and listing counts.", "default": true }, "maxAgents": { "title": "📊 Max agents", "minimum": 0, "type": "integer", "description": "Stop after this many unique agent records. Set to 0 for every agent found across your locations/URLs. Agencies (if enabled) are returned in addition to this.", "default": 50 }, "maxSearchPages": { "title": "📄 Max pages per search (advanced)", "minimum": 1, "maximum": 20, "type": "integer", "description": "How deep to walk each listing search while discovering agents (each page is up to 100 listings). Higher finds more agents and better stats in big suburbs, at more proxy cost. realestate.com.au serves at most 2,000 results per search.", "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 } } } } } } } } } }