{ "openapi": "3.0.1", "info": { "title": "RealEstate.com.au Scraper | Fast & Reliable", "description": "Collect structured Realestate.com.au listing data including pricing, locations, agency profiles, agent contacts, media, and property signals across Australia. Built for enterprise-grade real estate intelligence, inventory monitoring, and scalable analytics pipelines.", "version": "0.0", "x-build-id": "1ipIhqkdSunkFOVe2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fatihtahta~realestate-com-au-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fatihtahta-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/fatihtahta~realestate-com-au-scraper/runs": { "post": { "operationId": "runs-sync-fatihtahta-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/fatihtahta~realestate-com-au-scraper/run-sync": { "post": { "operationId": "run-sync-fatihtahta-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": { "deal_type": { "title": "Select Sale, Rent, or Sold Listings", "enum": [ "buy", "rent", "sold" ], "type": "string", "description": "Choose the listing channel for this run. The default collects properties for sale; switch to rent or sold when that better matches your workflow.", "default": "buy" }, "location": { "title": "Add Australian Location", "type": "string", "description": "Enter a location including, regions suburbs or post codes such as \"Northern Region\" or \"2000\". Leave empty to run without a location filter." }, "include_surrounding_areas": { "title": "Include Surrounding Areas", "type": "boolean", "description": "Keep enabled to include listings from surrounding suburbs or nearby areas. Disable it when you only want results from the exact selected location.", "default": true }, "min_price": { "title": "Set Minimum Price", "minimum": 1, "type": "integer", "description": "Only include listings priced at or above this value. Leave empty when you do not need a lower price boundary." }, "max_price": { "title": "Set Maximum Price", "minimum": 1, "type": "integer", "description": "Only include listings priced at or below this value. Leave empty when you do not need an upper price boundary." }, "has_price": { "title": "Require a Displayed Price", "type": "boolean", "description": "Enable this to keep only buy or sold listings that show a price. This setting does not affect rental searches.", "default": false }, "property_type": { "title": "Choose Property Types", "uniqueItems": true, "type": "array", "description": "Only include listings matching one or more selected property types. Leave empty to include all property types. For rental searches, unsupported property types are ignored.", "items": { "type": "string", "enum": [ "retirement_living", "house", "land", "townhouse", "acreage", "apartment_and_unit", "rural", "villa", "block_of_units" ], "enumTitles": [ "Retirement living", "House", "Land", "Townhouse", "Acreage", "Apartment and unit", "Rural", "Villa", "Block of units" ] } }, "min_bedroom": { "title": "Set Minimum Bedrooms", "enum": [ "studio", "1", "2", "3", "4", "5" ], "type": "string", "description": "Only include listings with at least this many bedrooms. Leave empty when any bedroom count is acceptable." }, "max_bedroom": { "title": "Set Maximum Bedrooms", "enum": [ "studio", "1", "2", "3", "4", "5" ], "type": "string", "description": "Only include listings with at most this many bedrooms. Leave empty when you do not need an upper bedroom boundary." }, "min_bathroom": { "title": "Set Minimum Bathrooms", "enum": [ "1", "2", "3", "4", "5" ], "type": "string", "description": "Only include listings with at least this many bathrooms. Leave empty when bathroom count is not a selection factor." }, "min_parking": { "title": "Set Minimum Parking Spaces", "enum": [ "1", "2", "3", "4", "5" ], "type": "string", "description": "Only include listings with at least this many parking spaces. Leave empty when parking availability is not required." }, "property_condition": { "title": "Choose Property Condition", "enum": [ "new", "established" ], "type": "string", "description": "Choose new properties or established properties when you want to focus the result set. Leave empty to include both." }, "min_area": { "title": "Set Minimum Land Area", "minimum": 1, "type": "integer", "description": "Only include buy or sold listings with land area at or above this value in square metres. Leave empty when you do not need a lower land area boundary." }, "max_area": { "title": "Set Maximum Land Area", "minimum": 1, "type": "integer", "description": "Only include buy or sold listings with land area at or below this value in square metres. Leave empty when you do not need an upper land area boundary." }, "keyword": { "title": "Add Listing Keyword", "type": "string", "description": "Enter a short search term such as \"air con\", \"water views\", or \"renovated\". Leave empty when you do not need keyword-based narrowing." }, "sale_method": { "title": "Choose Sale Method", "enum": [ "private_treaty_sale", "auction" ], "type": "string", "description": "Choose private treaty sale to exclude auctions, or auction to exclude private sale listings. Leave empty to include both sale methods." }, "rental_property_requirements": { "title": "Choose Rental Requirements", "uniqueItems": true, "type": "array", "description": "Only applies when the listing channel is rent. Choose one or more requirements to narrow rental listings, or leave empty to include all rental requirement types.", "items": { "type": "string", "enum": [ "furnished", "pets_allowed", "affordable_housing" ], "enumTitles": [ "Furnished", "Pets allowed", "Affordable housing" ] } }, "outdoor_amenities": { "title": "Choose Outdoor Amenities", "uniqueItems": true, "type": "array", "description": "Only include listings that match one or more selected outdoor amenities. Leave empty when outdoor features are not required.", "items": { "type": "string", "enum": [ "swimming_pool", "garage", "balcony", "outdoor_area", "undercover_parking", "shed", "fully_fenced", "outdoor_spa", "tennis_court" ], "enumTitles": [ "Swimming pool", "Garage", "Balcony", "Outdoor area", "Undercover parking", "Shed", "Fully fenced", "Outdoor spa", "Tennis court" ] } }, "indoor_amenities": { "title": "Choose Indoor Amenities", "uniqueItems": true, "type": "array", "description": "Only include listings that match one or more selected indoor amenities. Leave empty when indoor features are not required.", "items": { "type": "string", "enum": [ "ensuite", "dishwasher", "study", "built_in_robes", "alarm_system", "broadband", "floorboards", "gym", "rumpus_room", "workshop" ], "enumTitles": [ "Ensuite", "Dishwasher", "Study", "Built in robes", "Alarm system", "Broadband", "Floorboards", "Gym", "Rumpus room", "Workshop" ] } }, "climate_amenities": { "title": "Choose Climate and Energy Amenities", "uniqueItems": true, "type": "array", "description": "Only include listings that match one or more selected climate, energy, or utility amenities. Leave empty when these features are not required.", "items": { "type": "string", "enum": [ "air_conditioning", "solar_panels", "heating", "fireplace", "high_energy_efficiency", "water_tank", "solar_hot_water" ], "enumTitles": [ "Air conditioning", "Solar panels", "Heating", "Fireplace", "High energy efficiency", "Water tank", "Solar hot water" ] } }, "accessibility_amenities": { "title": "Choose Accessibility Amenities", "uniqueItems": true, "type": "array", "description": "Only include listings that match one or more selected accessibility amenities. Leave empty when accessibility features are not required.", "items": { "type": "string", "enum": [ "single_storey", "step_free_entry", "wide_doorways", "elevator", "roll_in_shower", "bathroom_grab_rails", "accessible_parking" ], "enumTitles": [ "Single storey", "Step free entry", "Wide doorways", "Elevator", "Roll in shower", "Bathroom grab rails", "Accessible parking" ] } }, "maximize_coverage": { "title": "Maximize Matching Results", "type": "boolean", "description": "Enable this to collect a broader set of matching results for the selected location and filter combination. Disable it for faster test runs or smaller sampling workflows.", "default": true }, "limit": { "title": "Set Maximum Results", "minimum": 1, "type": "integer", "description": "Enter the maximum number of listings to save. Leave empty to collect all available matching results." } } }, "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 } } } } } } } } } }