{ "openapi": "3.0.1", "info": { "title": "Realestate.com.au Property API", "description": "Australian property listings and sold property prices as clean, structured JSON. Search any suburb for buy, rent, or sold with no listing URL needed, and get beds, baths, parking, land size, sold date, agent details, and coordinates. Pay per listing, MCP-ready for Claude and AI agents.", "version": "0.0", "x-build-id": "kBpLpFSoVZfV7rHhV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/johnvc~realestate-au-property-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-johnvc-realestate-au-property-api", "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/johnvc~realestate-au-property-api/runs": { "post": { "operationId": "runs-sync-johnvc-realestate-au-property-api", "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/johnvc~realestate-au-property-api/run-sync": { "post": { "operationId": "run-sync-johnvc-realestate-au-property-api", "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": "Mode", "enum": [ "search", "url" ], "type": "string", "description": "How to find properties. Search builds the search for you from suburb, state and postcode, and needs no URL. URL collects specific listing pages you already hold.", "default": "search" }, "listingType": { "title": "Listing type", "enum": [ "buy", "rent", "sold" ], "type": "string", "description": "Whether to search properties for sale, for rent, or already sold. Sold is what powers sold-price research.", "default": "buy" }, "locations": { "title": "Locations", "maxItems": 20, "type": "array", "description": "Australian locations as \"Suburb, STATE\" or \"Suburb, STATE, POSTCODE\", for example \"Coomera, QLD, 4209\". A suburb must be paired with its state, because several Australian suburbs share a name. Leave empty to search the whole country. Up to 20 per run.", "items": { "type": "string" } }, "maxResultsPerSearch": { "title": "Max listings per search", "minimum": 1, "maximum": 2000, "type": "integer", "description": "How many listings to return for each search. You are charged per listing returned, so this is also your cost control.", "default": 50 }, "daysBack": { "title": "Listed in the last N days", "minimum": 1, "maximum": 365, "type": "integer", "description": "Only return listings added in the last N days. Works in search mode, where the search is automatically sorted newest first so the filter applies. In URL mode, your own search URL must already be sorted by date or the source rejects the filter." }, "limitPages": { "title": "Max result pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "Cap how many pages of search results to walk. Useful on large suburbs." }, "splitByPropertyType": { "title": "Split by property type", "type": "boolean", "description": "Walk each property type separately. Slower, but reaches deeper into a large suburb where a single result list is truncated.", "default": false }, "splitByPriceRange": { "title": "Split by price range", "type": "boolean", "description": "Walk each price band separately. Same trade-off as splitting by property type.", "default": false }, "listingUrls": { "title": "Listing URLs", "maxItems": 500, "type": "array", "description": "Specific listing URLs to collect, used in URL mode.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }