{ "openapi": "3.0.1", "info": { "title": "Property Finder Scraper", "description": "Scrape Property Finder listings across the UAE, Saudi Arabia, Qatar, Bahrain & Egypt — price, location, GPS, beds, size, photos, agent phone & WhatsApp, RERA permit and amenities as structured JSON. Built for investors, agencies and PropTech. Pay only for the results you get.", "version": "1.0", "x-build-id": "YtILvW7bIxqMPXrbI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axlymxp~propertyfinder-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axlymxp-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/axlymxp~propertyfinder-scraper/runs": { "post": { "operationId": "runs-sync-axlymxp-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/axlymxp~propertyfinder-scraper/run-sync": { "post": { "operationId": "run-sync-axlymxp-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", "properties": { "country": { "title": "Country", "enum": [ "ae", "sa", "qa", "bh", "eg", "lb" ], "type": "string", "description": "Which Property Finder market to scrape.", "default": "ae" }, "category": { "title": "Listing category", "enum": [ "sale", "rent", "commercial_sale", "commercial_rent", "new_projects" ], "type": "string", "description": "Buy/sale, rent, commercial, or new projects.", "default": "sale" }, "location": { "title": "Location name", "type": "string", "description": "A place name to auto-resolve (e.g. 'Dubai Marina', 'Riyadh', 'Business Bay'). Leave empty to scrape the whole country or use Location IDs / Listing URLs." }, "locationIds": { "title": "Location IDs (advanced)", "type": "array", "description": "Optional. Exact Property Finder location IDs (e.g. 50 = Dubai Marina). Overrides 'Location name' when set.", "items": { "type": "string" } }, "listingUrls": { "title": "Listing URLs (direct mode)", "type": "array", "description": "Optional. Direct property page links (share URLs like https://www.propertyfinder.ae/en/plp/...-.html) or bare property IDs to scrape specific listings instead of searching.", "items": { "type": "string" } }, "propertyType": { "title": "Property type", "enum": [ "apartment", "villa", "townhouse", "penthouse", "compound", "duplex", "full_floor", "half_floor", "whole_building", "land", "bungalow", "hotel_apartment" ], "type": "string", "description": "Filter by property type. Leave empty for all types." }, "minPrice": { "title": "Minimum price", "type": "integer", "description": "Optional minimum price in the market's local currency (AED, SAR, QAR, ...)." }, "maxPrice": { "title": "Maximum price", "type": "integer", "description": "Optional maximum price." }, "bedrooms": { "title": "Bedrooms", "type": "array", "description": "Optional bedroom counts to include (0 = studio, up to 8 = 7+). Repeat for multiple, e.g. 2 and 3.", "items": { "type": "string" } }, "bathrooms": { "title": "Bathrooms", "type": "array", "description": "Optional bathroom counts to include.", "items": { "type": "string" } }, "minArea": { "title": "Minimum area (sqft)", "type": "integer", "description": "Optional minimum built-up area in square feet." }, "maxArea": { "title": "Maximum area (sqft)", "type": "integer", "description": "Optional maximum built-up area in square feet." }, "furnished": { "title": "Furnishing", "enum": [ "all", "yes", "no", "partly" ], "type": "string", "description": "Optional furnishing filter." }, "completionStatus": { "title": "Completion status", "enum": [ "completed", "off_plan" ], "type": "string", "description": "Optional. Filter completed vs off-plan properties." }, "priceType": { "title": "Rent period", "enum": [ "daily", "weekly", "monthly", "yearly" ], "type": "string", "description": "Optional — only for rentals. Filter by rent period." }, "keywords": { "title": "Keywords", "type": "string", "description": "Optional free-text keywords (e.g. 'sea view', 'maid room'). Comma-separated for multiple." }, "sort": { "title": "Sort order", "enum": [ "featured", "newest", "price_asc", "price_desc", "beds_asc", "beds_desc", "distance_asc", "delivery_date_asc", "delivery_date_desc" ], "type": "string", "description": "Result ordering.", "default": "featured" }, "scrapeMode": { "title": "Scrape mode", "enum": [ "full", "fast" ], "type": "string", "description": "'full' enriches each listing with its detail page (description, amenities, RERA/permit, floor plans, agent contacts). 'fast' returns only search-result fields (still includes price, location, GPS, agent phone/WhatsApp) — cheaper and quicker.", "default": "full" }, "includeTransactions": { "title": "Include price transactions", "type": "boolean", "description": "Attach comparable/nearby price transaction history to each listing (full mode only). Adds detail but larger rows.", "default": false }, "maxItems": { "title": "Max listings", "minimum": 1, "type": "integer", "description": "Stop after collecting this many listings.", "default": 100 }, "locale": { "title": "Language", "type": "string", "description": "Language for localized text (e.g. en, ar).", "default": "en" } } }, "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 } } } } } } } } } }