{ "openapi": "3.0.1", "info": { "title": "Propertyfinder Property Search", "description": "Propertyfinder scraper & UAE property API: search live Propertyfinder listings in Dubai, Abu Dhabi and across the UAE to buy or rent, commercial and new projects. Filter by location, price, size, bedrooms, bathrooms, furnishing and completion status. Real-time data, no proxies. Bayut alternative.", "version": "0.0", "x-build-id": "gnfc7HdvdvJpps9Oc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/happyendpoint~propertyfinder-property-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-happyendpoint-propertyfinder-property-search", "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/happyendpoint~propertyfinder-property-search/runs": { "post": { "operationId": "runs-sync-happyendpoint-propertyfinder-property-search", "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/happyendpoint~propertyfinder-property-search/run-sync": { "post": { "operationId": "run-sync-happyendpoint-propertyfinder-property-search", "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": { "operation": { "title": "Operation", "enum": [ "get-locations", "search-listings" ], "type": "string", "description": "**Step 1:** choose **Get location IDs** and type a place name.\n**Step 2:** choose **Search listings** and paste the `location_id` values you found.", "default": "search-listings" }, "locationQuery": { "title": "Location Name", "type": "string", "description": "**[Get location IDs only]** Any UAE city, community or building.\n\nExamples: `Dubai Marina`, `Downtown Dubai`, `Abu Dhabi`, `Al Reem Island`." }, "locationIds": { "title": "Location IDs", "type": "array", "description": "**[Search listings only]** One or more `location_id` values from **Get location IDs**. Each location is searched separately and the results are combined without duplicates.\n\nExamples: `1` (Dubai) · `50` (Dubai Marina) · `41` (Downtown Dubai) · `6` (Abu Dhabi).", "items": { "type": "string" } }, "category": { "title": "Category", "enum": [ "buy", "rent", "commercial-buy", "commercial-rent", "new-projects" ], "type": "string", "description": "**[Search listings only]** What kind of listings to search.", "default": "buy" }, "propertyType": { "title": "Property Type", "enum": [ "", "apartment", "villa", "townhouse", "penthouse", "compound", "duplex", "full-floor", "half-floor", "whole-building", "bulk-rent-unit", "bungalow", "hotel-apartment", "office-space", "retail", "warehouse", "shop", "show-room", "land", "factory", "labor-camp", "staff-accommodation", "business-centre", "co-working-space", "farm" ], "type": "string", "description": "**[Search listings only]** Leave as **Any** to include every type.", "default": "" }, "bedrooms": { "title": "Bedrooms", "type": "string", "description": "**[Search listings only]** One number or several separated by commas. `0` = Studio. Not used for Commercial categories.\n\nExamples: `2` · `2,3` · `0,1`." }, "bathrooms": { "title": "Bathrooms", "type": "string", "description": "**[Search listings only]** One number or several separated by commas.\n\nExamples: `2` · `2,3`." }, "priceMin": { "title": "Minimum Price (AED)", "minimum": 0, "type": "integer", "description": "**[Search listings only]** For Buy: purchase price. For Rent: rent amount for the chosen rent frequency (yearly by default)." }, "priceMax": { "title": "Maximum Price (AED)", "minimum": 0, "type": "integer", "description": "**[Search listings only]** For Buy: purchase price. For Rent: rent amount for the chosen rent frequency (yearly by default)." }, "areaMin": { "title": "Minimum Size (sqft)", "minimum": 0, "type": "integer", "description": "**[Search listings only]** Minimum property size in square feet." }, "areaMax": { "title": "Maximum Size (sqft)", "minimum": 0, "type": "integer", "description": "**[Search listings only]** Maximum property size in square feet." }, "furnishing": { "title": "Furnishing", "enum": [ "", "furnished", "unfurnished", "partly" ], "type": "string", "description": "**[Buy and Rent only]**", "default": "" }, "completionStatus": { "title": "Completion Status", "enum": [ "", "ready", "off_plan" ], "type": "string", "description": "**[Buy only]**", "default": "" }, "rentFrequency": { "title": "Rent Frequency", "enum": [ "", "yearly", "monthly", "weekly", "daily" ], "type": "string", "description": "**[Rent and Commercial Rent only]** Commercial Rent supports Yearly and Monthly only.", "default": "" }, "sort": { "title": "Sort Order", "enum": [ "", "newest", "featured", "price_asc", "price_desc", "delivery_earliest", "delivery_latest" ], "type": "string", "description": "**[Search listings only]** How results are ordered.", "default": "" }, "maxItems": { "title": "Max Results per Location", "minimum": 1, "type": "integer", "description": "**[Search listings only]** Maximum listings to save **per location**. The actor pages through results automatically, up to about 3,500 listings per location.", "default": 100 } } }, "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 } } } } } } } } } }