{ "openapi": "3.0.1", "info": { "title": "AU Residential Property Listings Scraper", "description": "Scrapes Property and Real estate listings from https://www.property.com.au/. Supports both listing pages and individual property pages.\n\nScrape suburb listing pages (buy, rent, sold)\nScrape individual property pages\nExtract comprehensive property data", "version": "0.5", "x-build-id": "GfZeTC1ZoXs0BUo5v" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abotapi~property-au-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abotapi-property-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/abotapi~property-au-scraper/runs": { "post": { "operationId": "runs-sync-abotapi-property-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/abotapi~property-au-scraper/run-sync": { "post": { "operationId": "run-sync-abotapi-property-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": { "mode": { "title": "Scraping Mode", "enum": [ "listing", "url" ], "type": "string", "description": "Choose scraping mode: 'listing' to scrape by suburb/postcode, or 'url' to scrape specific search page URLs directly.", "default": "listing" }, "search": { "title": "Location Search", "type": "string", "description": "Search for a location - type a suburb name (e.g., 'southbank'), postcode (e.g., '3006'), or partial name (e.g., 'wantir'). The scraper will automatically find the correct state and postcode.", "default": "southbank" }, "urls": { "title": "Search Page URLs", "type": "array", "description": "List of property.com.au search page URLs (for 'url' mode). Listing type is auto-detected from the URL path (/buy/, /rent/, /sold/).", "items": { "type": "string" } }, "listing_type": { "title": "Listing Type", "enum": [ "buy", "rent", "sold" ], "type": "string", "description": "Type of listings to scrape (for listing mode)", "default": "buy" }, "propertyTypes": { "title": "Property Types", "type": "array", "description": "Filter by property type (leave empty for all)", "items": { "type": "string", "enum": [ "HOUSE", "APARTMENT", "TOWNHOUSE", "VILLA", "LAND", "ACREAGE", "RURAL", "BLOCK_OF_UNITS", "RETIREMENT" ], "enumTitles": [ "House", "Apartment / Unit", "Townhouse", "Villa", "Land", "Acreage", "Rural", "Block of Units", "Retirement" ] } }, "priceMin": { "title": "Minimum Price", "minimum": 0, "type": "integer", "description": "Minimum property price (AUD)" }, "priceMax": { "title": "Maximum Price", "minimum": 0, "type": "integer", "description": "Maximum property price (AUD)" }, "bedroomsMin": { "title": "Minimum Bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum number of bedrooms" }, "bathroomsMin": { "title": "Minimum Bathrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum number of bathrooms" }, "landSizeMin": { "title": "Minimum Land Size (m²)", "minimum": 0, "type": "integer", "description": "Minimum land size in square metres" }, "carSpacesMin": { "title": "Minimum Car Spaces", "minimum": 0, "type": "integer", "description": "Minimum number of car spaces" }, "keywords": { "title": "Keywords", "type": "string", "description": "Search keywords (e.g. pool, renovated, corner block)" }, "excludeUnderOffer": { "title": "Exclude Under Offer", "type": "boolean", "description": "Exclude properties that are under offer (buy mode only)", "default": false }, "sortBy": { "title": "Sort Order", "enum": [ "RELEVANCY", "NEW_DESC", "NEW_ASC", "PRICE_ASC", "PRICE_DESC", "NEXT_AUCTION", "NEXT_INSPECTION" ], "type": "string", "description": "Sort order for search results. Default is 'Date (Newest First)'. Only applies in listing mode; in URL mode, include sortOption in your URLs directly.", "default": "NEW_DESC" }, "max_properties": { "title": "Max Properties", "type": "integer", "description": "Maximum number of properties to scrape (0 = unlimited)", "default": 2 }, "max_pages": { "title": "Max Pages", "type": "integer", "description": "Maximum number of listing pages to scrape for pagination (default: 2)", "default": 1 }, "proxy": { "title": "Proxy Configuration", "type": "object", "description": "Residential proxies are recommended." }, "dataset_name": { "title": "Dataset Name", "type": "string", "description": "Custom dataset name to store results. Use 'default' or leave empty for the default dataset.", "default": "default" }, "clear_dataset": { "title": "Clear Dataset", "type": "boolean", "description": "Clear the dataset before scraping (useful for fresh runs)", "default": false } } }, "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 } } } } } } } } } }