{ "openapi": "3.0.1", "info": { "title": "Property Finder Scraper | UAE, Saudi Arabia & More", "description": "Extract Property Finder sale and rental listings across the UAE, Saudi Arabia, Egypt, Bahrain and Qatar. Get prices, locations, agent contacts and photos; pay per delivered listing row plus a start fee.", "version": "0.5", "x-build-id": "Kf0Wg5ctTYXTCxaFb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~property-finder-uae-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-property-finder-uae-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/lentic_clockss~property-finder-uae-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-property-finder-uae-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/lentic_clockss~property-finder-uae-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-property-finder-uae-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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Property Finder search or individual listing URLs from the UAE, Saudi Arabia, Egypt, Bahrain or Qatar; URL searches use the market, channel and property type in the URL. Without any target, the Actor uses the prefilled UAE sale search for an example run of up to 3 rows.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "market": { "title": "Market", "enum": [ "AE", "SA", "EG", "BH", "QA", "all" ], "type": "string", "description": "Choose the country to search, or all for all five supported markets. Ignored when markets is non-empty.", "default": "AE" }, "markets": { "title": "Markets", "type": "array", "description": "Choose several countries for one configured search. A non-empty list overrides market; selected markets share the search row limit.", "items": { "type": "string", "enum": [ "AE", "SA", "EG", "BH", "QA" ] }, "default": [] }, "channel": { "title": "Channel", "enum": [ "BUY", "RENT", "COMMERCIAL_BUY", "COMMERCIAL_RENT" ], "type": "string", "description": "Choose residential sale, residential rent, commercial sale or commercial rent.", "default": "BUY" }, "propertyType": { "title": "Property type", "enum": [ "all", "properties", "apartment", "villa", "townhouse", "penthouse", "compound", "duplex", "full-floor", "half-floor", "whole-building", "land", "bungalow", "hotel-apartment", "bulk-sale-unit", "bulk-rent-unit", "chalet", "twin-house", "farm", "rest-house", "office-space", "retail", "warehouse", "shop", "show-room", "factory", "labor-camp", "staff-accommodation", "business-centre", "co-working-space", "medical-facility", "clinic", "cafeteria", "restaurant", "storage", "ivilla", "cabin", "palace", "roof", "short-term-hotel-apartment", "labor-camp-per-room" ], "type": "string", "description": "Choose a property type, or all/properties for all types in the selected channel. Availability varies by market.", "default": "all" }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Choose several property types. A non-empty list overrides propertyType; selected types share the configured search row limit.", "items": { "type": "string", "enum": [ "all", "apartment", "villa", "townhouse", "penthouse", "compound", "duplex", "full-floor", "half-floor", "whole-building", "land", "bungalow", "hotel-apartment", "office-space", "retail", "warehouse", "shop", "show-room", "factory", "labor-camp", "staff-accommodation", "farm", "chalet" ] }, "default": [] }, "locationId": { "title": "Location ID", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Property Finder location ID from the l parameter in a search URL. For a national search, use a search URL without a location filter in startUrls." }, "locationSlug": { "title": "Location slug", "type": "string", "description": "Recognized city or area slug, such as dubai or abu-dhabi, used when locationId is empty. Leave empty when searching by URL, keywords or IDs instead." }, "locationQuery": { "title": "Location search text", "type": "string", "description": "City or community name, such as dubai marina, used when locationId and locationSlug are empty." }, "sort": { "title": "Sort order", "enum": [ "featured", "newest", "priceAsc", "priceDesc", "bedroomAsc", "bedroomDesc", "distanceAsc", "deliveryDateAsc", "deliveryDateDesc", "caratRankingVariantA", "caratRankingVariantB", "freshnessVariantA", "freshnessDate", "superAgentVariantA", "superAgentVariantB", "superAgentVariantC", "exclusiveBoost", "doubleExclusiveBoost" ], "type": "string", "description": "Choose the result order, such as newest or price from low to high. Options marked not available are not supported by this Actor input; unsupported choices are ignored.", "default": "newest" }, "bedrooms": { "title": "Bedrooms", "type": "array", "description": "Optional bedroom counts to include (e.g. [1, 2]; 0 = studio).", "items": { "type": "integer" }, "default": [] }, "bathrooms": { "title": "Bathrooms", "type": "array", "description": "Optional bathroom counts to include (e.g. [2, 3]).", "items": { "type": "integer" }, "default": [] }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Optional minimum price in the market currency." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Optional maximum price in the market currency." }, "amenities": { "title": "Amenities", "type": "array", "description": "Amenity names accepted by Property Finder, such as pool or gym.", "items": { "type": "string" }, "default": [] }, "isVerified": { "title": "Verified listings only", "type": "boolean", "description": "Set true for verified listings only, false for unverified listings only, or leave empty for either." }, "furnished": { "title": "Furnishing", "enum": [ "all", "yes", "no", "partly" ], "type": "string", "description": "Filter by furnished, unfurnished or partly furnished properties. Choose all or leave empty to apply no furnishing filter." }, "completionStatus": { "title": "Completion status", "enum": [ "completed", "off_plan" ], "type": "string", "description": "Filter for completed or off-plan properties." }, "keywords": { "title": "Keywords", "type": "string", "description": "Text to search for in listings, such as sea view." }, "listedWithin": { "title": "Listed within (days)", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Only include listings added within this number of days." }, "agentId": { "title": "Agent ID", "type": "integer", "description": "Only include listings from this agent ID." }, "agentIds": { "title": "Agent IDs", "type": "array", "description": "Include listings from any of these agent IDs.", "items": { "type": "integer" } }, "brokerId": { "title": "Broker ID", "type": "integer", "description": "Only include listings from this property broker or agency ID." }, "clientIds": { "title": "Client IDs", "type": "array", "description": "Include listings from any of these Property Finder client IDs.", "items": { "type": "integer" } }, "minArea": { "title": "Min area", "type": "integer", "description": "Optional. Minimum property area (unit set by areaUnit)." }, "maxArea": { "title": "Max area", "type": "integer", "description": "Optional. Maximum property area (unit set by areaUnit)." }, "areaUnit": { "title": "Area unit", "type": "string", "description": "Optional. Area unit for minArea/maxArea, e.g. sqft or sqm." }, "paymentMethod": { "title": "Payment method", "type": "string", "description": "Optional. Single payment method, e.g. cash or mortgage." }, "paymentMethods": { "title": "Payment methods", "type": "array", "description": "Optional. Any of these payment methods.", "items": { "type": "string" } }, "nearByLat": { "title": "Near-by latitude", "type": "number", "description": "Centre latitude for a radius filter; also provide nearByLon and a target such as locationId." }, "nearByLon": { "title": "Near-by longitude", "type": "number", "description": "Centre longitude for a radius filter; also provide nearByLat and a target such as locationId." }, "nearByRadius": { "title": "Near-by radius", "type": "number", "description": "Radius value around nearByLat and nearByLon, using the value from your Property Finder search. Leave empty to use the source default." }, "minNumberOfCheques": { "title": "Min number of cheques", "type": "integer", "description": "Optional. Rentals: minimum number of cheques." }, "maxNumberOfCheques": { "title": "Max number of cheques", "type": "integer", "description": "Optional. Rentals: maximum number of cheques." }, "minDownPaymentPrice": { "title": "Min down payment", "type": "integer", "description": "Optional. Minimum down payment in market currency." }, "maxDownPaymentPrice": { "title": "Max down payment", "type": "integer", "description": "Optional. Maximum down payment in market currency." }, "minInstallmentYears": { "title": "Min installment years", "type": "integer", "description": "Optional. Minimum payment-plan length in years." }, "maxInstallmentYears": { "title": "Max installment years", "type": "integer", "description": "Optional. Maximum payment-plan length in years." }, "utilitiesPriceType": { "title": "Utilities price type", "type": "string", "description": "Optional. Utilities pricing type as used by Property Finder." }, "hasPostHandoverPaymentPlan": { "title": "Post-handover payment plan", "type": "boolean", "description": "Optional. Only listings with a post-handover payment plan." }, "virtualViewings": { "title": "Virtual viewings", "type": "string", "description": "Optional. Virtual viewing type, e.g. 360 or video." }, "isDeveloperProperty": { "title": "Developer properties", "type": "boolean", "description": "Optional. Only listings marketed by developers." }, "isSuperAgent": { "title": "SuperAgent listings", "type": "boolean", "description": "Optional. Only listings by SuperAgents." }, "isExactLocation": { "title": "Exact location", "type": "boolean", "description": "Optional. Only listings with an exact map location." }, "newProjects": { "title": "New projects", "type": "boolean", "description": "Optional. Only new-project listings." }, "primaryMarket": { "title": "Primary market", "type": "boolean", "description": "Optional. Only primary-market (first sale) listings." }, "travelTime": { "title": "Travel time (minutes)", "type": "integer", "description": "Travel-time bound in minutes. Set travelTimeOperator to gte for at least this duration or lte for at most; the default comparison is gte." }, "travelTimeOperator": { "title": "Travel time operator", "type": "string", "description": "Comparison for travelTime: gte means at least, and lte means at most." }, "dealBadges": { "title": "Deal badges", "type": "array", "description": "Optional. Any of these deal badge slugs.", "items": { "type": "string" } }, "excludeSpotlight": { "title": "Exclude spotlight", "type": "boolean", "description": "Optional. Exclude spotlight (promoted) listings." }, "fullTextSearchQuery": { "title": "Full-text search", "type": "string", "description": "Optional. Full-text query matched against listings." }, "deliveryDateGte": { "title": "Delivery date from", "type": "string", "description": "Optional. Earliest delivery date, YYYY-MM-DD." }, "deliveryDateLte": { "title": "Delivery date to", "type": "string", "description": "Optional. Latest delivery date, YYYY-MM-DD." }, "boundingBox": { "title": "Bounding box", "type": "array", "description": "Search area as two geohashes: north-west and south-east.", "items": { "type": "string" } }, "polygon": { "title": "Polygon", "type": "array", "description": "Search area as a flat list of coordinate pairs: latitude, longitude, latitude, longitude, and so on.", "items": { "type": "number" } }, "encodedPolygons": { "title": "Encoded polygons", "type": "array", "description": "Encoded polygon strings describing the search area.", "items": { "type": "string" } }, "hashBoxLevel": { "title": "Hash box level", "type": "integer", "description": "Geohash precision for map searches. Use the level from your Property Finder search." }, "priceType": { "title": "Price type", "type": "string", "description": "Optional. Price period type, e.g. yearly or monthly." }, "isRnpmEnabled": { "title": "RNPM enabled", "type": "boolean", "description": "Optional. Only listings with RNPM enabled." }, "topSuperAgents": { "title": "Top SuperAgents", "type": "string", "description": "Optional. Top SuperAgents filter value as used by Property Finder." }, "projectCarousel": { "title": "Project carousel", "type": "boolean", "description": "Optional. Project carousel listings filter." }, "projectUnit": { "title": "Project unit", "type": "boolean", "description": "Optional. Only project-unit listings." }, "locale": { "title": "Locale", "enum": [ "", "en", "ar" ], "type": "string", "description": "URL locale prefix. Leave empty for market default (en).", "default": "" }, "maxItems": { "title": "Max listings per start URL or configured search", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum listing rows per start URL, or per configured search without startUrls; defaults to 70, allows up to 2,000 and collects larger requests in parts of at most 70. Markets and property types in a configured search share this limit; the maximum run cost also applies, and Free-plan users are limited to 200 rows per run and 10 runs of this Actor.", "default": 70 }, "maxPages": { "title": "Max search pages", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum search pages to collect, from 1 to 100. The row limit and number of available matches can stop collection earlier.", "default": 1 }, "scrapeDetails": { "title": "Scrape detail pages", "type": "boolean", "description": "Add available listing details, including descriptions, amenities and public agent or property broker contacts, to search rows. Off by default.", "default": false }, "enableBrowserFallback": { "title": "Legacy compatibility setting", "type": "boolean", "description": "Legacy setting with no effect. Kept for compatibility with saved inputs.", "default": true }, "requestDelayMillis": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 15000, "type": "integer", "description": "Delay between collection requests, in milliseconds.", "default": 800 }, "maxConcurrency": { "title": "Request concurrency", "minimum": 1, "maximum": 8, "type": "integer", "description": "Maximum number of simultaneous listing-detail requests.", "default": 2 }, "enrichInsights": { "title": "Insights enrichment", "type": "boolean", "description": "Add location-level price trends or other selected insights inside each listing row. Off by default; data may be unavailable for some locations.", "default": false }, "enrichTransactions": { "title": "Transactions enrichment", "type": "boolean", "description": "Add available recent transaction context for the listing location inside each listing row. Off by default.", "default": false }, "enrichKinds": { "title": "Insights kinds", "type": "array", "description": "Choose insight types when Insights enrichment is on; empty = price trends only. Transactions are fetched only when Transactions enrichment is on.", "items": { "type": "string", "enum": [ "price-trends", "price-comparisons", "location-categories", "available-filters", "nearby-towers" ], "enumTitles": [ "Price trends", "Price comparisons", "Location categories", "Available filters", "Nearby towers" ] }, "default": [] }, "searchVersion": { "title": "Search version", "enum": [ "v1", "v2" ], "type": "string", "description": "Choose the search response version. Version v2 can report additional search warnings; both versions return listing rows.", "default": "v1" }, "autocompleteBuckets": { "title": "Autocomplete buckets", "type": "array", "description": "Choose location suggestion categories for locationQuery; empty means projects and locations. Developer suggestions do not identify a location and are skipped.", "items": { "type": "string", "enum": [ "autocomplete_developer", "autocomplete_project", "autocomplete_project_location" ], "enumTitles": [ "Developers", "Projects", "Projects and locations" ] }, "default": [] }, "workerBaseUrl": { "title": "Developer test URL", "type": "string", "description": "Leave empty. Used only by the developer for testing.", "default": "" }, "cursor": { "title": "Continuation token", "type": "string", "description": "Leave empty for a new search. This continuation token is filled automatically when needed." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }