{ "openapi": "3.0.1", "info": { "title": "REIWA AU – WA Property, Agents, Commercial & Insights", "description": "Collect Western Australia real estate data from REIWA.com.au across sale, rental, sold, agent, commercial, business, rural, and insights sections. Search by filters or scrape URLs, including result pages, listings, agents, agencies, and insight articles. Returns clean, structured records.", "version": "0.1", "x-build-id": "xjXRUAetbTrhNYVrH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abotapi~reiwa-com-au-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abotapi-reiwa-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/abotapi~reiwa-com-au-scraper/runs": { "post": { "operationId": "runs-sync-abotapi-reiwa-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/abotapi~reiwa-com-au-scraper/run-sync": { "post": { "operationId": "run-sync-abotapi-reiwa-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "url" ], "type": "string", "description": "search builds REIWA result pages from the fields below. url uses the REIWA URLs you paste.", "default": "search" }, "channel": { "title": "REIWA section", "enum": [ "for-sale", "for-rent", "sold", "agents", "commercial-sale", "commercial-lease", "business", "rural", "insights" ], "type": "string", "description": "Choose the result type for search mode. URL mode detects the section from each URL.", "default": "for-sale" }, "locations": { "title": "Suburbs or regions", "type": "array", "description": "Search locations such as perth, perth~region, baldivis, or south-west~region. One search runs per location. Leave empty for all available results where the selected section supports it.", "default": [ "perth~region" ], "items": { "type": "string" } }, "sortBy": { "title": "Sort order", "enum": [ "default", "date-desc", "date-asc", "price-asc", "price-desc" ], "type": "string", "description": "Ordering for result pages that support sorting.", "default": "default" }, "urls": { "title": "REIWA URLs", "type": "array", "description": "Only used when mode = url. Paste search/list pages, individual listings, agent profiles, agency profiles, or insight articles. Multiple URLs are supported.", "items": { "type": "string" } }, "keywords": { "title": "Keywords", "type": "string", "description": "Optional text matched against returned titles, addresses, agencies, descriptions, or article summaries. Applies to search and URL modes.", "default": "" }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Optional listing type filters for listing sections. Applies to search and URL modes when supported by the source URL; has no effect when the section is rural.", "items": { "type": "string", "enum": [ "houses", "apartments", "units", "villas", "townhouses", "land", "rural" ], "enumTitles": [ "Houses", "Apartments", "Units", "Villas", "Townhouses", "Land", "Rural" ] }, "default": [] }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Optional minimum price. For rentals this is weekly rent." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Optional maximum price. For rentals this is weekly rent." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "type": "integer", "description": "Optional minimum bedrooms." }, "fetchDetails": { "title": "Fetch details", "type": "boolean", "description": "Adds full descriptions, extra photos, page metadata, and richer contact/profile fields when available. Billed as a detail-enrichment surcharge.", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard cap across the whole run. The actor stops once this many rows are saved.", "default": 20 }, "maxPages": { "title": "Max pages per search", "minimum": 0, "type": "integer", "description": "Optional bound on result pages walked per search/URL. Leave empty to walk every result page. Use Max items as the primary cap." }, "resumeFromRunId": { "title": "Resume from run ID", "type": "string", "description": "Optional: paste a previous run ID (or dataset ID) from this actor. Rows already collected there are skipped, so this run only returns new ones. Leave empty for a normal run." }, "proxy": { "title": "Proxy", "type": "object", "description": "Keep Apify Proxy enabled for stable runs. Use a country setting only if you need a specific geography.", "default": { "useApifyProxy": true } }, "mcpConnectors": { "title": "Pipe results into your apps", "type": "array", "description": "Send the scraped results into apps you already use, via Model Context Protocol (MCP) connectors. Authorize a connector once under Apify Settings, then select it here. The complete record stays in the dataset. Supported: Notion (https://mcp.notion.com/mcp), Linear (https://mcp.linear.app/sse), Airtable (https://mcp.airtable.com/mcp), Apify (https://mcp.apify.com)." }, "notionParentPageUrl": { "title": "Notion parent page", "type": "string", "description": "URL or id of the Notion page under which item pages are created. Required for Notion export and ignored by other connectors." }, "maxNotifyListings": { "title": "Max items to export per connector", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap on items written to each selected connector per run. Does not affect the dataset.", "default": 50 } } }, "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 } } } } } } } } } }