{ "openapi": "3.0.1", "info": { "title": "realestate.com.au Scraper - Sale, Rent and Sold Listings", "description": "Collect Australian sale, rental and sold property listings from realestate.com.au. Get prices, addresses, bedrooms and available agent contacts. Pay per delivered row plus a start fee.", "version": "0.4", "x-build-id": "Q77YRmugJOWb2nGPp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~realestate-com-au-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-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/lentic_clockss~realestate-com-au-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-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/lentic_clockss~realestate-com-au-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-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": { "location": { "title": "Location", "maxLength": 120, "type": "string", "description": "Australian suburb or city and state, such as Melbourne, VIC. Leave all targets empty for an example search of up to 3 rows; ignored when detailUrls is filled." }, "locations": { "title": "Extra locations", "type": "array", "description": "Additional Australian locations, or the only location field for a multi-location search. Ignored when detailUrls is filled.", "items": { "type": "string" } }, "detailUrls": { "title": "Detail URLs (optional)", "type": "array", "description": "Property or project listing links on realestate.com.au with paths starting /property-, /sold/property- or /project/ and ending in a numeric listing ID. Location searches are skipped; agent, agency and search-result links are not accepted.", "items": { "type": "string" } }, "maxResults": { "title": "Max results per location or URL", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum rows per location or detail URL: default 70, with larger requests collected in parts of 70 and the whole run limited by your maximum charge. Free Apify plan: up to 200 rows per run and 10 runs of this Actor, as set by the developer.", "default": 70 }, "listingType": { "title": "Listing type", "enum": [ "sale", "rent", "sold", "both", "all" ], "type": "string", "description": "Choose sale, rent, sold, sale plus rent, or all three channels; combined channels share each location's row limit. An unknown value is ignored and falls back to sale.", "default": "sale" }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Optional search filters such as house, apartment, townhouse, land, rural or retire. Leave empty for all supported property types.", "default": [], "items": { "type": "string" } }, "minBeds": { "title": "Min bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Minimum bedrooms, from 0 to 10. Reversed minimum and maximum bedroom values are swapped." }, "maxBeds": { "title": "Max bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Maximum bedrooms, from 0 to 10. Leave unset for no maximum bedroom filter." }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Minimum search price in AUD. Reversed minimum and maximum price values are swapped." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Maximum search price in AUD. Leave unset for no maximum price filter." }, "maxPages": { "title": "Max pages", "minimum": 1, "maximum": 80, "type": "integer", "description": "Compatibility setting from 1 to 80; it does not limit pagination in normal Actor searches. Use maxResults to limit rows.", "default": 1 }, "enrichDetails": { "title": "Enrich from detail pages", "type": "boolean", "description": "Compatibility setting with no effect on current default collection. Available agent and agency contacts are included without changing this setting.", "default": true }, "failover": { "title": "Collection fallback (compatibility)", "type": "boolean", "description": "Compatibility setting with no effect on current default collection. Leave it at its default value.", "default": true }, "workerBaseUrl": { "title": "Developer test setting", "type": "string", "description": "Leave empty. Used only by the developer for testing.", "default": "" } } }, "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 } } } } } } } } } }