{ "openapi": "3.0.1", "info": { "title": "Bayut Property Scraper", "description": "Scrape Bayut UAE property listings at scale — price, beds, area, GPS, photos, agent phone & WhatsApp, agency and TruCheck verification as structured JSON. Filter by location, category, price and beds. Built for investors, agencies and PropTech. Pay only for the results you get.", "version": "1.0", "x-build-id": "hlFQ2wejzJQf7pj0K" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axlymxp~bayut-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axlymxp-bayut-property-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/axlymxp~bayut-property-scraper/runs": { "post": { "operationId": "runs-sync-axlymxp-bayut-property-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/axlymxp~bayut-property-scraper/run-sync": { "post": { "operationId": "run-sync-axlymxp-bayut-property-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": { "purpose": { "title": "Purpose", "enum": [ "for-sale", "for-rent" ], "type": "string", "description": "Scrape properties for sale or for rent.", "default": "for-sale" }, "category": { "title": "Property category", "enum": [ "apartments", "villas", "townhouses", "penthouses", "hotel-apartments", "residential-plots", "residential-building", "residential-floors", "villa-compound", "offices", "shops", "warehouses", "commercial-plots", "commercial-villas", "labour-camps", "commercial-building", "factories", "showrooms" ], "type": "string", "description": "Filter by property category. Leave empty for all categories." }, "location": { "title": "Location name", "type": "string", "description": "A place name to auto-resolve (e.g. 'Dubai Marina', 'Business Bay', 'Abu Dhabi', 'JVC'). Leave empty to scrape the whole UAE, or use Location External IDs / Listing URLs." }, "locationExternalIds": { "title": "Location external IDs (advanced)", "type": "array", "description": "Optional. Exact Bayut location external IDs (e.g. 5002 = Dubai, 5003 = Dubai Marina). Overrides 'Location name' when set.", "items": { "type": "string" } }, "listingUrls": { "title": "Listing URLs (direct mode)", "type": "array", "description": "Optional. Direct Bayut property page links (e.g. https://www.bayut.com/property/details-14906927.html) or bare property IDs to scrape specific listings instead of searching.", "items": { "type": "string" } }, "minPrice": { "title": "Minimum price (AED)", "type": "integer", "description": "Optional minimum price in AED." }, "maxPrice": { "title": "Maximum price (AED)", "type": "integer", "description": "Optional maximum price in AED." }, "minBeds": { "title": "Minimum bedrooms", "type": "integer", "description": "Optional minimum bedroom count (0 = studio)." }, "maxBeds": { "title": "Maximum bedrooms", "type": "integer", "description": "Optional maximum bedroom count." }, "minBaths": { "title": "Minimum bathrooms", "type": "integer", "description": "Optional minimum bathroom count." }, "minArea": { "title": "Minimum area (sqft)", "type": "integer", "description": "Optional minimum built-up area in square feet." }, "maxArea": { "title": "Maximum area (sqft)", "type": "integer", "description": "Optional maximum built-up area in square feet." }, "furnishing": { "title": "Furnishing", "enum": [ "furnished", "unfurnished", "partly-furnished" ], "type": "string", "description": "Optional furnishing filter." }, "completionStatus": { "title": "Completion status", "enum": [ "completed", "under-construction" ], "type": "string", "description": "Optional. Filter completed (ready) vs off-plan (under construction) properties." }, "rentFrequency": { "title": "Rent period", "enum": [ "yearly", "monthly", "weekly", "daily" ], "type": "string", "description": "Optional — only for rentals. Filter by rent period." }, "verifiedOnly": { "title": "Verified listings only", "type": "boolean", "description": "Only include Bayut-verified (TruCheck) listings.", "default": false }, "keywords": { "title": "Keywords", "type": "string", "description": "Optional free-text keywords to match (e.g. 'sea view', 'maid room', 'burj khalifa view')." }, "sort": { "title": "Sort order", "enum": [ "default", "verified", "newest", "oldest", "price_asc", "price_desc" ], "type": "string", "description": "Result ordering.", "default": "default" }, "maxItems": { "title": "Max listings", "minimum": 1, "type": "integer", "description": "Stop after collecting this many listings. Note: Bayut caps deep pagination near 50,000 results per query — split by price band or sub-location to collect more.", "default": 100 }, "hitsPerPage": { "title": "Page size (advanced)", "minimum": 1, "maximum": 50, "type": "integer", "description": "Listings fetched per request (1–50).", "default": 25 }, "language": { "title": "Language", "type": "string", "description": "Language for localized text (e.g. en, ar).", "default": "en" } } }, "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 } } } } } } } } } }