{ "openapi": "3.0.1", "info": { "title": "realestate.com.au API Scraper", "description": "Scrape realestate.com.au property listings (buy/rent/sold) by location via the official mobile API: search, filters, pagination, full listing detail incl. all media, features, agent & agency contact, geo and the full raw response.", "version": "0.0", "x-build-id": "y498WGuQ5N8UzGe3K" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rl1987~realestateau-api-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rl1987-realestateau-api-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/rl1987~realestateau-api-scraper/runs": { "post": { "operationId": "runs-sync-rl1987-realestateau-api-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/rl1987~realestateau-api-scraper/run-sync": { "post": { "operationId": "run-sync-rl1987-realestateau-api-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": { "location": { "title": "Location", "type": "string", "description": "Human location to search, e.g. 'Richmond, VIC 3121', 'Bondi Beach', 'Perth'. Resolved to the exact locality via realestate.com.au's own mobile suggest API." }, "maxItems": { "title": "Max listings", "type": "integer", "description": "Maximum listings to return (0 = all pages).", "default": 20 }, "priceMin": { "title": "Min price", "type": "integer", "description": "Minimum price filter." }, "priceMax": { "title": "Max price", "type": "integer", "description": "Maximum price filter." }, "bedroomsMin": { "title": "Min bedrooms", "type": "integer", "description": "Minimum bedrooms." }, "bathroomsMin": { "title": "Min bathrooms", "type": "integer", "description": "Minimum bathrooms." }, "carsMin": { "title": "Min car spaces", "type": "integer", "description": "Minimum car spaces." }, "surroundingSuburbs": { "title": "Include surrounding suburbs", "type": "boolean", "description": "Include listings in surrounding suburbs.", "default": false }, "includeDetails": { "title": "Fetch full detail", "type": "boolean", "description": "Fetch the full property detail (media, features, description, agent & agency contact) for each listing. Costs an extra per-listing charge — turn off for a faster, lighter, cheaper run.", "default": true }, "channel": { "title": "Channel", "enum": [ "buy", "rent", "sold" ], "type": "string", "description": "Buy, rent or sold listings." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Route requests through a proxy. realestate.com.au's Akamai edge blocks datacenter IPs by reputation, so a residential/ISP proxy (Australia) is required.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "AU" } }, "proxyUrl": { "title": "Direct proxy URL (advanced)", "type": "string", "description": "Optional. A residential/ISP proxy URL (http://user:pass@host:port) used verbatim; overrides the proxy configuration above. Must allow POST." } } }, "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 } } } } } } } } } }