{ "openapi": "3.0.1", "info": { "title": "Property24 Price-Drop & New Listing Monitor", "description": "Monitor Property24 (South Africa) on a schedule and get ONLY what changed since the last run: new listings, price drops and price increases. Runs inside Apify Schedules, n8n, Make or Zapier — quiet runs return nothing, so it is cheap to watch a search 24/7 for buyers, agents and property alerts.", "version": "1.0", "x-build-id": "xTh1J3uKNIf6xp1Gn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hipersoft~property24-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hipersoft-property24-monitor", "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/hipersoft~property24-monitor/runs": { "post": { "operationId": "runs-sync-hipersoft-property24-monitor", "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/hipersoft~property24-monitor/run-sync": { "post": { "operationId": "run-sync-hipersoft-property24-monitor", "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": { "startUrls": { "title": "Start URLs (searches to watch)", "type": "array", "description": "Optional. One or more Property24 search/result page URLs to monitor (e.g. a for-sale or to-rent results page for a city, suburb or filtered search). Paste the URL straight from your browser. When set, this overrides the Intent and Location path fields. Each run checks these searches and reports only what changed since the previous run.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "intent": { "title": "Listing intent", "enum": [ "for-sale", "to-rent" ], "type": "string", "description": "Watch properties for sale or to rent. Used together with the Location path when no Start URLs are provided.", "default": "for-sale" }, "locationUrlPath": { "title": "Location path", "type": "string", "description": "The Property24 location path to watch, in the form 'city/province/areaId' — for example 'cape-town/western-cape/432' or 'johannesburg/gauteng/95'. Copy it straight out of a Property24 results URL (the part after /for-sale/ or /to-rent/). Ignored when Start URLs are set." }, "maxItems": { "title": "Max listings to check per run", "minimum": 0, "type": "integer", "description": "How many listings from the top of the search to check each run (0 = no limit). The newest listings appear first, so 200 comfortably covers new arrivals and recent price changes for most searches. Delisted-listing detection is only reported when this cap is not reached.", "default": 200 }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Optional label for this monitor. Each named monitor keeps its own separate memory of what it has already seen, so you can run several different searches side by side without them interfering. Leave blank to derive it automatically from the search." }, "emitBaselineOnFirstRun": { "title": "Emit all listings on the first run", "type": "boolean", "description": "By default the very first run silently records the current listings as a baseline and returns nothing, so a fresh schedule does not dump the whole search at you. Turn this on to instead output every current listing as 'new' on that first run.", "default": false }, "detectPriceIncrease": { "title": "Report price increases", "type": "boolean", "description": "Report listings whose asking price went up since the last run, not just price drops.", "default": true }, "detectRemovals": { "title": "Report delisted listings", "type": "boolean", "description": "Report listings that were present before but have now disappeared from the search (sold, withdrawn or expired). Only reported when the whole search fits within 'Max listings to check per run'.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. This monitor runs fine without a proxy and none is used by default." } } }, "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 } } } } } } } } } }