{ "openapi": "3.0.1", "info": { "title": "UAE Real Estate Scraper", "description": "Filter search property and scrape live UAE property listings from Bayut - apartments, villas, offices & more for sale or rent. Filter by location, price, bedrooms & type. Real-time data, no proxies needed. Perfect for real estate apps & analytics. Propertyfinder, UAE Properties, Unofficial Scraper", "version": "0.0", "x-build-id": "No5e7nPWtKJ8BwZJt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/happyendpoint~uae-real-estate-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-happyendpoint-uae-real-estate-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/happyendpoint~uae-real-estate-scraper/runs": { "post": { "operationId": "runs-sync-happyendpoint-uae-real-estate-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/happyendpoint~uae-real-estate-scraper/run-sync": { "post": { "operationId": "run-sync-happyendpoint-uae-real-estate-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", "required": [ "endpoint" ], "properties": { "endpoint": { "title": "Mode", "enum": [ "/autocomplete", "/search-property" ], "type": "string", "description": "**Step 1:** Run **Location Search** to find a location ID.\n**Step 2:** Run **Property Search** using that ID.", "default": "/search-property" }, "query": { "title": "Location Name", "type": "string", "description": "**[Location Search only]** Enter any area, district, or city in Dubai / UAE.\n\nExamples: `Dubai Marina`, `Downtown Dubai`, `Palm Jumeirah`, `Abu Dhabi`." }, "purpose": { "title": "Purpose", "enum": [ "for-sale", "for-rent" ], "type": "string", "description": "**[Property Search only]** Whether you are looking for properties to buy or rent.\n\nThis selection affects which other filters are relevant — see filter descriptions below.", "default": "for-sale" }, "location_ids": { "title": "Location ID(s)", "type": "string", "description": "**[Property Search only]** The `externalID` from a Location Search result. For multiple locations, separate with commas.\n\nExamples: `5003` (Dubai Marina) · `5002` (All of Dubai) · `5003,5060` (multiple areas)." }, "property_type": { "title": "Property Type", "enum": [ "residential", "apartments", "villas", "townhouses", "penthouse", "hotel-apartments", "commercial", "offices", "shops", "warehouses", "showrooms" ], "type": "string", "description": "**[Property Search only]** Filter by property type.\n\n**Residential types** work for both sale and rent.\n**Commercial types** work for both sale and rent.\n\nChoose `All Residential` or `All Commercial` to include all sub-types of that category.", "default": "residential" }, "rooms": { "title": "Bedrooms", "type": "string", "description": "**[Property Search only — Residential only]** Number of bedrooms. Enter a single value or comma-separated values.\n\n`0` = Studio. Valid values: `0`, `1`, `2`, `3`, `4`, `5`.\n\nExamples: `1` · `2,3` · `0,1,2` · `4,5`.\n\n⚠️ Not applicable for commercial property types (offices, shops, warehouses, showrooms)." }, "price_min": { "title": "Minimum Price (AED)", "minimum": 0, "type": "integer", "description": "**[Property Search only]** Minimum price in AED.\n\n**For Sale:** purchase price. Example: `500000`\n**For Rent:** annual rent amount. Example: `30000`" }, "price_max": { "title": "Maximum Price (AED)", "minimum": 0, "type": "integer", "description": "**[Property Search only]** Maximum price in AED.\n\n**For Sale:** purchase price. Example: `2000000`\n**For Rent:** annual rent amount. Example: `120000`" }, "completion_status": { "title": "Completion Status", "enum": [ "", "completed", "under-construction" ], "type": "string", "description": "**[Property Search only — For Sale only]** Filter by build status.\n\n⚠️ This filter is only meaningful when Purpose is **For Sale**. Rental listings are always ready-to-occupy and are not categorised by completion status." }, "sort_order": { "title": "Sort Order", "enum": [ "popular", "latest", "lowest_price", "highest_price", "verified" ], "type": "string", "description": "**[Property Search only]** How to order results.", "default": "popular" }, "page": { "title": "Page Number", "minimum": 1, "type": "integer", "description": "**[Property Search only]** Which page of results to fetch. Each page contains up to 25 listings.\n\nAfter each run, check **Storage → Key-Value Store → PAGINATION_INFO** to see `totalPages`, `hasNextPage`, and `nextPage`. Increment this number on your next run to continue paginating.", "default": 1 } } }, "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 } } } } } } } } } }