{ "openapi": "3.0.1", "info": { "title": "Commercial Property AU Scraper - Listings & Agents", "description": "Scrape Australian commercial property listings with full detail data. Extract descriptions, highlights, property attributes, GPS coordinates, nearby places, agents, agencies, images and rich listing metadata.", "version": "2.0", "x-build-id": "NvcbHf789oOIUGNFk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abotapi~realcommercial-au-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abotapi-realcommercial-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~realcommercial-au-scraper/runs": { "post": { "operationId": "runs-sync-abotapi-realcommercial-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~realcommercial-au-scraper/run-sync": { "post": { "operationId": "run-sync-abotapi-realcommercial-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": "1. Search mode", "enum": [ "location", "url" ], "type": "string", "description": "Location mode = pick suburb + state + filters below. URL mode = paste any commercial property search URL already refined in a browser (recommended for complex filters or multi-suburb queries).", "default": "location" }, "locations": { "title": "Locations to search (Location mode)", "type": "array", "description": "Locations to search. State is required. Suburb and postcode are optional.", "items": { "type": "object", "properties": { "suburb": { "title": "Suburb (Optional)", "type": "string", "description": "Suburb or city name, e.g. Melbourne, Sydney CBD. 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. 3000", "editor": "textfield", "pattern": "^[0-9]{4}$" }, "region": { "title": "Region (Optional)", "type": "string", "description": "Region name, e.g. brisbane-greater-region", "editor": "textfield" } }, "required": [ "state" ] } }, "listingType": { "title": "Listing Type (Location mode)", "enum": [ "for-sale", "for-lease", "sold", "leased" ], "type": "string", "description": "Type of property listings to scrape. Location mode only.", "default": "for-sale" }, "propertyTypes": { "title": "Property Types", "type": "array", "description": "Filter by property type (leave empty for all). Only applies in location mode.", "items": { "type": "string", "enum": [ "industrial-warehouse", "retail", "offices", "land-development", "showrooms-bulky-goods", "hotel-motel-leisure", "medical-consulting", "commercial-farming", "other" ], "enumTitles": [ "Warehouse, Factory & Industrial", "Shops & Retail", "Offices", "Development Sites & Land", "Showrooms & Large Format Retail", "Hotel, Motel & Leisure", "Medical & Consulting", "Commercial Farming & Rural", "Other" ] } }, "sortBy": { "title": "Sort Order", "enum": [ "featured", "date-desc", "date-asc", "price-desc", "price-asc" ], "type": "string", "description": "Sort order for search results. Only applies in location mode.", "default": "date-desc" }, "priceMin": { "title": "Minimum Price", "minimum": 0, "type": "integer", "description": "Minimum property price (AUD). Only applies in location mode." }, "priceMax": { "title": "Maximum Price", "minimum": 0, "type": "integer", "description": "Maximum property price (AUD). Only applies in location mode." }, "areaMin": { "title": "Minimum Area (m²)", "minimum": 0, "type": "integer", "description": "Minimum floor/land area in square metres. Only applies in location mode." }, "areaMax": { "title": "Maximum Area (m²)", "minimum": 0, "type": "integer", "description": "Maximum floor/land area in square metres. Only applies in location mode." }, "landAreaMin": { "title": "Minimum Land Area (m²)", "minimum": 0, "type": "integer", "description": "Minimum land (site) area in square metres, separate from floor area. Only applies in location mode." }, "landAreaMax": { "title": "Maximum Land Area (m²)", "minimum": 0, "type": "integer", "description": "Maximum land (site) area in square metres. Only applies in location mode." }, "tenure": { "title": "Tenure", "enum": [ "vacant-possession", "tenanted-investment" ], "type": "string", "description": "Only vacant-possession or only tenanted-investment listings (leave empty for both). Only applies in location mode." }, "keywords": { "title": "Keywords", "type": "string", "description": "Keywords to search (e.g. co-working, warehouse). Only applies in location mode." }, "urls": { "title": "Search URLs (URL mode)", "type": "array", "description": "Search result page URLs to scrape (for-sale, for-lease, sold or leased searches, with or without a property type, location path or ?locations= query). A single property page link is skipped with a warning. The ?page=N query param sets the starting page; pagination then continues forward up to Maximum Pages. Tip: open the site, apply your filters, then paste the resulting URL here. In URL mode, all the filter fields above are ignored. Leaving this untouched scrapes the two example searches.", "default": [ "https://www.realcommercial.com.au/for-lease/in-melbourne,+vic+3000/", "https://www.realcommercial.com.au/for-sale/offices/?locations=in-sydney,nsw" ], "items": { "type": "string" } }, "maxListings": { "title": "Maximum Listings", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Stop after scraping this many listings. Set to 0 for the maximum of 1,000,000.", "default": 20 }, "maxPages": { "title": "Maximum Pages per Location", "minimum": 0, "type": "integer", "description": "Maximum search result pages to process per location. Each page has ~25 results. Set to 0 (default) for no limit; a hard cap of 100 pages per location always applies.", "default": 0 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Configure proxy." }, "resumeFromRunId": { "title": "Resume from a previous run", "type": "string", "description": "Paste a previous run ID or dataset ID to continue a large crawl of listings without returning or charging for listings already collected there. Use this after an interrupted run, or when continuing a listing catalogue pull in another run. For recurring daily monitoring of the same search, use Incremental mode below instead." }, "incrementalMode": { "title": "Incremental changes for scheduled runs", "type": "boolean", "description": "Turn this on for daily or recurring monitoring. The first run returns all matching listings as NEW. Later runs normally return only NEW, UPDATED, and REAPPEARED listings. A listing is UPDATED when any of its fields changes (price, status, area, description, agents added or removed, images and so on); changedFields lists which. Never compared: scrapedAt and lastUpdatedAt, the order agents are listed in, and anything you add under Ignore fields when detecting changes. Those stay in the output. Turn on \"Emit unchanged\" or \"Emit expired\" only when you also want those listings returned (and billed). State is kept separately for each mode/location/URL and filter setup; use State key when you want to name or deliberately share a monitoring campaign. To continue one specific interrupted run instead, use Resume from a previous run above.", "default": false }, "stateKey": { "title": "State key (optional, incremental mode only)", "type": "string", "description": "Optional. Name this monitoring campaign to keep its state stable, or to deliberately share state across differently-configured runs. Leave empty to let the actor derive a key automatically from the mode/locations/URLs and filters — different searches then never mix state with each other." }, "emitUnchanged": { "title": "Emit unchanged listings (incremental mode only)", "type": "boolean", "description": "Off by default. Turn on to also return listings that have not changed since the last run, marked UNCHANGED. This returns — and bills — extra rows you already have, so leave it off unless you specifically want the full snapshot every run.", "default": false }, "emitExpired": { "title": "Emit expired listings (incremental mode only)", "type": "boolean", "description": "Off by default. Turn on to also return listings that were present in a previous run but are no longer found, marked EXPIRED. Only produced once a run has fully scanned the tracked search — not when Max listings/Max pages capped it when Resume was used, or when a pasted URL started at page 2 or later. This returns — and bills — extra synthetic rows, so leave it off unless you need expiry tracking.", "default": false }, "ignoreFieldsForChanges": { "title": "Ignore fields when detecting changes (incremental mode only)", "type": "array", "description": "Field names that must not make a listing count as UPDATED, one per entry. Use dots for nested fields, for example agents.phone or price.display. Arrays are searched automatically. Ignored fields stay in the output; they are only left out of the comparison and out of changedFields. Changing this list does not cause a one-time wave of UPDATED rows. Incremental mode only.", "default": [], "items": { "type": "string" } }, "mcpConnectors": { "title": "Pipe results into your apps (optional)", "type": "array", "description": "Optionally send the scraped listings into the apps you already use, via Model Context Protocol (MCP) connectors. Authorize a connector once under Apify → Settings → API & Integrations, then select it here. Notion gets a rich page-per-listing export; other connectors receive a best-effort write/digest. Leave empty to skip — this never changes the dataset output. 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 (Notion connector only)", "type": "string", "description": "URL (or id) of the Notion page under which listing pages are created. Required to enable the Notion export; ignored by other connectors." }, "maxNotifyListings": { "title": "Max listings to export per connector", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap on how many listings are 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 }, "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 } } } } } } } } } }