{ "openapi": "3.0.1", "info": { "title": "Property24 Scraper - SA Property Listings & Agent Data", "description": "Scrape Property24 SA real estate: for-sale, to-rent, sold properties with price, beds, baths, floor size, location, agent data. SA property data, market research and lead gen.", "version": "1.0", "x-build-id": "OdAjxl9GbsfKfTX1q" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/haketa~property24-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-haketa-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/haketa~property24-scraper/runs": { "post": { "operationId": "runs-sync-haketa-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/haketa~property24-scraper/run-sync": { "post": { "operationId": "run-sync-haketa-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", "properties": { "listingType": { "title": "Listing type", "enum": [ "for-sale", "to-rent", "sold" ], "type": "string", "description": "Choose which kind of property listings you want to collect.", "default": "for-sale" }, "locations": { "title": "Locations", "type": "array", "description": "Pick one or more South African provinces, cities or suburbs to search. Leave empty to get a broad nationwide sample across the biggest metros.", "items": { "type": "string", "enum": [ "gauteng", "western-cape", "kwazulu-natal", "eastern-cape", "free-state", "limpopo", "mpumalanga", "north-west", "northern-cape", "cape-town", "johannesburg", "pretoria", "durban", "port-elizabeth", "bloemfontein", "east-london", "polokwane", "nelspruit", "sandton", "alberton", "centurion", "midrand", "roodepoort", "kibler-park", "umhlanga", "stellenbosch", "somerset-west", "paarl", "george", "krugersdorp", "randburg" ], "enumTitles": [ "Gauteng (province)", "Western Cape (province)", "KwaZulu-Natal (province)", "Eastern Cape (province)", "Free State (province)", "Limpopo (province)", "Mpumalanga (province)", "North West (province)", "Northern Cape (province)", "Cape Town", "Johannesburg", "Pretoria", "Durban", "Port Elizabeth (Gqeberha)", "Bloemfontein", "East London", "Polokwane", "Nelspruit (Mbombela)", "Sandton", "Alberton", "Centurion", "Midrand", "Roodepoort", "Kibler Park", "Umhlanga", "Stellenbosch", "Somerset West", "Paarl", "George", "Krugersdorp", "Randburg" ] } }, "maxItems": { "title": "Max properties", "minimum": 0, "maximum": 50000, "type": "integer", "description": "Maximum number of properties to collect across all selected locations. Use 0 for no limit.", "default": 0 }, "includeDetails": { "title": "Include property details", "type": "boolean", "description": "Reserved for future full-detail enrichment. Leave off for the fast listing scrape.", "default": false }, "startUrls": { "title": "Start URLs (advanced, optional)", "type": "array", "description": "Power users only: paste specific Property24 search result URLs to scrape exactly those pages. Most users can ignore this and just pick locations above.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy is recommended for larger runs to keep collection fast and reliable. The default Apify proxy works well.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }