{ "openapi": "3.0.1", "info": { "title": "CommercialRealEstate.com.au Property Scraper", "description": "Scrape Australian commercial property listings: sale prices, lease rates, land area, tenancy details, and agent mobile numbers from CommercialRealEstate.com.au.", "version": "0.1", "x-build-id": "azvxhW3Xn2b1ZMFQk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/getascraper~commercialrealestate-au-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-getascraper-commercialrealestate-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/getascraper~commercialrealestate-au-scraper/runs": { "post": { "operationId": "runs-sync-getascraper-commercialrealestate-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/getascraper~commercialrealestate-au-scraper/run-sync": { "post": { "operationId": "run-sync-getascraper-commercialrealestate-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": [ "proxyConfiguration" ], "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "CommercialRealEstate.com.au search, category, or individual listing URLs. Takes priority over all other filters when provided.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "location": { "title": "Location", "type": "array", "description": "Australian suburb, city, or state to search (e.g. Sydney, Melbourne CBD, nsw/sydney). One URL is generated per entry. Ignored when Start URLs are provided.", "default": [] }, "listingMode": { "title": "Listing Mode", "enum": [ "sale", "lease", "sold", "business" ], "type": "string", "description": "Type of listings to scrape.", "default": "sale" }, "propertyType": { "title": "Property Type", "enum": [ "any", "offices", "industrial", "retail", "land", "medical", "hotel-leisure", "showrooms", "other" ], "type": "string", "description": "Commercial property category to filter results.", "default": "any" }, "minPrice": { "title": "Min Price (AUD)", "minimum": 0, "type": "integer", "description": "Minimum asking price in Australian dollars." }, "maxPrice": { "title": "Max Price (AUD)", "minimum": 0, "type": "integer", "description": "Maximum asking price in Australian dollars." }, "minFloorArea": { "title": "Min Floor Area (m²)", "minimum": 0, "type": "integer", "description": "Minimum building floor area in square metres." }, "maxFloorArea": { "title": "Max Floor Area (m²)", "minimum": 0, "type": "integer", "description": "Maximum building floor area in square metres." }, "minLandArea": { "title": "Min Land Area (m²)", "minimum": 0, "type": "integer", "description": "Minimum land area in square metres." }, "maxLandArea": { "title": "Max Land Area (m²)", "minimum": 0, "type": "integer", "description": "Maximum land area in square metres." }, "tenureType": { "title": "Tenure Type", "enum": [ "any", "vacant_possession", "tenanted" ], "type": "string", "description": "Filter by occupancy profile. Vacant Possession is ready for immediate use; Tenanted Investment has existing rental income.", "default": "any" }, "keyword": { "title": "Keyword", "type": "string", "description": "Free-text keyword to narrow listing results (e.g. childcare, service station, cold storage)." }, "sortBy": { "title": "Sort Order", "enum": [ "featured", "newest", "price-asc", "price-desc" ], "type": "string", "description": "Order results are returned in.", "default": "featured" }, "maxItems": { "title": "Max Items", "minimum": 1, "type": "integer", "description": "Maximum total listings to extract across all pages.", "default": 100 }, "harvestEmails": { "title": "Harvest Agency Emails", "type": "boolean", "description": "Visit each agency website and extract contact email addresses. Adds harvested_emails to every record. Increases run time and cost.", "default": false }, "deepScrape": { "title": "Deep Scrape (Property Details)", "type": "boolean", "description": "Open each listing detail page to extract EOI dates, NBN status, transit distances, and full descriptions. Slower but significantly more complete.", "default": false }, "flatten": { "title": "Flatten Output (CSV-friendly)", "type": "boolean", "description": "Join array fields (images, highlights, property types) as pipe-separated strings for easy Excel/CSV export.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Australian residential proxies are strongly recommended to bypass Akamai Bot Manager and geo-IP restrictions.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }