{ "openapi": "3.0.1", "info": { "title": "Property Finder MENA Listings & Agent Contact Extractor", "description": "Reads Property Finder listings across the UAE, Saudi Arabia, Qatar, Bahrain, and Egypt, returning price, size, location hierarchy, amenities, and agent or brokerage contact details.", "version": "2.0", "x-build-id": "xMhCXrO7B9kNH6URi" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dataspryva~property-finder-mena-listings-and-agent-contact/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dataspryva-property-finder-mena-listings-and-agent-contact", "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/dataspryva~property-finder-mena-listings-and-agent-contact/runs": { "post": { "operationId": "runs-sync-dataspryva-property-finder-mena-listings-and-agent-contact", "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/dataspryva~property-finder-mena-listings-and-agent-contact/run-sync": { "post": { "operationId": "run-sync-dataspryva-property-finder-mena-listings-and-agent-contact", "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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "listings", "agents", "brokers" ], "type": "string", "description": "What to scrape. Search listings by filters, scrape specific listing URLs, or collect agent/broker profiles.", "default": "search" }, "country": { "title": "Country", "enum": [ "ae", "sa", "qa", "bh", "eg" ], "type": "string", "description": "Market to search or the country used for bare agent/broker ids.", "default": "ae" }, "city": { "title": "City / province", "enum": [ "all", "dubai", "abu-dhabi", "sharjah", "ajman", "ras-al-khaimah", "fujairah", "umm-al-quwain", "al-ain", "ar-riyadh", "makkah-al-mukarramah", "eastern", "al-madinah-al-munawwarah", "al-qassim", "asir", "tabuk", "hail", "najran", "jazan", "doha", "lusail", "al-wakra", "al-khor", "al-daayen", "al-shamal", "umm-salal-mohammed", "dukhan-highway", "capital-governorate", "northern-governorate", "southern-governorate", "muharraq-governorate", "central-governorate", "cairo", "giza", "alexandria", "north-coast", "new-capital", "asyut", "demyat", "qalyubia", "al-fayum", "red-sea", "south-sainai", "matrouh", "port-saeed", "suez", "sharqia", "el-esmailia", "al-behera", "al-daqahlya", "al-gharbeya", "al-menofeya" ], "type": "string", "description": "City, province or governorate to search. Choose All cities for a country-wide search.", "default": "dubai" }, "purpose": { "title": "Purpose", "enum": [ "buy", "rent", "commercial-buy", "commercial-rent" ], "type": "string", "description": "Buy, rent, or the commercial equivalents.", "default": "buy" }, "propertyType": { "title": "Property type", "enum": [ "any", "apartment", "villa", "townhouse", "penthouse", "duplex", "compound", "land", "whole-building", "half-floor", "office", "shop", "warehouse", "factory", "showroom" ], "type": "string", "description": "Residential types: apartment, villa, townhouse, penthouse, duplex, compound, land, whole building, half floor. Commercial types: office, shop, warehouse, factory, showroom.", "default": "any" }, "bedrooms": { "title": "Bedrooms", "enum": [ "any", "studio", "1", "2", "3", "4", "5", "6", "7+" ], "type": "string", "description": "Bedroom filter for residential searches. Studio is supported for apartments and mixed-type searches.", "default": "any" }, "priceMin": { "title": "Minimum price", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Minimum asking price in the market's local currency (AED, SAR, QAR, BHD or EGP)." }, "priceMax": { "title": "Maximum price", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Maximum asking price in the market's local currency." }, "furnishing": { "title": "Furnishing", "enum": [ "any", "furnished", "unfurnished" ], "type": "string", "description": "Furnished or unfurnished. Leave on Any furnishing to include both.", "default": "any" }, "completionStatus": { "title": "Completion status", "enum": [ "any", "completed", "off_plan" ], "type": "string", "description": "Ready or off-plan. Applies to residential for-sale searches; ignored for rentals and commercial searches.", "default": "any" }, "maxItems": { "title": "Max records", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of listings or profiles to return.", "default": 100 }, "includeDetails": { "title": "Include full listing details", "type": "boolean", "description": "Open each listing page to add the full photo gallery, permit validation link, licences, floor plans and agent ratings. Turn off for a faster, lighter dataset.", "default": true }, "startUrls": { "title": "Listing or search URLs", "type": "array", "description": "Property Finder landing, search, listing or short URLs. Used with mode=listings. Sitemap and sitemap-index URLs are also accepted.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "agentUrls": { "title": "Agent profile URLs or IDs", "type": "array", "description": "Property Finder agent profile URLs, or bare numeric agent IDs. Used with mode=agents.", "items": { "type": "string" } }, "brokerUrls": { "title": "Broker profile URLs or IDs", "type": "array", "description": "Property Finder broker/agency profile URLs, or bare numeric broker IDs. Used with mode=brokers.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }