{ "openapi": "3.0.1", "info": { "title": "Property.com.au Scraper: Sold History & Estimates", "description": "Scrape property.com.au listings by suburb: price, beds, baths, land size, estimated value, weekly rent estimate and the full sale and rent history of each property. Filter by state, suburb, postcode, sale or rent, property type and bedrooms.", "version": "0.1", "x-build-id": "cpZMZD1UBWxnoHzbU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kotaro001~property-com-au-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kotaro001-property-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/kotaro001~property-com-au-scraper/runs": { "post": { "operationId": "runs-sync-kotaro001-property-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/kotaro001~property-com-au-scraper/run-sync": { "post": { "operationId": "run-sync-kotaro001-property-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", "required": [ "state", "suburb", "postcode" ], "properties": { "state": { "title": "State", "enum": [ "nsw", "vic", "qld", "wa", "sa", "tas", "act", "nt", "NSW", "VIC", "QLD", "WA", "SA", "TAS", "ACT", "NT" ], "type": "string", "description": "Australian state. Accepts NSW/VIC/QLD (uppercase) and lowercase aliases.", "default": "VIC" }, "suburb": { "title": "Suburb", "type": "string", "description": "Suburb name as it appears on property.com.au, e.g. Newtown.", "default": "Richmond" }, "postcode": { "title": "Postcode", "type": "string", "description": "Postcode of that suburb, e.g. 2042.", "default": "3121" }, "mode": { "title": "Legacy: channel alias", "enum": [ "buy", "rent", "sold" ], "type": "string", "description": "Legacy alias for channel. Kept for old tasks; use channel.", "default": "sold" }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Leave empty for every type. Each selected type costs one page load.", "items": { "type": "string", "enum": [ "house", "unit", "townhouse", "villa", "land", "acreage", "rural" ] }, "default": [] }, "bedrooms": { "title": "Bedrooms (exact)", "minimum": 0, "maximum": 5, "type": "integer", "description": "0 = any. Filtering is applied after the pages load, so pages must cover the suburb.", "default": 0 }, "maxPages": { "title": "Max result pages", "minimum": 1, "maximum": 20, "type": "integer", "description": "One page holds about 20 listings. Two pages cover most suburbs.", "default": 1 }, "details": { "title": "Legacy: detail alias", "type": "boolean", "description": "Legacy alias for includeDetails. Kept for old tasks; use includeDetails.", "default": false }, "maxDetails": { "title": "How many listings to open", "minimum": 1, "maximum": 100, "type": "integer", "description": "Only used when the toggle above is on.", "default": 10 }, "detailCacheDays": { "title": "Detail cache (days)", "minimum": 0, "maximum": 180, "type": "integer", "description": "Reuse a listing's valuation and history for this many days. 0 = always fetch fresh. A price change always refetches.", "default": 7 }, "maxItems": { "title": "Max rows in the dataset", "type": "integer", "description": "0 = no cap. Free-plan runs stop at 50 rows by design.", "default": 25 }, "dealType": { "title": "Legacy: channel alias", "enum": [ "buy", "rent", "sold" ], "type": "string", "description": "Legacy alias for channel. Kept for old tasks; use channel." }, "startUrls": { "title": "Search URLs", "type": "array", "description": "Optional search/list page URLs only. Do not pass a single property listing address.", "items": { "type": "string" }, "default": [] }, "minPrice": { "title": "Min price", "type": "integer", "description": "Applied after the page is fetched; both portals ignore price in the URL." }, "maxPrice": { "title": "Max price", "type": "integer", "description": "Applied after the page is fetched." }, "includeRemovedListings": { "title": "Include removed listings", "type": "boolean", "description": "Emit a REMOVED row when a listing disappears from the search.", "default": false }, "stateKey": { "title": "State key", "type": "string", "description": "Named state slot: STATE_ in the key-value store.", "default": "default" }, "onlyEmitChanges": { "title": "Only emit changes", "type": "boolean", "description": "Changes mode only emits new, changed or removed rows. Daily mode bills every row it emits.", "default": false }, "channel": { "title": "Channel", "enum": [ "buy", "rent", "sold" ], "type": "string", "description": "buy, rent or sold. Shared vocabulary with the other Australian property actors.", "default": "sold" }, "includeDetails": { "title": "Open each listing (price history + valuation)", "type": "boolean", "description": "Adds estimated value, rent estimate, sale/rent history, agency and overlays. Billed per detail row.", "default": false }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "type": "integer", "description": "Applied after the page loads; a listing without the field is dropped." }, "maxBedrooms": { "title": "Maximum bedrooms", "minimum": 0, "type": "integer", "description": "Applied after the page loads; a listing without the field is dropped." }, "minBathrooms": { "title": "Minimum bathrooms", "minimum": 0, "type": "integer", "description": "Applied after the page loads; a listing without the field is dropped." }, "minCarSpaces": { "title": "Minimum car spaces", "minimum": 0, "type": "integer", "description": "Applied after the page loads; a listing without the field is dropped." }, "minLandSize": { "title": "Minimum land size (m²)", "minimum": 0, "type": "integer", "description": "Applied after the page loads; a listing without the field is dropped." }, "maxLandSize": { "title": "Maximum land size (m²)", "minimum": 0, "type": "integer", "description": "Applied after the page loads; a listing without the field is dropped." }, "minDaysOnMarket": { "title": "Minimum days on market", "minimum": 0, "type": "integer", "description": "Keep only listings that have been advertised for at least this many days. 0 = no filter. Rows without a known days-on-market value are dropped when this is above 0.", "default": 0 }, "suburbs": { "title": "Suburbs (multi-area)", "type": "array", "description": "Optional. One or more areas such as 'Downer, ACT, 2602'. Each entry becomes its own search, and all rows land in one dataset. You can also separate entries with a semicolon in the suburb field.", "items": { "type": "string" }, "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 } } } } } } } } } }