{ "openapi": "3.0.1", "info": { "title": "Bayut Scraper - Dubai Real Estate & UAE Property Listings", "description": "Bayut scraper for Dubai real estate and UAE property listings from Bayut.com, for sale or rent: price, beds, baths, area, location, property type, agency and listing URL. Filter by city, purpose and type. Dubai property data for Dubai, Abu Dhabi, Sharjah and all of the UAE.", "version": "0.1", "x-build-id": "3m7JEN9siftvjWELF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/get_anything~bayut-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-get_anything-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/get_anything~bayut-property-scraper/runs": { "post": { "operationId": "runs-sync-get_anything-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/get_anything~bayut-property-scraper/run-sync": { "post": { "operationId": "run-sync-get_anything-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": [ "rapidApiKey", "purpose" ], "properties": { "rapidApiKey": { "title": "RapidAPI key", "type": "string", "description": "Your RapidAPI key for the 'Real Time Bayut Data API' by Happy Endpoint. Subscribe (free plan available) at https://rapidapi.com/happyendpoint/api/uae-real-estate3/ then copy the X-RapidAPI-Key. Your API calls are billed by RapidAPI to your own plan." }, "purpose": { "title": "Buy or rent", "enum": [ "for-sale", "to-rent" ], "type": "string", "description": "Whether to get properties for sale or for rent.", "default": "for-sale" }, "propertyType": { "title": "Property type", "enum": [ "apartments", "villas", "townhouses", "penthouses", "hotel-apartments", "villa-compound", "residential-plots", "residential-building", "residential-floors", "residential", "offices", "shops", "warehouses", "showrooms", "commercial-villas", "commercial-buildings", "commercial-floors", "commercial-plots", "commercial", "property" ], "type": "string", "description": "Which property type to scrape. Use 'All residential & commercial' for everything.", "default": "apartments" }, "city": { "title": "City / emirate", "enum": [ "dubai", "abu-dhabi", "sharjah", "ajman", "ras-al-khaimah", "fujairah", "umm-al-quwain", "al-ain" ], "type": "string", "description": "Which UAE city / emirate to search. Ignored when 'Community / area' is set.", "default": "dubai" }, "location": { "title": "Community / area (optional)", "type": "string", "description": "Search a specific community instead of the whole city, e.g. 'Dubai Marina', 'Palm Jumeirah', 'JVC', 'Al Reem Island'." }, "rooms": { "title": "Bedrooms", "type": "string", "description": "Comma-separated bedroom counts, 0 = studio. Example: 0,1,2" }, "priceMin": { "title": "Min price (AED)", "type": "integer", "description": "Minimum price in AED." }, "priceMax": { "title": "Max price (AED)", "type": "integer", "description": "Maximum price in AED." }, "rentFrequency": { "title": "Rent frequency", "enum": [ "yearly", "monthly", "weekly", "daily" ], "type": "string", "description": "For rentals only. Bayut defaults to yearly." }, "completionStatus": { "title": "Completion status", "enum": [ "any", "completed", "under-construction" ], "type": "string", "description": "Ready or off-plan properties.", "default": "any" }, "furnishing": { "title": "Furnishing", "enum": [ "furnished", "unfurnished" ], "type": "string", "description": "Filter by furnishing." }, "sortOrder": { "title": "Sort by", "enum": [ "popular", "latest", "verified", "lowest_price", "highest_price" ], "type": "string", "description": "Result order.", "default": "popular" }, "maxItems": { "title": "Max properties", "type": "integer", "description": "Maximum number of properties to scrape. Set 0 for unlimited (capped by Max pages).", "default": 100 }, "maxPages": { "title": "Max listing pages", "type": "integer", "description": "Maximum result pages to fetch (24 properties per page). Each page is one API call on your RapidAPI plan.", "default": 5 } } }, "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 } } } } } } } } } }