{ "openapi": "3.0.1", "info": { "title": "Property24 Scraper - Properties, Prices, Agents & Listings", "description": "From $1/1K. Extract structured property listings from Property24, South Africa’s largest property portal. Search by location or use Property24 URLs. Get 50+ fields including price, beds, baths, sizes, GPS coordinates, photos, property details, and agent/agency information.", "version": "1.0", "x-build-id": "87rgwDNphNh363sge" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abotapi~property24-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abotapi-property24-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~property24-scraper/runs": { "post": { "operationId": "runs-sync-abotapi-property24-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~property24-scraper/run-sync": { "post": { "operationId": "run-sync-abotapi-property24-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": "Search Mode", "enum": [ "search", "url" ], "type": "string", "description": "How to find listings. 'Search by Location' builds Property24 search URLs from the fields below. 'Direct URLs' scrapes the Property24 search or listing URLs you paste.", "default": "search" }, "listingType": { "title": "Listing Type", "enum": [ "for-sale", "to-rent", "commercial-for-sale", "commercial-to-rent" ], "type": "string", "description": "Which Property24 vertical to search (Search mode only). Buy and Rent are residential; the two Commercial options search Property24's separate commercial-property vertical.", "default": "for-sale" }, "locations": { "title": "Locations", "type": "array", "description": "Place names to search (Search mode only). Type a suburb, city or province, e.g. 'Cape Town', 'Sandton', 'Western Cape', 'Umhlanga'. Each name is resolved to the matching Property24 area automatically. Multiple locations supported.", "items": { "type": "string" } }, "propertyType": { "title": "Property Type", "enum": [ "any", "house", "apartment", "townhouse", "vacant-land", "farm", "commercial", "industrial" ], "type": "string", "description": "Narrow to one property type (Search mode only). Applied to results.", "default": "any" }, "minPrice": { "title": "Min Price (ZAR)", "minimum": 0, "type": "integer", "description": "Minimum price in Rand (Search mode only). Applied both in the search URL and to results." }, "maxPrice": { "title": "Max Price (ZAR)", "minimum": 0, "type": "integer", "description": "Maximum price in Rand (Search mode only). Applied both in the search URL and to results." }, "minBedrooms": { "title": "Min Bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum number of bedrooms (Search mode only). Applied both in the search URL and to results." }, "maxBedrooms": { "title": "Max Bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Maximum number of bedrooms (Search mode only). Applied to results." }, "sortBy": { "title": "Sort By", "enum": [ "default", "newest", "price-asc", "price-desc", "size" ], "type": "string", "description": "Result ordering (Search mode only).", "default": "default" }, "onShowOnly": { "title": "On Show Only", "type": "boolean", "description": "Only listings with a scheduled show day (Search mode only).", "default": false }, "auctionsOnly": { "title": "Auctions Only", "type": "boolean", "description": "Only properties going to auction (Search mode only).", "default": false }, "minBathrooms": { "title": "Min Bathrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum number of bathrooms (Search mode only). Applied in the search URL and to results." }, "parkingSpaces": { "title": "Min Parking Spaces", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum parking spaces or garages (Search mode only)." }, "minErfSize": { "title": "Min Erf Size (m²)", "minimum": 0, "type": "integer", "description": "Minimum erf (land) size in square metres (Search mode only)." }, "minFloorSize": { "title": "Min Floor Size (m²)", "minimum": 0, "type": "integer", "description": "Minimum floor size in square metres (Search mode only)." }, "hasPool": { "title": "Has Pool", "type": "boolean", "description": "Only listings with a swimming pool (Search mode only).", "default": false }, "hasGarden": { "title": "Has Garden", "type": "boolean", "description": "Only listings with a garden (Search mode only).", "default": false }, "hasFlatlet": { "title": "Has Flatlet", "type": "boolean", "description": "Only listings with a flatlet / granny flat (Search mode only).", "default": false }, "petFriendly": { "title": "Pet Friendly", "type": "boolean", "description": "Only pet-friendly listings (Search mode only).", "default": false }, "securityEstate": { "title": "In Security Estate", "type": "boolean", "description": "Only listings inside a security estate (Search mode only).", "default": false }, "repossessed": { "title": "Repossessed Only", "type": "boolean", "description": "Only bank-repossessed properties (Search mode only).", "default": false }, "retirement": { "title": "Retirement Only", "type": "boolean", "description": "Only retirement listings (Search mode only).", "default": false }, "urls": { "title": "Property24 URLs", "type": "array", "description": "Property24 search-result or single-listing URLs to scrape (URL mode only). Supported: for-sale, to-rent and commercial searches (city, suburb, province, /pN pages, ?sp= filters and sorting), single listings, and the m.property24.com host. New-development, estate-agent and estate-agency pages are skipped with a warning. Filter fields are ignored in this mode. Search pagination starts at the page in the URL and walks forward.", "default": [ "https://www.property24.com/for-sale/cape-town/western-cape/432", "https://www.property24.com/for-sale/cape-town/western-cape/432/p2", "https://www.property24.com/for-sale/cape-town/western-cape/432?sp=pf%3D1000000%26pt%3D3000000%26so%3DPriceLow", "https://www.property24.com/to-rent/sandton/gauteng/109", "https://www.property24.com/commercial-property-for-sale/cape-town/western-cape/432", "https://www.property24.com/commercial-property-to-rent/sandton/gauteng/109", "https://www.property24.com/for-sale/gardens/cape-town/western-cape/9145", "https://www.property24.com/for-sale/western-cape/9", "https://www.property24.com/for-sale/somerset-west-rural/somerset-west/western-cape/17468/117643707", "https://www.property24.com/new-developments-for-sale/cape-town/western-cape/432", "https://www.property24.com/new-developments-for-sale/woodstock/cape-town/western-cape/1-on-albert/10164/3161", "https://www.property24.com/estate-agents/matterhorn-properties/ronnie-du-toit/511147", "https://www.property24.com/estate-agencies/cape-town/western-cape/432", "https://m.property24.com/for-sale/cape-town/western-cape/432" ], "items": { "type": "string" } }, "startUrls": { "title": "Start URLs (alias of Property24 URLs)", "type": "array", "description": "Alias of Property24 URLs. When filled it replaces Property24 URLs and switches the run to URL mode.", "items": { "type": "string" } }, "fetchDetails": { "title": "Fetch Detail Pages", "type": "boolean", "description": "Open each listing to add GPS coordinates, full description, all photos, agent and agency details, the full property overview (erf and floor size, rooms, features, security), and points of interest. Turn off for a faster, cheaper run with search-result fields only.", "default": true }, "maxPages": { "title": "Max Pages Per Search", "minimum": 0, "type": "integer", "description": "Optional bound on result pages walked per search (about 45 listings per page). Leave empty to walk every result page; the run size is controlled by Max Listings, which this field defers to." }, "maxListings": { "title": "Max Listings", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "THE run cap: maximum listings to return across all searches. Default 20. Set 0 for unlimited. For large pulls, add many locations or price bands; a single Property24 search exposes a finite number of pages.", "default": 20 }, "maxItems": { "title": "Max items (alias of Max Listings)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Alias of Max Listings. When filled it replaces Max Listings. 0 means unlimited." }, "proxy": { "title": "Proxy Configuration", "type": "object", "description": "Residential proxy is required for reliable results. Property24 rejects most Datacenter connections (especially on listing detail pages), so Datacenter is not recommended. The actor rotates Residential exits across countries (South Africa first) and uses a backup pool when needed. Residential proxy needs a paid Apify plan." }, "resumeFromRunId": { "title": "Resume from a previous run (delta)", "type": "string", "description": "Optional. ID of a previous run of this actor (or a dataset ID). Listings already in that dataset are skipped, so this run returns only NEW listings (a delta). Combine both runs' datasets for the full set. Max Listings then counts only the new listings." }, "incrementalMode": { "title": "Incremental mode (track changes between runs)", "type": "boolean", "description": "Remember the listings from earlier runs of the same search and label every row as NEW, UPDATED, REAPPEARED or EXPIRED. Listings that did not change are not returned and not charged. Leave off for a plain scrape. A run that stops at Max Listings, a page limit or a failed page never marks anything EXPIRED.", "default": false }, "stateKey": { "title": "State key (optional)", "type": "string", "description": "Name of the saved baseline. Leave empty to derive it from your search settings, so the same search always continues the same baseline. Set it to share or separate baselines on purpose." }, "emitUnchanged": { "title": "Also return unchanged listings", "type": "boolean", "description": "Return listings that did not change, labelled UNCHANGED. They are never charged. Only applies when Incremental mode is on.", "default": false }, "emitExpired": { "title": "Return listings that disappeared", "type": "boolean", "description": "Return one EXPIRED row for each listing that was in the baseline but is gone from a complete scan. EXPIRED rows are never charged. Only applies when Incremental mode is on.", "default": false }, "ignoreFieldsForChanges": { "title": "Ignore fields when detecting changes (incremental mode only)", "type": "array", "description": "Top-level field names that must not make a listing count as UPDATED (for example photoCount). The scrape time is always ignored. Only applies when Incremental mode is on.", "items": { "type": "string" } }, "mcpConnectors": { "title": "Pipe results into your apps (optional)", "type": "array", "description": "Optionally send the scraped results into the apps you already use, via Model Context Protocol (MCP) connectors. Authorize a connector once under Apify → Settings → Integrations, then select it here. The connector receives a condensed, human-readable summary per item (title + key fields), not the full JSON — the complete record stays in the dataset. Leave empty to skip. 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 item pages are created. Required to enable the Notion export; 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 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 } } } } } } } } } }