{ "openapi": "3.0.1", "info": { "title": "Real Estate AU Scraper", "description": "Extract property listings from realestate.com.au at scale. Get full listing data: prices, descriptions, images, floorplans, agent contacts, coordinates, inspection times, and more. All extracted directly from search pages with no individual property page visits needed.", "version": "1.0", "x-build-id": "aNHI8RdyFYgYwLDhn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abotapi~realestate-au-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abotapi-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/abotapi~realestate-au-scraper/runs": { "post": { "operationId": "runs-sync-abotapi-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/abotapi~realestate-au-scraper/run-sync": { "post": { "operationId": "run-sync-abotapi-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", "sitemap" ], "type": "string", "description": "How to find properties to scrape", "default": "location" }, "locations": { "title": "Locations", "type": "array", "description": "Locations to search. State is required. Suburb and postcode are optional — omit for broader searches.", "items": { "type": "object", "properties": { "suburb": { "title": "Suburb (Optional)", "type": "string", "description": "Suburb or city name, e.g. Sydney, Bondi Beach. Leave empty for state-wide search.", "editor": "textfield" }, "state": { "title": "State", "type": "string", "description": "Australian state or territory", "enum": [ "NSW", "VIC", "QLD", "SA", "WA", "TAS", "NT", "ACT" ], "editor": "select" }, "postcode": { "title": "Postcode (Optional)", "type": "string", "description": "4-digit postcode for suburb-level precision, e.g. 2000", "editor": "textfield", "pattern": "^[0-9]{4}$" } }, "required": [ "state" ] } }, "urls": { "title": "URLs", "type": "array", "description": "Search result page URLs to scrape (e.g. https://www.realestate.com.au/sold/in-northmead,+nsw+2152/list-1). Must be search pages, not individual property pages.", "items": { "type": "string" } }, "listingType": { "title": "Listing Type", "enum": [ "buy", "rent", "sold" ], "type": "string", "description": "Type of property listings to scrape", "default": "buy" }, "sortBy": { "title": "Sort Order", "enum": [ "relevance", "list-date", "list-date-asc", "price-asc", "price-desc", "next-inspection-time", "next-auction-time" ], "type": "string", "description": "Sort order for search results. Default is 'Date (Newest First)'. Only applies in location mode; in URL mode, include activeSort in your URLs directly.", "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'. Has no effect on buy/rent.", "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", "other" ], "enumTitles": [ "House", "Apartment/Unit", "Townhouse", "Villa", "Land", "Rural", "Commercial", "Other" ] } }, "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. When unchecked, only the exact suburb is searched.", "default": true }, "maxListings": { "title": "Maximum Listings", "minimum": 1, "type": "integer", "description": "Stop after scraping this many listings (no limit if empty). Higher values = lower cost per result.", "default": 20 }, "maxPages": { "title": "Maximum Pages per Location", "minimum": 1, "type": "integer", "description": "Maximum search result pages to process per location. Each page has ~25-30 results.", "default": 20 }, "outputFormat": { "title": "Output Formats", "type": "array", "description": "Export data in these formats", "items": { "type": "string", "enum": [ "json", "csv", "parquet" ], "enumTitles": [ "JSON", "CSV", "Parquet" ] }, "default": [ "json" ] }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Configure proxy for bypassing anti-bot protection" }, "sessionRotationInterval": { "title": "Session Rotation Interval", "minimum": 1, "type": "integer", "description": "Rotate browser session after this many requests", "default": 50 }, "requestDelay": { "title": "Request Delay", "type": "object", "description": "Delay between requests (milliseconds)" }, "resumeFromCheckpoint": { "title": "Resume from Checkpoint", "type": "boolean", "description": "Continue from last saved checkpoint if available", "default": 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 } } } } } } } } } }