{ "openapi": "3.0.1", "info": { "title": "Property Finder Scraper | UAE Saudi Egypt Bahrain Qatar", "description": "Scrape Property Finder UAE, Saudi Arabia, Egypt, Bahrain & Qatar listings for sale or rent. Extract prices, beds, RERA, agents & images. Property Finder API alternative.", "version": "0.5", "x-build-id": "YjHsvSlr5HC2F6G8x" }, "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 (SRP) or listing detail (LDP) URLs for AE/SA/EG/BH/QA. Search URLs override market/channel/type when provided.", "default": [], "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": "Primary country market. Use all for AE+SA+EG+BH+QA. Ignored when markets is set.", "default": "AE" }, "markets": { "title": "Markets", "type": "array", "description": "Optional multi-select of markets. Overrides market when non-empty.", "items": { "type": "string", "enum": [ "AE", "SA", "EG", "BH", "QA" ] }, "default": [] }, "channel": { "title": "Channel", "enum": [ "BUY", "RENT", "COMMERCIAL_BUY", "COMMERCIAL_RENT" ], "type": "string", "description": "BUY / RENT (residential) or COMMERCIAL_BUY / 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": "Single category slug. Use all/properties for every type in the channel (omit t=). Type IDs are resolved per market.", "default": "all" }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Optional multi-select categories. Overrides propertyType when non-empty.", "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": "Optional Property Finder location id (the `l` URL parameter / `filters.locations_ids` in the search JSON). Leave empty/0 for national search (recommended)." }, "locationSlug": { "title": "Location slug", "type": "string", "description": "Optional city/area slug preset (e.g. dubai, riyadh, jeddah, lusail). Used when locationId is empty.", "default": "abu-dhabi" }, "locationQuery": { "title": "Location search text", "type": "string", "description": "Optional free-text location (city/community, e.g. dubai marina) to search. Resolved to a location id when locationId/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": "Order of search results. Full upstream sort contract (18 values). `distanceAsc` / `freshnessDate` only take effect with location-anchored filters.", "default": "newest" }, "bedrooms": { "title": "Bedrooms", "type": "array", "description": "Optional bedroom counts to include (e.g. [1, 2]; 0 = studio). Sent as one `filters.number_of_bedrooms` per value.", "items": { "type": "integer" }, "default": [] }, "bathrooms": { "title": "Bathrooms", "type": "array", "description": "Optional bathroom counts to include (e.g. [2, 3]). Sent as one `filters.number_of_bathrooms` per value.", "items": { "type": "integer" }, "default": [] }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Optional minimum price in the market currency (`filters.min_price`)." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Optional maximum price in the market currency (`filters.max_price`)." }, "amenities": { "title": "Amenities", "type": "array", "description": "Optional amenity slugs as used by Property Finder (e.g. pool, gym). Sent as one `filters.amenities` per value.", "items": { "type": "string" }, "default": [] }, "isVerified": { "title": "Verified listings only", "type": "boolean", "description": "Optional. true = verified listings only, false = unverified only, empty = no filter (`filters.is_verified`)." }, "furnished": { "title": "Furnishing", "enum": [ "all", "yes", "no", "partly" ], "type": "string", "description": "Optional furnishing filter (`filters.furnished`)." }, "completionStatus": { "title": "Completion status", "enum": [ "completed", "off_plan" ], "type": "string", "description": "Optional completion filter (`filters.completion_status`)." }, "keywords": { "title": "Keywords", "type": "string", "description": "Optional keyword text matched against listings (`filters.keywords`), e.g. sea view." }, "listedWithin": { "title": "Listed within (days)", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Optional. Only listings added within this many days (`filters.listed_within`)." }, "agentId": { "title": "Agent ID", "type": "integer", "description": "Optional. Only listings by this agent id (`filters.agent_id`)." }, "agentIds": { "title": "Agent IDs", "type": "array", "description": "Optional. Listings by any of these agent ids (`filters.agent_ids`).", "items": { "type": "integer" } }, "brokerId": { "title": "Broker ID", "type": "integer", "description": "Optional. Only listings by this broker (agency) id (`filters.broker_id`)." }, "clientIds": { "title": "Client IDs", "type": "array", "description": "Optional. Listings by any of these client ids (`filters.client_ids`).", "items": { "type": "integer" } }, "minArea": { "title": "Min area", "type": "integer", "description": "Optional. Minimum property area (unit set by areaUnit) (`filters.min_area`)." }, "maxArea": { "title": "Max area", "type": "integer", "description": "Optional. Maximum property area (unit set by areaUnit) (`filters.max_area`)." }, "areaUnit": { "title": "Area unit", "type": "string", "description": "Optional. Area unit for minArea/maxArea, e.g. sqft or sqm (`filters.area_unit`)." }, "paymentMethod": { "title": "Payment method", "type": "string", "description": "Optional. Single payment method, e.g. cash or mortgage (`filters.payment_method`)." }, "paymentMethods": { "title": "Payment methods", "type": "array", "description": "Optional. Any of these payment methods (`filters.payment_methods`).", "items": { "type": "string" } }, "nearByLat": { "title": "Near-by latitude", "type": "number", "description": "Optional. Centre latitude for a radius search; needs nearByLon (`filters.near_by.lat`)." }, "nearByLon": { "title": "Near-by longitude", "type": "number", "description": "Optional. Centre longitude for a radius search; needs nearByLat (`filters.near_by.lon`)." }, "nearByRadius": { "title": "Near-by radius", "type": "number", "description": "Optional. Radius around nearByLat/nearByLon (upstream default 10 when empty) (`filters.near_by.radius`)." }, "minNumberOfCheques": { "title": "Min number of cheques", "type": "integer", "description": "Optional. Rentals: minimum number of cheques (`filters.min_number_of_cheques`)." }, "maxNumberOfCheques": { "title": "Max number of cheques", "type": "integer", "description": "Optional. Rentals: maximum number of cheques (`filters.max_number_of_cheques`)." }, "minDownPaymentPrice": { "title": "Min down payment", "type": "integer", "description": "Optional. Minimum down payment in market currency (`filters.min_down_payment_price`)." }, "maxDownPaymentPrice": { "title": "Max down payment", "type": "integer", "description": "Optional. Maximum down payment in market currency (`filters.max_down_payment_price`)." }, "minInstallmentYears": { "title": "Min installment years", "type": "integer", "description": "Optional. Minimum payment-plan length in years (`filters.min_installment_years`)." }, "maxInstallmentYears": { "title": "Max installment years", "type": "integer", "description": "Optional. Maximum payment-plan length in years (`filters.max_installment_years`)." }, "utilitiesPriceType": { "title": "Utilities price type", "type": "string", "description": "Optional. Utilities pricing type as used by Property Finder (`filters.utilities_price_type`)." }, "hasPostHandoverPaymentPlan": { "title": "Post-handover payment plan", "type": "boolean", "description": "Optional. Only listings with a post-handover payment plan (`filters.has_post_handover_payment_plan`)." }, "virtualViewings": { "title": "Virtual viewings", "type": "string", "description": "Optional. Virtual viewing type, e.g. 360 or video (`filters.virtual_viewings`)." }, "isDeveloperProperty": { "title": "Developer properties", "type": "boolean", "description": "Optional. Only listings marketed by developers (`filters.is_developer_property`)." }, "isSuperAgent": { "title": "SuperAgent listings", "type": "boolean", "description": "Optional. Only listings by SuperAgents (`filters.is_super_agent`)." }, "isExactLocation": { "title": "Exact location", "type": "boolean", "description": "Optional. Only listings with an exact map location (`filters.is_exact_location`)." }, "newProjects": { "title": "New projects", "type": "boolean", "description": "Optional. Only new-project listings (`filters.new_projects`)." }, "primaryMarket": { "title": "Primary market", "type": "boolean", "description": "Optional. Only primary-market (first sale) listings (`filters.primary_market`)." }, "travelTime": { "title": "Travel time (minutes)", "type": "integer", "description": "Optional. Travel-time filter; operator defaults to gte when travelTimeOperator is empty (`filters.travel_time`)." }, "travelTimeOperator": { "title": "Travel time operator", "type": "string", "description": "Optional. Comparison for travelTime, e.g. gte or lte (`filters.travel_time_operator`)." }, "dealBadges": { "title": "Deal badges", "type": "array", "description": "Optional. Any of these deal badge slugs (`filters.deal_badges`).", "items": { "type": "string" } }, "excludeSpotlight": { "title": "Exclude spotlight", "type": "boolean", "description": "Optional. Exclude spotlight (promoted) listings (`filters.exclude_spotlight`)." }, "fullTextSearchQuery": { "title": "Full-text search", "type": "string", "description": "Optional. Full-text query matched against listings (`filters.full_text_search_query`)." }, "deliveryDateGte": { "title": "Delivery date from", "type": "string", "description": "Optional. Earliest delivery date, YYYY-MM-DD (`filters.delivery_date_gte`)." }, "deliveryDateLte": { "title": "Delivery date to", "type": "string", "description": "Optional. Latest delivery date, YYYY-MM-DD (`filters.delivery_date_lte`)." }, "boundingBox": { "title": "Bounding box", "type": "array", "description": "Optional. Two geohashes [north-west, south-east] (`filters.bounding_box`).", "items": { "type": "string" } }, "polygon": { "title": "Polygon", "type": "array", "description": "Optional. Flat list of coordinates [lat, lon, lat, lon, ...]; one param per pair (`filters.polygon`).", "items": { "type": "number" } }, "encodedPolygons": { "title": "Encoded polygons", "type": "array", "description": "Optional. Encoded polygon strings (`filters.encoded_polygons`).", "items": { "type": "string" } }, "hashBoxLevel": { "title": "Hash box level", "type": "integer", "description": "Optional. Geohash box level for map-style searches (`filters.hash_box.level`)." }, "priceType": { "title": "Price type", "type": "string", "description": "Optional. Price period type, e.g. yearly or monthly (`filters.price_type`)." }, "isRnpmEnabled": { "title": "RNPM enabled", "type": "boolean", "description": "Optional. Only listings with RNPM enabled (`filters.is_rnpm_enabled`)." }, "topSuperAgents": { "title": "Top SuperAgents", "type": "string", "description": "Optional. Top SuperAgents filter value as used by Property Finder (`filters.top_super_agents`)." }, "projectCarousel": { "title": "Project carousel", "type": "boolean", "description": "Optional. Project carousel listings filter (`filters.project_carousel`)." }, "projectUnit": { "title": "Project unit", "type": "boolean", "description": "Optional. Only project-unit listings (`filters.project_unit`)." }, "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": "Most listing rows for each start URL, or for the configured search when startUrls is empty. Default 70; larger numbers are collected in parts of at most 70, up to 2,000. Markets and property types inside one configured search share that input's allowance. The run stops at your maximum total charge. Free Apify plan: up 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 per search. The JSON search endpoint pages with `pagination.page` and `pagination.limit` (up to 60 listings per page), so it reaches deeper than the HTML path (~25 per page).", "default": 1 }, "scrapeDetails": { "title": "Scrape detail pages", "type": "boolean", "description": "Fetch listing details (including agent/broker email & phone when public) with one batched `properties?ids=` JSON call per result page — no per-listing HTML page loads.", "default": false }, "enableBrowserFallback": { "title": "Browser fallback (deprecated)", "type": "boolean", "description": "Deprecated, no effect. Kept so existing saved inputs still validate; the JSON endpoint used by this worker needs no browser.", "default": true }, "requestDelayMillis": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 15000, "type": "integer", "description": "Politeness delay between HTTP requests.", "default": 800 }, "maxConcurrency": { "title": "Request concurrency", "minimum": 1, "maximum": 8, "type": "integer", "description": "Max concurrent HTTP fetches for detail pages.", "default": 2 }, "enrichInsights": { "title": "Insights enrichment", "type": "boolean", "description": "Optional insights/transactions context per listing's location_id. Sparse upstream — fields may be null. Adds an `enrichment.insights` object (price trends etc.) to each row; fetched once per distinct location.", "default": false }, "enrichTransactions": { "title": "Transactions enrichment", "type": "boolean", "description": "Optional insights/transactions context per listing's location_id. Sparse upstream — fields may be null. Adds an `enrichment.transactions` object (recent transactions, sale price quartiles) to each row; fetched once per distinct location.", "default": false }, "enrichKinds": { "title": "Insights kinds", "type": "array", "description": "Optional insights/transactions context per listing's location_id. Sparse upstream — fields may be null. Which insights to fetch when Insights enrichment is on; empty = price trends only.", "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 API version", "enum": [ "v1", "v2" ], "type": "string", "description": "Search response schema. v1 returns the stable listing stream; v2 returns the same listings and adds similar_listings and filter_errors (reported in run warnings).", "default": "v1" }, "autocompleteBuckets": { "title": "Autocomplete buckets", "type": "array", "description": "Autocomplete buckets queried when resolving Location search text. Empty = autocomplete_project_location (default). Developer hits are never used as a location.", "items": { "type": "string", "enum": [ "autocomplete_developer", "autocomplete_project", "autocomplete_project_location" ], "enumTitles": [ "Developers", "Projects", "Projects and locations" ] }, "default": [] }, "workerBaseUrl": { "title": "Worker base URL (optional)", "type": "string", "description": "Worker endpoint override for local development. Production uses https://worker.opendata.best/b/propertyfinder-ae through the control plane. Leave empty in production.", "default": "" }, "cursor": { "title": "Cursor (row-plan continuation)", "type": "string", "description": "Internal row-plan continuation token. Leave empty; the control plane fills this when resuming a multi-unit search." } } }, "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 } } } } } } } } } }