{ "openapi": "3.0.1", "info": { "title": "Dubai Real Estate Location Scraper", "description": "γ€Œ π™Šπ™‰π™‡π™” $𝟬.𝟬𝟬𝟯/π—½π—Ώπ—Όπ—½π—²π—Ώπ˜π˜† γ€πŸ  Market's best price! Extract 1000+ Bayut listings in minutes instead of hours. Stop copying Dubai & UAE properties manually! Advanced filters (price, rooms, area, agency), clean JSON/CSV. Zero technical skills needed. Real estate pros choose us! 🎯", "version": "1.0", "x-build-id": "6WkHPMxMeKc1iEd8S" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sian.agency~bayut-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sian.agency-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/sian.agency~bayut-property-scraper/runs": { "post": { "operationId": "runs-sync-sian.agency-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/sian.agency~bayut-property-scraper/run-sync": { "post": { "operationId": "run-sync-sian.agency-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", "required": [ "purpose" ], "properties": { "locationName": { "title": "πŸ“ Location Name", "type": "string", "description": "Location name to search for on Bayut (e.g., 'Dubai', 'Marina', 'Downtown Abu Dhabi').", "default": "" }, "bulkLocationNames": { "title": "πŸ“¦ Bulk Location Names (Multiple Searches)", "type": "array", "description": "Search multiple location names at once (PAID tier). Click 'Bulk edit' to paste names one per line, or use '+ Add' for manual entry. Single location name above is ignored when bulk list is provided.", "items": { "type": "string" } }, "pageNumber": { "title": "πŸ“„ Page Number", "minimum": 0, "type": "integer", "description": "Page number to scrape (0-indexed). Default is 0 (first page). Increase to scrape subsequent pages.", "default": 0 }, "purpose": { "title": "🎯 Purpose (Required)", "enum": [ "for-rent", "for-sale" ], "type": "string", "description": "Whether to search for rentals or properties for sale. Required field.", "default": "for-rent" }, "location_external_id": { "title": "πŸ“ Location External ID", "type": "string", "description": "The location_external_id field returned in the /auto-complete endpoint. When provided, switches to property search mode. Example: '5002' for Dubai Marina." }, "bulkLocationExternalIds": { "title": "πŸ“¦ Bulk Location External IDs (Multiple Searches)", "type": "array", "description": "Search multiple location external IDs at once (PAID tier). Click 'Bulk edit' to paste IDs one per line, or use '+ Add' for manual entry. Single Location External ID above is ignored when bulk list is provided.", "items": { "type": "string" } }, "hitsPerPage": { "title": "Results Per Page", "minimum": 1, "maximum": 100, "type": "integer", "description": "Number of property listings to return per page.", "default": 25 }, "page": { "title": "Page Number (0-indexed)", "minimum": 0, "type": "integer", "description": "Zero-indexed page number for property search results. Page 0 returns the first page.", "default": 0 }, "category": { "title": "Category", "enum": [ "residential", "commercial" ], "type": "string", "description": "High-level property category." }, "category_external_id": { "title": "Property Type", "enum": [ "4", "16", "3", "18", "21", "19", "14", "12", "17", "5", "6", "7", "9", "25", "20", "15", "13", "10", "8", "22", "23", "24", "11" ], "type": "string", "description": "Specific property type to filter by." }, "min_price": { "title": "Minimum Price", "type": "string", "description": "Minimum listing price (in local currency). Leave blank for no minimum." }, "max_price": { "title": "Maximum Price", "type": "string", "description": "Maximum listing price (in local currency). Leave blank for no maximum." }, "min_area": { "title": "Minimum Area (sqft)", "type": "string", "description": "Minimum property area in square feet. Leave blank for no minimum." }, "max_area": { "title": "Maximum Area (sqft)", "type": "string", "description": "Maximum property area in square feet. Leave blank for no maximum." }, "rooms": { "title": "Bedrooms", "enum": [ "studio", "1", "2", "3", "4", "5", "6", "7" ], "type": "string", "description": "Number of bedrooms to filter by." }, "baths": { "title": "Bathrooms", "enum": [ "1", "2", "3", "4", "5", "6", "7" ], "type": "string", "description": "Number of bathrooms to filter by." }, "furnishingStatus": { "title": "Furnishing Status", "enum": [ "unfurnished", "furnished" ], "type": "string", "description": "Filter by furnishing status." }, "rent_frequency": { "title": "Rent Frequency", "enum": [ "daily", "weekly", "monthly", "yearly" ], "type": "string", "description": "Rental payment frequency (for-rent listings only)." }, "completionStatus": { "title": "Completion Status", "enum": [ "under-construction", "completed" ], "type": "string", "description": "Property completion status (for-sale listings only)." }, "product": { "title": "Product Tier", "enum": [ "hot", "superhot" ], "type": "string", "description": "Filter by Bayut listing tier. Use 'hot' for featured listings or 'superhot' for premium listings." }, "hasFloorplan": { "title": "Has Floorplan", "type": "boolean", "description": "When enabled, only return listings that include a floorplan.", "default": false }, "hasPanorama": { "title": "Has Panorama", "type": "boolean", "description": "When enabled, only return listings that include a 360Β° panorama view.", "default": false }, "hasVideo": { "title": "Has Video", "type": "boolean", "description": "When enabled, only return listings that include a video.", "default": false }, "agency_external_ids": { "title": "Agency External IDs", "type": "string", "description": "Filter by agency ID(s). Separate multiple IDs with commas. Example: '7737,5002'. Agency IDs can be found via the Bayut agency search." } } }, "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 } } } } } } } } } }