{ "openapi": "3.0.1", "info": { "title": "Realestateau Property", "description": "Scrape Realestate.com.au property listings across Australia for sale, rent, and sold data. Filter by location, price, bedrooms, property type, features, inspections, auctions, and sale dates, then export clean property, agency, agent, media, and market data to Apify datasets.", "version": "0.0", "x-build-id": "Ol6XmPsDgfe65Pv2Y" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/websift~realestateau-property/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-websift-realestateau-property", "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/websift~realestateau-property/runs": { "post": { "operationId": "runs-sync-websift-realestateau-property", "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/websift~realestateau-property/run-sync": { "post": { "operationId": "run-sync-websift-realestateau-property", "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", "type": "string", "description": "Suburb, postcode, or location name to search (e.g. Panania NSW or 2213)." }, "includeSurrounding": { "title": "Include Surrounding", "type": "boolean", "description": "Include surrounding suburbs in search results." }, "maxResults": { "title": "Maximum results", "type": "integer", "description": "The maximum number of property listings to return.", "default": 300 }, "searchType": { "title": "Search Type", "enum": [ "Buy", "Rent", "Sold" ], "type": "string", "description": "Search type used for properties." }, "propertyType": { "title": "Property Type", "type": "array", "description": "Property type used for filtering statistics.", "items": { "type": "string", "enum": [ "All Types", "Retirement Living", "House", "Land", "Townhouse", "Acreage", "Apartment & Unit", "Rural", "Villa", "Block Of Units" ] } }, "sortBy": { "title": "Sort By", "enum": [ "Featured", "Date (Newest-Oldest)", "Date (Oldest-Newest)", "Price (Lowest-Highest)", "Price (Highest-Lowest)", "Next Inspection", "Next Auction" ], "type": "string", "description": "Sorting method for property results." }, "minPrice": { "title": "Minimum Price", "type": "integer", "description": "Minimum property price filter." }, "maxPrice": { "title": "Maximum Price", "type": "integer", "description": "Maximum property price filter." }, "minBeds": { "title": "Minimum Beds", "type": "integer", "description": "Minimum number of bedrooms." }, "maxBeds": { "title": "Maximum Beds", "type": "integer", "description": "Maximum number of bedrooms." }, "numBaths": { "title": "Number of Baths", "type": "integer", "description": "Minimum number of bathrooms." }, "numParkingSpaces": { "title": "Number of Parking Spaces", "type": "integer", "description": "Minimum number of parking spaces." }, "keywords": { "title": "Keywords", "type": "array", "description": "Keywords to add in search", "items": { "type": "string" } }, "minLandSize": { "title": "Minimum Land Size", "type": "integer", "description": "Minimum land size filter." }, "maxLandSize": { "title": "Maximum Land Size", "type": "integer", "description": "Maximum land size filter." }, "newOrEstablished": { "title": "New Or Established", "enum": [ "All Types", "New", "Established" ], "type": "string", "description": "Filter by new or established properties." }, "saleMethod": { "title": "Sale Method", "enum": [ "All Types", "Private treaty sale", "Auction" ], "type": "string", "description": "Sale Method" }, "propertiesWithPrice": { "title": "Only show properties with a price", "type": "boolean", "description": "Only show properties with a price" }, "excludeUnderOffer": { "title": "Exclude properties under contract/offer", "type": "boolean", "description": "Exclude properties under contract/offer" }, "propertyRequirements": { "title": "Property requirements", "type": "array", "description": "Property requirements", "items": { "type": "string", "enum": [ "Furnished", "Pets considered" ] } }, "availableBefore": { "title": "Available Before", "type": "string", "description": "Only include rental properties available before this date." }, "excludeDespositTaken": { "title": "Exclude properties secured by a deposit", "type": "boolean", "description": "Exclude properties secured by a deposit" }, "affordableHousing": { "title": "Affordable housing", "type": "boolean", "description": "This filter finds properties that are offered under rental affordability schemes." }, "maxSoldAge": { "title": "Maximum Sold Age (Months)", "type": "integer", "description": "Maximum age of sold listings in months." }, "excludeNoSalePrice": { "title": "Only show properties with a sold price", "type": "boolean", "description": "Only show properties with a sold price" }, "climateControlAndEnergyFeatures": { "title": "Climate Control And Energy Features", "type": "array", "description": "Select climate control and energy features.", "items": { "type": "string", "enum": [ "Air Conditioning", "Solar Panels", "Heating", "Fireplace", "High Energy Efficiency", "Water Tank", "Solar Hot Water" ] } }, "indoorFeatures": { "title": "Indoor Features", "type": "array", "description": "Select indoor features.", "items": { "type": "string", "enum": [ "Ensuite", "Dishwasher", "Study", "Built In Robes", "Alarm System", "Broadband", "Floorboards", "Gym", "Rumpus Room", "Workshop" ] } }, "outdoorFeatures": { "title": "Outdoor Features", "type": "array", "description": "Select outdoor features.", "items": { "type": "string", "enum": [ "Swimming Pool", "Garage", "Balcony", "Outdoor Area", "Undercover Parking", "Shed", "Fully Fenced", "Outdoor Spa", "Tennis Court" ] } }, "accessibilityFeatures": { "title": "Accessibility Features", "type": "array", "description": "Select accessibility features.", "items": { "type": "string", "enum": [ "Single Storey", "Step Free Entry", "Wide Doorways", "Elevator", "Roll-In Shower", "Bathroom Grab Rails", "Accessible Parking" ] } } } }, "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 } } } } } } } } } }