{ "openapi": "3.0.1", "info": { "title": "Property24 $1💰 URL Search | Keyword Filtering | Rich Output", "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": "C4rEf1HRWnnDrwJac" }, "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" ], "type": "string", "description": "Buy or rent (Search mode only).", "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 }, "urls": { "title": "Property24 URLs", "type": "array", "description": "Property24 search-result or single-listing URLs to scrape (URL mode only). Multi-URL supported. Filter fields are ignored in this mode. For search URLs, pagination starts at the page in the URL and walks forward.", "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 }, "maxConcurrency": { "title": "Detail Concurrency", "minimum": 1, "maximum": 12, "type": "integer", "description": "Parallel detail-page fetches when Fetch Detail Pages is on. Higher is faster but puts more load on the proxy. 1 to 12.", "default": 6 }, "maxPages": { "title": "Max Pages Per Search", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum result pages to paginate per search (about 45 listings per page). Lower it for quick test runs.", "default": 1 }, "maxListings": { "title": "Max Listings", "minimum": 0, "type": "integer", "description": "Maximum listings to return across all searches. Set 0 for unlimited (the default). For large pulls, add many locations or price bands; a single Property24 search exposes a finite number of pages.", "default": 0 }, "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." } } }, "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 } } } } } } } } } }