{ "openapi": "3.0.1", "info": { "title": "Realestate.com.au Scraper - Buy, Sold & Rent", "description": "Scrape realestate.com.au property listings for sale, for rent, or recently sold by suburb or search URL. Extract price, beds, baths, address, agent and more. JSON, CSV, Excel.", "version": "1.0", "x-build-id": "ootepaw3t4NIWmOqQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parsebird~realestate-au-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parsebird-realestate-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/parsebird~realestate-au-scraper/runs": { "post": { "operationId": "runs-sync-parsebird-realestate-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/parsebird~realestate-au-scraper/run-sync": { "post": { "operationId": "run-sync-parsebird-realestate-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": [ "mode" ], "properties": { "mode": { "title": "Search mode", "enum": [ "location", "url" ], "type": "string", "description": "Location mode builds a search from suburb + state + filters below. URL mode scrapes any search URL you already refined in a browser (recommended for complex filters).", "default": "location" }, "locations": { "title": "Locations to search (Location mode)", "type": "array", "description": "Suburb, state and postcode are all optional - provide whichever you have. Example: [{\"suburb\": \"Sydney\", \"state\": \"NSW\"}]" }, "listingType": { "title": "Listing type (Location mode)", "enum": [ "buy", "rent", "sold" ], "type": "string", "description": "Type of property listings to scrape. Location mode only.", "default": "buy" }, "sortBy": { "title": "Sort order", "enum": [ "relevance", "list-date", "list-date-asc", "price-asc", "price-desc" ], "type": "string", "description": "Sort order for search results. Applied after fetching, so it works in both Location and URL mode.", "default": "list-date" }, "dateRange": { "title": "Sold date range", "enum": [ "30days", "3months", "6months", "12months", "all" ], "type": "string", "description": "How far back to search for sold listings. Only applies when listing type is Recently Sold.", "default": "6months" }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Filter by property type (leave empty for all).", "items": { "type": "string", "enum": [ "house", "apartment", "townhouse", "villa", "land", "rural", "commercial" ], "enumTitles": [ "House", "Apartment/Unit", "Townhouse", "Villa", "Land", "Rural", "Commercial" ] } }, "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." }, "bedroomsMax": { "title": "Maximum bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Maximum number of bedrooms." }, "bathroomsMin": { "title": "Minimum bathrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum number of bathrooms." }, "includeSurrounding": { "title": "Include surrounding suburbs", "type": "boolean", "description": "Include properties from surrounding suburbs in results.", "default": true }, "urls": { "title": "Search URLs (URL mode)", "type": "array", "description": "Search result page URLs to scrape. Refine your search in a browser (filters, sort), then paste the resulting URL(s) here. All filter fields above are ignored in this mode.", "items": { "type": "string" } }, "maxListings": { "title": "Maximum listings", "minimum": 0, "type": "integer", "description": "Stop after scraping this many listings. Set to 0 for unlimited.", "default": 20 }, "maxPages": { "title": "Maximum pages per location", "minimum": 0, "type": "integer", "description": "Maximum search result pages to process per location. Each page has ~20 results. Set to 0 for unlimited.", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "realestate.com.au is protected by Kasada bot detection, which needs Apify's UNBLOCKER proxy group (residential proxies alone are not enough).", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "UNBLOCKER" ] } } } }, "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 } } } } } } } } } }