{ "openapi": "3.0.1", "info": { "title": "Property Finder API Scraper", "description": "Scrape Property Finder (MENA real estate: UAE, Saudi Arabia, Qatar, Egypt, Bahrain) public listings: search by location/type/price with full property detail (price, size, beds/baths, location + coordinates, images, agent/broker, amenities, RERA permit). Read-only, no account.", "version": "0.0", "x-build-id": "ALLSjNMx8cBIPM891" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rl1987~propertyfinder-api-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rl1987-propertyfinder-api-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/rl1987~propertyfinder-api-scraper/runs": { "post": { "operationId": "runs-sync-rl1987-propertyfinder-api-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/rl1987~propertyfinder-api-scraper/run-sync": { "post": { "operationId": "run-sync-rl1987-propertyfinder-api-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": { "mode": { "title": "Mode", "enum": [ "search", "propertyDetail" ], "type": "string", "description": "Search returns listings for a country/location with filters; Property details fetches full records for given property IDs.", "default": "search" }, "country": { "title": "Country", "enum": [ "ae", "sa", "qa", "eg", "bh" ], "type": "string", "description": "Property Finder market to search.", "default": "ae" }, "locale": { "title": "Language", "enum": [ "en", "ar" ], "type": "string", "description": "Response language.", "default": "en" }, "includeDetails": { "title": "Fetch full property details", "type": "boolean", "description": "For each search result, also fetch the full listing (description, amenities, RERA permit, furnishing, zone) and merge it into the row. Adds one request per property.", "default": false }, "category": { "title": "Category", "enum": [ "buy", "rent", "commercial_buy", "commercial_rent", "new_projects" ], "type": "string", "description": "Listing purpose.", "default": "rent" }, "location": { "title": "Location", "type": "string", "description": "Place name (city/community/tower), resolved to a Property Finder location at runtime — e.g. 'Dubai Marina', 'Riyadh'. Leave blank to search the whole country." }, "query": { "title": "Keyword", "type": "string", "description": "Optional free-text search within the results." }, "propertyType": { "title": "Property type", "enum": [ "apartment", "villa", "townhouse", "penthouse", "duplex", "compound", "hotel_apartment", "whole_building", "full_floor", "half_floor", "bungalow", "bulk_rent_unit" ], "type": "string", "description": "Optional property-type filter." }, "furnished": { "title": "Furnished", "enum": [ "all", "yes", "no", "partly" ], "type": "string", "description": "Optional furnishing filter." }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Optional minimum price (listing currency)." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Optional maximum price." }, "bedrooms": { "title": "Bedrooms", "type": "array", "description": "Optional bedroom counts, e.g. ['studio','1','2'].", "items": { "type": "string" } }, "bathrooms": { "title": "Bathrooms", "type": "array", "description": "Optional bathroom counts.", "items": { "type": "string" } }, "sort": { "title": "Sort", "enum": [ "featured", "newest", "price_asc", "price_desc", "bedroom_asc", "bedroom_desc" ], "type": "string", "description": "Result ordering.", "default": "featured" }, "maxItems": { "title": "Max items", "minimum": 0, "type": "integer", "description": "Roughly how many listings to return (0 = no limit). Pages are 25.", "default": 100 }, "propertyIds": { "title": "Property IDs", "type": "array", "description": "Property details mode: Property Finder listing IDs (the numeric id from a search result / the number at the end of a listing URL).", "default": [], "items": { "type": "string" } }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "type": "integer", "description": "Max requests in parallel.", "default": 5 }, "maxRequestRetries": { "title": "Max request retries", "minimum": 0, "type": "integer", "description": "Retries per request.", "default": 5 }, "maxSessionRotations": { "title": "Max session rotations", "minimum": 0, "type": "integer", "description": "Retries for a blocked/rate-limited status.", "default": 10 }, "locationIds": { "title": "Location IDs (raw override)", "type": "array", "description": "Optional advanced override: raw Property Finder location ids, skipping name resolution.", "default": [], "items": { "type": "string" } }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. A UAE/GCC residential IP is recommended for the regional hosts.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }