{ "openapi": "3.0.1", "info": { "title": "realestate.com.au & Domain Scraper — Buy, Rent, Sold", "description": "For-sale, rental and sold listings from realestate.com.au and Domain in one run, merged into one row per property: address, parsed price, beds, baths, parking, land size, agency, agents, coordinates and both links.", "version": "0.2", "x-build-id": "FOZ43uOe2bFvjNkKp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/he_work~au-property-listings/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-he_work-au-property-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/he_work~au-property-listings/runs": { "post": { "operationId": "runs-sync-he_work-au-property-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/he_work~au-property-listings/run-sync": { "post": { "operationId": "run-sync-he_work-au-property-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": { "locations": { "title": "Suburbs", "type": "array", "description": "One per line, as 'Suburb, STATE postcode', e.g. 'Paddington, QLD 4064'.", "items": { "type": "string" } }, "listingType": { "title": "Listing type", "enum": [ "buy", "rent", "sold" ], "type": "string", "description": "Which listings to collect.", "default": "buy" }, "sites": { "title": "Sites", "type": "array", "description": "Search one or both portals.", "items": { "type": "string", "enum": [ "realestate", "domain" ], "enumTitles": [ "realestate.com.au", "Domain" ] }, "default": [ "realestate", "domain" ] }, "maxPages": { "title": "Pages per suburb per site", "minimum": 1, "maximum": 50, "type": "integer", "description": "realestate.com.au shows 25 listings per page, Domain 20.", "default": 2 }, "maxListings": { "title": "Max listings", "minimum": 1, "type": "integer", "description": "Hard cap on results (and on what you pay) for the whole run.", "default": 200 }, "mergeAcrossSites": { "title": "Merge the same property across sites", "type": "boolean", "description": "One row per property when it's listed on both portals, with both links.", "default": true }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Both portals block datacenter IPs; an Apify AU residential proxy is required.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "AU" } }, "watchListName": { "title": "Watch list name", "type": "string", "description": "Any name, e.g. 'qld-tenders'. Runs with the same name compare against each other: items get change_status new / changed / unchanged." }, "onlyNewItems": { "title": "Only new / changed items", "type": "boolean", "description": "With a watch list name: skip (and don't charge for) items that were already seen and haven't changed.", "default": false }, "slackWebhookUrl": { "title": "Slack webhook URL", "type": "string", "description": "Slack incoming-webhook URL. Gets a digest of new / changed items after each run." }, "telegramBotToken": { "title": "Telegram bot token", "type": "string", "description": "From @BotFather. Use together with the chat ID." }, "telegramChatId": { "title": "Telegram chat ID", "type": "string", "description": "Chat, group or channel ID that receives the digest (e.g. -1001234567890)." }, "discordWebhookUrl": { "title": "Discord webhook URL", "type": "string", "description": "Discord channel webhook URL. Gets the digest." }, "googleSheetsWebAppUrl": { "title": "Google Sheets web app URL", "type": "string", "description": "Deploy the 10-line Apps Script from the README in your sheet and paste its web app URL: every new / changed item is appended as a row." }, "notifyEmail": { "title": "Email digest to", "type": "string", "description": "Email address for the digest (sent with Apify's send-mail Actor)." } } }, "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 } } } } } } } } } }