{ "openapi": "3.0.1", "info": { "title": "๐Ÿ  PropertyFinder Scraper", "description": "๐Ÿ  PropertyFinder Scraper extracts real estate listings with key details from Property Finder. ๐Ÿš€ Automate lead research, market insights & data enrichment with fast, scalable scraping. ๐Ÿ“ˆ Ideal for agencies, analysts & builders.", "version": "0.1", "x-build-id": "zvvwcOgecw7BfocXB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/simpleapi~propertyfinder-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-simpleapi-propertyfinder-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/simpleapi~propertyfinder-scraper/runs": { "post": { "operationId": "runs-sync-simpleapi-propertyfinder-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/simpleapi~propertyfinder-scraper/run-sync": { "post": { "operationId": "run-sync-simpleapi-propertyfinder-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": [ "listUrls" ], "properties": { "listUrls": { "title": "๐Ÿ”— PropertyFinder Search / Listing URLs", "type": "array", "description": "Paste any PropertyFinder **sale or rent** search-result URLs (each lists many properties). Supports bulk input โ€” add as many as you like. Works for .ae, .qa, .bh, .eg, .sa domains. Example: a Dubai villas-for-sale search page.", "items": { "type": "string" } }, "threads": { "title": "โšก Parallel Threads", "enum": [ "1", "2", "3", "4", "5" ], "type": "string", "description": "How many result pages to fetch in parallel. Higher = faster, but heavier on the target. 2โ€“3 is a safe sweet spot.", "default": "2" }, "monitoringMode": { "title": "๐Ÿ†• Monitoring Mode โ€” only newly listed properties", "type": "boolean", "description": "When ON, only properties that are **new** compared to previous runs are scraped (uses a key-value store to remember what was seen). Great for daily change tracking. Turn OFF for a full scrape.", "default": false }, "retrieveUnitNumber": { "title": "๐Ÿข Retrieve Unit Number (Additional Usage)", "type": "boolean", "description": "Resolve the building unit number via an external Unit Finder service. When OFF, `unitNumber` stays null.", "default": false }, "enableDelistingTracker": { "title": "๐Ÿ“‰ Enable Delisting Tracker (Additional Usage)", "type": "boolean", "description": "Track every property with first-seen/last-seen dates in a key-value store, so you can detect which listings get delisted across runs. โš ๏ธ Scrape the SAME URLs each run for meaningful results.", "default": false }, "addEmptyTrackerRecord": { "title": "๐Ÿงพ Add Tracker ID Record in Monitoring Mode (Additional Usage)", "type": "boolean", "description": "In Monitoring Mode, also emit a minimal record for every currently-live property that wasn't output as new โ€” so a custom loader can tell which previously-loaded properties are still live.", "default": false }, "email": { "title": "๐Ÿ“ง Notification Email (optional)", "type": "string", "description": "Optional email you'd like associated with this run (for your own reference / reporting).", "default": "" }, "proxyConfiguration": { "title": "๐ŸŒ Proxy Configuration", "type": "object", "description": "Optional. By default the Actor sends **direct (no-proxy)** requests and only escalates to a **datacenter** proxy, then a **residential** proxy, automatically if PropertyFinder starts blocking. Set a proxy here to force one from the start.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }