{ "openapi": "3.0.1", "info": { "title": "Bayut.com Scraper - Properties, Prices, Agents & Contacts", "description": "From $0.80/1K. Scrape Bayut.com property listings with prices, beds, baths, area, GPS, agent and agency details, phone, WhatsApp, email, RERA/Trakheesi permits, photos, amenities, and TruCheck verification dates.", "version": "1.0", "x-build-id": "fZYpfQ3A9TAlygOX7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abotapi~bayut-com-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abotapi-bayut-com-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/abotapi~bayut-com-scraper/runs": { "post": { "operationId": "runs-sync-abotapi-bayut-com-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/abotapi~bayut-com-scraper/run-sync": { "post": { "operationId": "run-sync-abotapi-bayut-com-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": [ "mode" ], "properties": { "mode": { "title": "1. Search mode", "enum": [ "search", "url" ], "type": "string", "description": "Search mode = pick city + property type + filters below. URL mode = paste any bayut.com search URL(s) you already refined in a browser. URL mode supports multiple URLs and walks pagination forward from each.", "default": "search" }, "market": { "title": "Country site", "enum": [ "uae", "ksa", "qatar", "jordan", "oman" ], "type": "string", "description": "Which Bayut country site to search: bayut.com (UAE, default), bayut.sa (Saudi Arabia), bayut.qa (Qatar), bayut.jo (Jordan) or bayut.om (Oman). Prices come back in that country's currency (AED, SAR, QAR, JOD, OMR) and every row carries a `market` field. Use that country's own city slugs in Locations, e.g. 'riyadh' or 'jeddah' (Saudi Arabia), 'qatar' or 'doha' (Qatar), 'amman' (Jordan), 'muscat' (Oman). In URL mode the country is read from each pasted link instead.", "default": "uae" }, "searchFor": { "title": "What to collect (Search mode)", "enum": [ "listings", "agents", "agencies" ], "type": "string", "description": "Property listings (default), or Bayut's agent or agency directory for the chosen locations. Agent rows include languages, specialities, service areas, badges (TruBroker, Quality Lister, Responsive), listing counts, email, phone and WhatsApp, and the agency with its licence. Agency rows include agent count, listing counts (sale/rent), property types, service areas, logo and tier. Turn on the full-detail option to also open each profile: agents then add years of experience, nationality and broker licence number; agencies add their description and licences. Every row has a `recordType` field: listing, agent or agency. Property filters below apply to listings only.", "default": "listings" }, "locations": { "title": "Cities / areas to search", "type": "array", "description": "Type city or area names as you would say them, one per line, e.g. 'Dubai', 'Abu Dhabi', 'Al Ain', 'Dubai Marina', 'Downtown Dubai', 'Yas Island', 'Al Khan', 'JVC', 'JLT'. Names are matched to Bayut's own areas (about 500 UAE areas are known offline, each under its real city, so 'Yas Island' searches Abu Dhabi). You can also paste the slug Bayut shows in its URL, e.g. 'dubai/dubai-marina' or 'abu-dhabi/yas-island'; use that form to pick the city when an area name exists in more than one city (the run warns and names them). On another country site use its own names, e.g. 'riyadh' or 'jeddah' (Saudi Arabia), 'amman' (Jordan). A name that does not match a real Bayut area is reported in the log by name instead of silently returning 0 results.", "items": { "type": "string" } }, "agentName": { "title": "Agent name contains (Agents only)", "type": "string", "description": "When collecting Agents, keep only agents whose name contains this text (not case-sensitive), e.g. 'Anna'. The scraper reads the agent directory page by page and keeps the matches, so narrow Locations (e.g. 'dubai/dubai-marina') for a faster search." }, "purpose": { "title": "Buy or rent? (Search mode)", "enum": [ "for-sale", "to-rent" ], "type": "string", "description": "Pick for-sale or for-rent. Search mode only.", "default": "for-sale" }, "propertyType": { "title": "Property type (Search mode)", "enum": [ "property", "apartments", "villas", "townhouses", "penthouses", "hotel-apartments", "compounds", "duplex", "land", "full-floors", "half-floors", "whole-buildings", "bulk-units", "commercial" ], "type": "string", "description": "What kind of property to search for. 'property' includes everything residential. Search mode only.", "default": "property" }, "propertyTypes": { "title": "Property types (multi-select, overrides the single type above)", "type": "array", "description": "Pick one or more exact Bayut property types, residential and commercial sub-types included. Results include any of the picked types. When set, this replaces the single Property type above. Also works on the other country sites; if a site has no such type, the run log says so instead of quietly returning unfiltered results.", "items": { "type": "string", "enum": [ "apartments", "villas", "townhouses", "penthouse", "hotel-apartments", "villa-compound", "residential-plots", "residential-building", "residential-floors", "offices", "shops", "warehouses", "labour-camps", "commercial-villas", "bulk-units", "commercial-floors", "commercial-buildings", "factories", "industrial-land", "mixed-use-land", "showrooms", "commercial-plots", "commerical-properties" ], "enumTitles": [ "Apartments", "Villas", "Townhouses", "Penthouses", "Hotel apartments", "Villa compounds", "Residential plots", "Residential buildings", "Residential floors", "Offices", "Shops", "Warehouses", "Labour camps", "Commercial villas", "Bulk units", "Commercial floors", "Commercial buildings", "Factories", "Industrial land", "Mixed-use land", "Showrooms", "Commercial plots", "Other commercial" ] } }, "minPrice": { "title": "Min price (AED)", "minimum": 0, "type": "integer", "description": "Minimum price filter in AED. Leave empty for no minimum. Search mode only." }, "maxPrice": { "title": "Max price (AED)", "minimum": 0, "type": "integer", "description": "Maximum price filter in AED. Leave empty for no maximum. Search mode only." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum bedrooms (0 = studio). Search mode only." }, "maxBedrooms": { "title": "Max bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Maximum bedrooms. Search mode only." }, "minBathrooms": { "title": "Min bathrooms", "minimum": 1, "maximum": 20, "type": "integer", "description": "Minimum bathrooms. Search mode only." }, "maxBathrooms": { "title": "Max bathrooms", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum bathrooms. Search mode only." }, "minArea": { "title": "Min area (sqft)", "minimum": 0, "type": "integer", "description": "Minimum area in square feet. Search mode only." }, "maxArea": { "title": "Max area (sqft)", "minimum": 0, "type": "integer", "description": "Maximum area in square feet. Search mode only." }, "furnishing": { "title": "Furnishing (Search mode)", "enum": [ "any", "furnished", "unfurnished" ], "type": "string", "description": "Furnishing filter. Search mode only.", "default": "any" }, "completionStatus": { "title": "Completion status (Search mode)", "enum": [ "any", "completed", "off-plan" ], "type": "string", "description": "Completed = ready to move in. Off-plan = under construction / pre-launch. Search mode only.", "default": "any" }, "rentFrequency": { "title": "Rent frequency (Rent only)", "enum": [ "any", "yearly", "monthly", "weekly", "daily" ], "type": "string", "description": "Only applies when purpose=to-rent.", "default": "any" }, "verifiedOnly": { "title": "TruCheck verified only (Search mode)", "type": "boolean", "description": "Only return TruCheck-verified listings (Bayut's vetted-by-RERA badge). Useful to filter agency spam.", "default": false }, "keywords": { "title": "Keywords (amenities, views, features)", "type": "array", "description": "Words Bayut's own keyword search must find in the listing, e.g. 'private pool', 'sea view', 'maids room', 'upgraded', 'gym'. Amenity names work here too: this is the same filter Bayut uses for amenities.", "items": { "type": "string" } }, "agencyIds": { "title": "Only these agencies", "type": "array", "description": "Limit listings to one or more agencies. Paste the agency's Bayut page link (e.g. https://www.bayut.com/companies/white-co-10212/), its slug ('white-co-10212') or its id ('10212'). Every listing row's agencyExternalID is this id. An entry with no id in it (for example a plain agency name) is reported in the log and not used.", "items": { "type": "string" } }, "agentIds": { "title": "Only these agents", "type": "array", "description": "Limit listings to one or more agents. Paste the agent's Bayut profile link (e.g. https://www.bayut.com/brokers/jane-doe-2126457.html), slug or id. Every listing row's agentExternalID is this id. An entry with no id in it (for example a plain agent name) is reported in the log and not used.", "items": { "type": "string" } }, "developerIds": { "title": "Only these developers", "type": "array", "description": "Limit listings to projects by one or more developers. Type the developer's name, e.g. 'Emaar', 'Sobha Realty', 'DAMAC Properties', or paste its Bayut developer page link (e.g. https://www.bayut.com/new-projects/developers/emaar/). Each name is looked up on the developer's own Bayut page at the start of the run and the log shows what it matched. A Bayut developer id (every listing row's developerExternalID, e.g. '12') also works. A name that is not found is reported in the log; if none is found the run stops with a clear message instead of returning unfiltered listings.", "items": { "type": "string" } }, "hasVideo": { "title": "Has a video", "type": "boolean", "description": "Only listings with at least one video.", "default": false }, "has360Tour": { "title": "Has a 360° tour", "type": "boolean", "description": "Only listings with a 360° virtual tour.", "default": false }, "hasFloorPlan": { "title": "Has a floor plan", "type": "boolean", "description": "Only listings with a floor plan.", "default": false }, "sortBy": { "title": "Sort order (Search mode)", "enum": [ "popular", "newest", "oldest", "price-asc", "price-desc", "verified-score-desc" ], "type": "string", "description": "How to order results. Search mode only - in URL mode the sort is taken from your pasted URL.", "default": "popular" }, "urls": { "title": "Search URLs (URL mode)", "type": "array", "description": "One or more Bayut links, one per line, on any Bayut site (bayut.com, bayut.sa, bayut.qa, bayut.jo, bayut.om). Each link is scraped on its own. Search-mode filters are ignored here: the filters, sort and page come from the link itself. Supported link types (the prefill has one example of each): a search or results page at any level (city, area, building, bedroom page such as /2-bedroom-apartments/, commercial types, /uae/, /s/ landing pages, /new-projects/ and /new-projects/developers// pages), with or without /page-N/ or query filters such as ?price_min=, beds_in= or sort_by=, and with or without a language prefix such as /ar/; a listing link (/property/details-.html), which returns exactly that listing; an agent directory or profile (/brokers// or /brokers/-.html), which returns agent rows; an agency directory or profile (/companies// or /companies/-/), which returns agency rows. Links without www., with http://, without https:// or copied with & are fixed automatically. Pages that hold no listings (the home page, blog, area or building guides, market reports) and links to other sites are skipped with a warning naming the link.", "items": { "type": "string" }, "default": [ "https://www.bayut.com/for-sale/property/dubai/", "https://www.bayut.com/for-sale/apartments/dubai/dubai-marina/", "https://www.bayut.com/for-sale/apartments/dubai/page-2/", "https://www.bayut.com/to-rent/apartments/dubai/dubai-marina/?sort_by=price-asc", "https://www.bayut.com/new-projects/dubai/", "https://www.bayut.com/property/details-16667906.html", "https://www.bayut.com/companies/" ] }, "maxPages": { "title": "Max result pages per location/URL", "minimum": 0, "type": "integer", "description": "Safety bound on how many result pages to walk per location or start URL (24 listings per page). 0 (default) means unlimited - the walk stops naturally once a page comes back empty or repeats listings already collected, or sooner once Max total listings is reached. Set a number only for an explicit page cap below that natural stop.", "default": 0 }, "maxListings": { "title": "Max total listings (default 20, 0 = unlimited)", "minimum": 0, "type": "integer", "description": "The sole soft cap on the run, applied across all locations/URLs. Defaults to 20 so a run stays small unless you raise it. 0 means unlimited (bounded only by the natural stop on Max result pages).", "default": 20 }, "fetchDetails": { "title": "Enrich each listing with full detail (extra cost per listing)", "type": "boolean", "description": "Off by default. The base result already includes ~50 fields: lat/lng, agent phone, WhatsApp, agency, beds/baths, area, price and photo IDs. Turn this on to additionally enrich every listing with its full description, categorized amenities, the full photo gallery, payment plans, off-plan completion details, and the agency's licences, product tier and TruCheck date (Bayut's search results stopped carrying these in October 2026). Each enriched listing opens its listing page: one extra request. Billed per enriched listing.", "default": false }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Apify residential proxy with country=AE is strongly recommended. Datacenter proxies often produce empty pages - residential IPs (especially UAE) give the most reliable results." }, "resumeFromRunId": { "title": "Resume from a prior run", "type": "string", "description": "Optional. Paste a previous run ID or dataset ID to continue a large walk-all pull: listings already saved by that run are loaded before scraping starts and skipped, so this run only appends new listings. For recurring daily monitoring of the same search, use Incremental mode below instead. Leave empty for a normal fresh run." }, "incrementalMode": { "title": "Incremental changes for scheduled runs", "type": "boolean", "description": "Turn this on for daily or recurring monitoring of the SAME search. The first run returns all matching listings as NEW. Later runs normally return only NEW, UPDATED, and REAPPEARED listings. Turn on \"Emit unchanged\" or \"Emit expired\" only when you also want those listings returned (and billed). State is kept separately per city/filters/URL and fetchDetails setup; use State key when you want to name or deliberately share a monitoring campaign. To continue one specific interrupted run instead, use Resume from a prior run above.", "default": false }, "stateKey": { "title": "State key (optional, incremental mode only)", "type": "string", "description": "Optional. Name this monitoring campaign to keep its state stable, or to deliberately share state across differently-configured runs. Leave empty to let the actor derive a key automatically from the city/filters/URL and fetchDetails settings — different searches then never mix state with each other." }, "emitUnchanged": { "title": "Emit unchanged listings (incremental mode only)", "type": "boolean", "description": "Off by default. Turn on to also return listings that have not changed since the last run, marked UNCHANGED. This returns — and bills — extra rows you already have, so leave it off unless you specifically want the full snapshot every run.", "default": false }, "emitExpired": { "title": "Emit expired listings (incremental mode only)", "type": "boolean", "description": "Off by default. Turn on to also return listings that were present in a previous run but are no longer found, marked EXPIRED. Only produced once a run has fully scanned every tracked search — not when Max total listings or Max result pages capped it, when a block stopped a search early, or when Resume was used. This returns — and bills — extra synthetic rows, so leave it off unless you need expiry tracking.", "default": false }, "ignoreFieldsForChanges": { "title": "Ignore fields when detecting changes (incremental mode only)", "type": "array", "description": "Optional. Field names excluded from change detection in incremental mode, matched at any nesting depth. A listing whose ONLY differences are in these fields still classifies UNCHANGED and is never returned/billed as UPDATED for them. Added ON TOP OF \"scrapedAt\" (the per-fetch timestamp this actor stamps on every listing, which always differs and is never a real content change) - scrapedAt stays ignored no matter what you put here. Add a field name here if you find one that rotates on every scrape without the listing actually changing.", "items": { "type": "string" }, "default": [ "scrapedAt" ] }, "mcpConnectors": { "title": "Pipe results into your apps (optional)", "type": "array", "description": "Optionally send the scraped results into the apps you already use, via Model Context Protocol (MCP) connectors. Authorize a connector once under Apify → Settings → Integrations, then select it here. The connector receives a condensed, human-readable summary per item (title + key fields), not the full JSON; the complete record stays in the dataset. Leave empty to skip. Supported: Notion (https://mcp.notion.com/mcp), Linear (https://mcp.linear.app/sse), Airtable (https://mcp.airtable.com/mcp), Apify (https://mcp.apify.com)." }, "notionParentPageUrl": { "title": "Notion parent page (Notion connector only)", "type": "string", "description": "URL (or id) of the Notion page under which item pages are created. Required to enable the Notion export; ignored by other connectors." }, "maxNotifyListings": { "title": "Max items to export per connector", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap on items written to each connector per run. Does not affect the dataset.", "default": 50 } } }, "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 } } } } } } } } } }