{ "openapi": "3.0.1", "info": { "title": "Domain.com.au Scraper: Sold Prices, Schools & Suburb Trends", "description": "Scrape domain.com.au sale, rent and sold property listings by suburb. Rows carry price, beds, baths, parking, land size, sale method and inspection times; detail pages add school catchments, suburb medians, clearance rate, owner-occupier mix and agent phones.", "version": "0.1", "x-build-id": "KexvF5fA3d6yyw0Ns" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kotaro001~domain-com-au-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kotaro001-domain-com-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/kotaro001~domain-com-au-scraper/runs": { "post": { "operationId": "runs-sync-kotaro001-domain-com-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/kotaro001~domain-com-au-scraper/run-sync": { "post": { "operationId": "run-sync-kotaro001-domain-com-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", "properties": { "channel": { "title": "Channel", "enum": [ "buy", "rent", "sold" ], "type": "string", "description": "buy = for sale, rent = rental listings, sold = sold results with price and sale method.", "default": "buy" }, "suburb": { "title": "Suburb", "type": "string", "description": "Suburb name, e.g. Surry Hills. Use suburbs for several areas in one run.", "default": "Sydney" }, "state": { "title": "State", "enum": [ "nsw", "vic", "qld", "wa", "sa", "tas", "act", "nt", "NSW", "VIC", "QLD", "WA", "SA", "TAS", "ACT", "NT" ], "type": "string", "description": "Two or three letter state code: NSW, VIC, QLD, WA, SA, TAS, ACT, NT.", "default": "NSW" }, "postcode": { "title": "Postcode", "type": "string", "description": "Four digit postcode. The URL needs suburb, state and postcode together.", "default": "2000" }, "suburbs": { "title": "Several suburbs", "type": "array", "description": "API only: array of 'Suburb, STATE, POSTCODE' entries. One search per entry. Leave empty to use suburb, state, postcode.", "items": { "type": "string" }, "default": [] }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Keep only these printed types, e.g. House, Apartment / Unit / Flat, Townhouse.", "items": { "type": "string", "enum": [ "House", "Apartment / Unit / Flat", "Townhouse", "Villa", "Land", "Acreage", "Rural", "New Apartments / Off the Plan" ] } }, "minPrice": { "title": "Minimum price (AUD)", "type": "integer", "description": "Keep rows priced at or above this number. Rows with no printed price are kept." }, "maxPrice": { "title": "Maximum price (AUD)", "type": "integer", "description": "Keep rows priced at or below this number." }, "minBeds": { "title": "Minimum bedrooms", "type": "integer", "description": "Keep rows with at least this many bedrooms." }, "minDaysOnMarket": { "title": "Minimum days on market", "type": "integer", "description": "Keep only listings listed at least this many days ago. When a fresh suburb has nothing that old, the actor logs a warning and returns the full list sorted by daysOnMarket instead of an empty dataset.", "default": 0 }, "maxItems": { "title": "Max rows", "type": "integer", "description": "Hard cap on rows shipped in one run. Free plan stops at 50.", "default": 20 }, "maxPages": { "title": "Max pages", "type": "integer", "description": "Result pages to read, 20 cards each.", "default": 1 }, "includeDetails": { "title": "Open detail pages", "type": "boolean", "description": "Adds school catchments, suburb medians, description, photos and agent phone. Billed per detail row, including rows reused.", "default": false }, "maxDetails": { "title": "Max detail pages", "type": "integer", "description": "Cap on detail pages opened in one run.", "default": 50 }, "onlyEmitChanges": { "title": "Only changed rows", "type": "boolean", "description": "Emit only new, repriced or removed rows. Changes mode only emits changed rows; in daily mode every emitted row is billed.", "default": false }, "startUrls": { "title": "Start URLs", "type": "string", "description": "Paste domain.com.au search URLs, separated by a comma or a new line, to bypass the suburb form." }, "stateKey": { "title": "State key", "type": "string", "description": "Separate lifecycle state for this input. Two customers can share the central detail reuse and still keep their own history.", "default": "default" }, "max_sources": { "title": "Max sources", "type": "integer", "description": "Run only the first N sources (0 = all).", "default": 0 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }