# Bayut \[Just 💰$0.8] — UAE Property Listings & Agents (`blackfalcondata/bayut-scraper`) Actor

💰 $0.80 per 1,000 rows across the UAE, Saudi Arabia, Qatar, Oman and Jordan. Scrape Bayut property listings plus agents and agencies from one actor — every row arrives structured with price, location and direct agent contact including email, ready to use.

- **URL**: https://apify.com/blackfalcondata/bayut-scraper.md
- **Developed by:** [Black Falcon Data](https://apify.com/blackfalcondata) (community)
- **Categories:** Real estate, Lead generation, Automation
- **Stats:** 3 total users, 3 monthly users, 85.7% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.80 / 1,000 results

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

### What does Bayut do?

Bayut extracts structured property data from [bayut.com](https://bayut.com) — including contact details, prices, and location data. It supports keyword search, location filters, and controllable result limits, so you can run the same query consistently over time. The actor also offers detail enrichment (full descriptions and contact information) where the source provides them.

**New to Apify?** [Sign up free](https://console.apify.com/sign-up?fpr=1h3gvi\&fp_sid=ctaplain) and use the included $5 monthly platform credit to test this actor.

### Key features

- **🌎 5-market coverage** — 5 markets supported on one codebase — bayut.com, bayut.sa, bayut.qa, and 2 more. Pick a country per run with the `country` input, or schedule parallel runs to compare pricing across regions.
- **🗂️ Listings, agents & agencies in one actor** — paste any Bayut URL — property search, /companies/ or /brokers/ — and each is auto-routed. Every row is tagged rowType (listing / company / broker) so mixed runs stay separable in one dataset.
- **👥 Live agent database, email included** — pull UAE and Saudi agents from Bayut's live index — name, agency, email, phone and WhatsApp on every agent, email at no extra charge. Filter by agency name or contact channel.
- **🇸🇦 Saudi REGA licence data** — every bayut.sa row carries regaBrokerageLicenseNumber — the REGA FAL licence, a cross-portal join key for Saudi lead-gen — plus its expiry.
- **📧 Email + phone extraction** — best-effort regex extraction of contact emails and phone numbers from descriptions — emitted as `extractedEmails[]` and `extractedPhones[]` on every record.
- **🔗 Paste-mode** — paste any bayut.com URL — single-listing pages, search-results, or category SEO URLs. Build the filter you want in the browser, copy, paste; the actor parses every query param.
- **🌐 Arabic & English URLs** — paste Bayut URLs in either language — Arabic purpose, category and location normalize automatically, so browser copy-paste just works.
- **♻️ Incremental mode** — recurring runs emit and charge only for listings that are new or changed — later runs emit only NEW / UPDATED / REAPPEARED. Pair with notifications.
- **📦 Compact mode** — light payload with core fields only — comparable rows across listings without HTML or metadata overhead. Perfect for pricing dashboards.

### What data can you extract from bayut.com?

Each result includes Core property fields (`listingId`, `listingKey`, `referenceNumber`, `title`, `purpose`, `propertyType`, `propertyCategory`, and `location`, and more), detail fields when enrichment is enabled (`detailFetched`), and contact information (`phoneMobile`, `phonePhone`, `phoneWhatsapp`, and `phoneProxy`). In standard mode, all fields are always present — unavailable data points are returned as `null`, never omitted. In compact mode, only core fields are returned.

Enable detail enrichment in the input to get richer fields such as full descriptions and contact information where the source provides them.

### Input

The main inputs are a search keyword, an optional location filter, and a result limit. Additional filters and options are available in the input schema.

Key parameters:

- **`startUrls`** — Paste Bayut URLs from any country site (.com/.sa/.qa/.om/.jo) — property search, /companies/ or /brokers/ URLs. Each becomes its own search; every row is tagged rowType (listing/company/broker). These REPLACE the structured filters below. (default: `[]`)
- **`country`** — Which Bayut country site to search with the structured filters below. Ignored for Start URLs (they pick their country from the URL host). (default: `"ae"`)
- **`instantDatabase`** — Return agents (brokers) with name, agency, email, phone and WhatsApp — no URL needed. Uses the Country above (UAE or Saudi only). (default: `false`)
- **`dbAgencyName`** — Only agents at agencies matching this name (e.g. "Betterhomes"; all branches).
- **`dbHasEmail`** — Keep only agents with an email. (default: `false`)
- **`dbHasPhone`** — Keep only agents with a phone. (default: `false`)
- **`dbHasWhatsapp`** — Keep only agents with WhatsApp. (default: `false`)
- **`location`** — Emirate, city or community — e.g. "Dubai", "Dubai Marina", "Business Bay". Matched to Bayut's location list; covers all sub-communities. Accepts an exact slug like "/dubai/dubai-marina", or a JSON array for several areas.
- **`query`** — Optional free-text keyword to narrow results within the selected location — e.g. "sea view", "maids room", a building or project name. Leave empty to return all listings for the filters.
- **`purpose`** — For-sale or for-rent listings. (default: `"for-rent"`)
- **`propertyType`** — Restrict to one property type. Leave empty for all types. (default: `""`)
- **`priceMin`** — Minimum price, in the selected country's local currency (AED, SAR, QAR, OMR or JOD). For rentals this is per the selected rent frequency.
- ...and 34 more parameters

### Input examples

**Property listings across markets** — Paste search URLs from any Bayut country site — English or Arabic. Each URL is its own search; results merge and de-duplicate.

→ listing rows (rowType: "listing") with price, local currency, location, beds/baths, agency and direct agent contact.

```json
{
  "startUrls": [
    "https://www.bayut.com/for-sale/apartments/dubai/",
    "https://www.bayut.sa/en/to-rent/villas/riyadh/"
  ],
  "maxResults": 500
}
```

**Structured search + monitor new listings** — Pick a country and area with the built-in filters, and turn on Incremental mode to emit only new or changed listings each run.

→ new/updated listings for the selected market, each tagged with a changeType.

```json
{
  "country": "sa",
  "location": "Riyadh",
  "purpose": "for-sale",
  "incrementalMode": true,
  "maxResults": 200
}
```

**Agencies (companies)** — A /companies/ directory URL returns every agency for the market; a company detail URL returns just that agency.

→ company rows (rowType: "company") with licences, agent count, portfolio stats and logo.

```json
{
  "startUrls": [
    "https://www.bayut.com/companies/dubai"
  ],
  "maxResults": 200
}
```

**Agents (brokers) — UAE & Saudi** — Paste a /brokers/ profile or directory URL. Agent rows include the agent's email at no extra charge.

→ broker rows (rowType: "broker") with email, phone, WhatsApp, specialities, service areas and agency.

```json
{
  "startUrls": [
    "https://www.bayut.com/brokers/sheetal-sureen-749540"
  ],
  "maxResults": 50
}
```

**Agent database — build a lead list** — No URL needed. Serve agents live from Bayut's index, filtered by agency name and contact channel (UAE & Saudi).

→ broker rows for the chosen agency that have an email on file.

```json
{
  "instantDatabase": true,
  "country": "ae",
  "dbAgencyName": "Betterhomes",
  "dbHasEmail": true,
  "maxResults": 200
}
```

### Output

Each run produces a dataset of structured property records. Results can be downloaded as JSON, CSV, or Excel from the Dataset tab in Apify Console.

### Example property record

```json
{
  "listingId": "3852f411bd0d95b48df85a3ee2b74ff56d8418c9396397290934eb973af8d8f8",
  "listingKey": "15896928",
  "referenceNumber": "4799-ZMfoHS",
  "title": "Modern 2BR | Fully Furnished | High Floor| Vacant",
  "purpose": "for-rent",
  "propertyType": "apartments",
  "propertyCategory": "residential",
  "location": "UAE > Dubai > Dubai Marina > The Torch",
  "city": "Dubai",
  "neighbourhood": "The Torch",
  "locationTree": [
    {
      "name": "UAE",
      "slug": "/uae",
      "externalID": "5001",
      "level": 0
    },
    {
      "name": "Dubai",
      "slug": "/dubai",
      "externalID": "5002",
      "level": 1
    },
    {
      "name": "Dubai Marina",
      "slug": "/dubai/dubai-marina",
      "externalID": "5003",
      "level": 2
    },
    {
      "name": "The Torch",
      "slug": "/dubai/dubai-marina/the-torch",
      "externalID": "5071",
      "level": 3
    }
  ],
  "latitude": 25.0879001617432,
  "longitude": 55.1473999023438,
  "priceValue": 135000,
  "priceCurrency": "AED",
  "priceText": "AED 135,000",
  "rentFrequency": "yearly",
  "beds": 2,
  "baths": 2,
  "areaSqm": 116.87,
  "areaSqft": 1258,
  "furnishingStatus": "furnished",
  "completionStatus": "ready",
  "amenities": [
    "Gym or Health Club",
    "Swimming Pool",
    "Cafeteria or Canteen",
    "Kids Play Area",
    "Lawn or Garden",
    "... 5 more items"
  ],
  "agencyName": "Union Square House Real Estate",
  "agencyId": "4799",
  "agentName": "Ihar Churylau",
  "phoneMobile": "+971585424003",
  "phonePhone": "+97158542400",
  "phoneWhatsapp": "971545695868",
  "phoneProxy": "+97148750973",
  "isVerified": false,
  "photoCount": 12,
  "videoCount": 0,
  "panoramaCount": 0,
  "coverPhotoUrl": "https://images.bayut.com/thumbnails/853770448-800x600.jpeg",
  "photoUrls": [
    "https://images.bayut.com/thumbnails/853770448-800x600.jpeg",
    "https://images.bayut.com/thumbnails/853770449-800x600.jpeg",
    "https://images.bayut.com/thumbnails/853770450-800x600.jpeg",
    "https://images.bayut.com/thumbnails/853770451-800x600.jpeg",
    "https://images.bayut.com/thumbnails/853770452-800x600.jpeg",
    "... 7 more items"
  ],
  "createdAt": "2026-07-20T15:16:28.000Z",
  "updatedAt": "2026-07-20T15:16:32.000Z",
  "publishedAt": "2026-07-20T15:16:28.000Z",
  "url": "https://www.bayut.com/property/details-15896928.html",
  "contentQuality": "serp_only",
  "detailFetched": false,
  "contentHash": "8a3b75d",
  "scrapedAt": "2026-07-20T12:00:00.000Z",
  "source": "bayut.com"
}
```

### Incremental fields

When incremental mode is on, each record also carries:

- `changeType` — one of `NEW`, `UPDATED`, `UNCHANGED`, `REAPPEARED`, `EXPIRED`. Default output covers `NEW` / `UPDATED` / `REAPPEARED`; set `emitUnchanged: true` or `emitExpired: true` to opt into the others.
- `isRepost`, `repostOfId`, `repostDetectedAt` — populated when a new listing matches the tracked content of a previously expired one. Set `skipReposts: true` to drop detected reposts from the output.

### How to scrape bayut.com

1. Go to [Bayut](https://apify.com/blackfalcondata/bayut-scraper?fpr=1h3gvi) in Apify Console.
2. Enter a search keyword and optional location filter.
3. Set `maxResults` to control how many results you need.
4. Enable `includeDetails` if you need full descriptions, contact info.
5. Click **Start** and wait for the run to finish.
6. Export the dataset as JSON, CSV, or Excel.

### Use cases

- Extract property data from bayut.com for market research and competitive analysis.
- Track pricing trends across regions and categories over time.
- Monitor new and changed properties on scheduled runs without processing the full dataset every time.
- Use structured location data for regional analysis, mapping, and geo-targeting.
- Feed structured data into AI agents, MCP tools, and automated pipelines using compact mode.
- Export clean, structured data to dashboards, spreadsheets, or data warehouses.

### How much does it cost to scrape bayut.com?

Bayut uses [pay-per-event](https://docs.apify.com/platform/actors/paid-actors/pay-per-event) pricing. You pay a small fee when the run starts and then for each result that is actually produced.

- **Run start:** $0.005 per run
- **Per result:** $0.0008 per property record

Example costs:

- 10 results: **$0.013**
- 25 results: **$0.025**
- 100 results: **$0.085**
- 200 results: **$0.17**
- 500 results: **$0.41**

#### Example: recurring monitoring savings

These examples compare full re-scrapes with incremental runs at different churn rates. Churn is the share of properties that are new or whose tracked content changed since the previous run. Actual churn depends on your query breadth, source activity, and polling frequency — the scenarios below are examples, not predictions.

Example setup: 250 properties per run, daily polling (30 runs/month). Costs scale linearly with the number of properties.

| Churn rate | Full re-scrape run cost | Incremental run cost | Savings vs full re-scrape | Monthly cost after baseline |
|---|---:|---:|---:|---:|
| 5% — stable niche query | $0.21 | $0.01 | $0.19 (93%) | $0.45 |
| 15% — moderate broad query | $0.21 | $0.04 | $0.17 (83%) | $1.05 |
| 30% — high-volume aggregator | $0.21 | $0.07 | $0.14 (68%) | $1.95 |

Full re-scrape monthly cost at the same cadence: $6.15. First month with incremental costs $0.64 / $1.22 / $2.09 for the 5% / 15% / 30% scenarios because the first run builds baseline state at full cost before incremental savings apply.

Platform usage is included in the per-result fee shown above.

### FAQ

#### How many results can I get from bayut.com?

The number of results depends on the search query and available properties on bayut.com. Use the `maxResults` parameter to control how many results are returned per run.

#### Does Bayut support recurring monitoring?

Yes. Enable incremental mode to only receive new or changed properties on subsequent runs. This is ideal for scheduled monitoring where you want to track changes over time without re-processing the full dataset.

#### Can I integrate Bayut with other apps?

Yes. Bayut works with Apify's [integrations](https://apify.com/integrations?fpr=1h3gvi) to connect with tools like Zapier, Make, Google Sheets, Slack, and more. You can also use webhooks to trigger actions when a run completes.

#### Can I use Bayut with the Apify API?

Yes. You can start runs, manage inputs, and retrieve results programmatically through the [Apify API](https://docs.apify.com/api/v2). Client libraries are available for JavaScript, Python, and other languages.

#### Can I use Bayut through an MCP Server?

Yes. Apify provides an [MCP Server](https://apify.com/apify/actors-mcp-server?fpr=1h3gvi) that lets AI assistants and agents call this actor directly. Use compact mode, a single `descriptionFormat`, and `excludeEmptyFields` to keep payloads manageable for LLM context windows.

#### Is it legal to scrape bayut.com?

This actor extracts publicly available data from bayut.com. Web scraping of public information is generally considered legal, but you should always review the target site's terms of service and ensure your use case complies with applicable laws and regulations, including GDPR where relevant.

#### Your feedback

If you have questions, need a feature, or found a bug, please [open an issue](https://apify.com/blackfalcondata/bayut-scraper/issues?fpr=1h3gvi) on the actor's page in Apify Console. Your feedback helps us improve.

### You might also like

- [Airbnb \[Just 💰$0.4\] — Listings, Prices & Host Data](https://apify.com/blackfalcondata/airbnb-scraper?fpr=1h3gvi) — 💰 $0.4 per 1,000 listings. Scrape airbnb.com — stays with price · ratings · amenities · host info.
- [Airbnb Realtime API — Live Listing, Reviews & Search Lookups](https://apify.com/blackfalcondata/airbnb-realtime?fpr=1h3gvi) — Real-time Airbnb lookups via a persistent standby server — fetch a single listing, its reviews.
- [Airbnb URL Finder — listing discovery](https://apify.com/blackfalcondata/airbnb-url-scraper?fpr=1h3gvi) — Scrape airbnb.com — enumerate every listing URL for a city or neighborhood · return listing id URL.
- [Craigslist \[Just 💰$1\] — classifieds listings](https://apify.com/blackfalcondata/craigslist-scraper?fpr=1h3gvi) — 💰 $1 per 1,000 listings. Scrape craigslist.org — for-sale housing & jobs · gigs & services.
- [Domain.com.au \[Just 💰$0.05\] — Property Listings & Agents](https://apify.com/blackfalcondata/domain-com-au-scraper?fpr=1h3gvi) — Domain.com.au property scraper for Australian real estate — extract for-sale, rental, and sold.
- [HAR \[Just 💰$1.5\] — Texas Real Estate](https://apify.com/blackfalcondata/har-scraper?fpr=1h3gvi) — 💰 $1.5 per 1,000 listings. Scrape har.com — the largest Texas MLS portal — homes for sale · rent.
- [Harcourts \[Just 💰$1.5\] — real estate listings](https://apify.com/blackfalcondata/harcourts-scraper?fpr=1h3gvi) — 💰 $1.5 per 1,000 listings. Scrape harcourts.net — property across Australia New Zealand & Fiji ·.
- [Idealista Scraper — Listings, Phone & Agency Data](https://apify.com/blackfalcondata/idealista-scraper?fpr=1h3gvi) — Scrape Idealista listings across Spain, Portugal, and Italy with full pricing, photos, GPS, agent.

### Getting started with Apify

New to Apify? [Create a free account with $5 credit](https://console.apify.com/sign-up?fpr=1h3gvi\&fp_sid=ctaplain) — no credit card required.

1. Sign up — $5 platform credit included
2. Open this actor and configure your input
3. Click **Start** — export results as JSON, CSV, or Excel

Need more later? [See Apify pricing](https://apify.com/pricing?fpr=1h3gvi).

### Disclaimer

This actor accesses only publicly available data on bayut.com. You are responsible for how you use the extracted data — in particular any personal information such as names, phone numbers, or email addresses — and for complying with Bayut's terms of use, applicable data-protection law (including the GDPR where it applies), and the anti-spam rules of your jurisdiction.

This actor is not affiliated with, endorsed by, or connected to Bayut.

### Search keywords

bayut scraper, bayut api, apify bayut, bayut data extraction, bayut.com scraper, bayut.com data, bayut.com api, bayut.sa scraper, bayut.qa scraper, bayut.om scraper, bayut.jo scraper, bayut united arab emirates, bayut united arab emirates scraper, bayut saudi arabia, bayut saudi arabia scraper, bayut qatar, bayut qatar scraper, bayut oman, bayut oman scraper, bayut jordan, bayut jordan scraper, property listings scraper, real estate data, property data, bayut uae scraper, dubai real estate scraper, abu dhabi real estate scraper, riyadh real estate data, jeddah property listings, amman property listings, doha real estate scraper, muscat property data, uae property scraper, ksa real estate data, gcc real estate data, middle east property data, bayut agent scraper, bayut agency scraper, bayut property data, bayut listings export json csv.

# Actor input Schema

## `startUrls` (type: `array`):

Paste Bayut URLs from any country site (.com/.sa/.qa/.om/.jo) — property search, /companies/ or /brokers/ URLs. Each becomes its own search; every row is tagged rowType (listing/company/broker). These REPLACE the structured filters below.

## `country` (type: `string`):

Which Bayut country site to search with the structured filters below. Ignored for Start URLs (they pick their country from the URL host).

## `instantDatabase` (type: `boolean`):

Return agents (brokers) with name, agency, email, phone and WhatsApp — no URL needed. Uses the Country above (UAE or Saudi only).

## `dbAgencyName` (type: `string`):

Only agents at agencies matching this name (e.g. "Betterhomes"; all branches).

## `dbHasEmail` (type: `boolean`):

Keep only agents with an email.

## `dbHasPhone` (type: `boolean`):

Keep only agents with a phone.

## `dbHasWhatsapp` (type: `boolean`):

Keep only agents with WhatsApp.

## `location` (type: `string`):

Emirate, city or community — e.g. "Dubai", "Dubai Marina", "Business Bay". Matched to Bayut's location list; covers all sub-communities. Accepts an exact slug like "/dubai/dubai-marina", or a JSON array for several areas.

## `query` (type: `string`):

Optional free-text keyword to narrow results within the selected location — e.g. "sea view", "maids room", a building or project name. Leave empty to return all listings for the filters.

## `purpose` (type: `string`):

For-sale or for-rent listings.

## `propertyType` (type: `string`):

Restrict to one property type. Leave empty for all types.

## `priceMin` (type: `integer`):

Minimum price, in the selected country's local currency (AED, SAR, QAR, OMR or JOD). For rentals this is per the selected rent frequency.

## `priceMax` (type: `integer`):

Maximum price, in the selected country's local currency.

## `bedsMin` (type: `integer`):

Minimum number of bedrooms (0 = studio).

## `bathsMin` (type: `integer`):

Minimum number of bathrooms.

## `furnishingStatus` (type: `string`):

Filter by furnishing status.

## `rentFrequency` (type: `string`):

Rentals only — filter by contract frequency.

## `completionStatus` (type: `string`):

Ready (completed) or off-plan (under construction).

## `sortBy` (type: `string`):

Ordering of results.

## `language` (type: `string`):

Language of titles and localized fields.

## `lat` (type: `number`):

GPS latitude of the search centre. Pair with Longitude and Search Radius to keep only listings within that radius of this point.

## `lon` (type: `number`):

GPS longitude of the search centre. Pair with Latitude.

## `radiusKm` (type: `integer`):

Keep only listings within this many kilometres of the (Latitude, Longitude) centre. Listings whose coordinates are unknown are always kept.

## `maxResults` (type: `integer`):

Maximum listings to return (0 = as many as available). A single filter combination can return up to ~50,000 listings; narrow by community or price to go deeper.

## `compact` (type: `boolean`):

Return only the core fields (id, title, price, beds/baths, location, contact) instead of the full record.

## `excludeEmptyFields` (type: `boolean`):

Omit fields that are null or empty from each record.

## `incrementalMode` (type: `boolean`):

Only emit listings that are new or changed since the previous run with the same filters. Tracks state across runs.

## `stateKey` (type: `string`):

Advanced: override the automatic incremental state key. Leave empty to derive it from the filters.

## `emitUnchanged` (type: `boolean`):

In incremental mode, also emit listings that were seen before and are unchanged.

## `emitExpired` (type: `boolean`):

In incremental mode, emit a record for listings that disappeared since the last full run.

## `skipReposts` (type: `boolean`):

In incremental mode, skip listings detected as reposts of an earlier one.

## `telegramToken` (type: `string`):

Optional — send new listings to Telegram.

## `telegramChatId` (type: `string`):

Chat ID to deliver Telegram notifications to.

## `discordWebhookUrl` (type: `string`):

Optional — post new listings to a Discord channel.

## `slackWebhookUrl` (type: `string`):

Optional — post new listings to a Slack channel.

## `webhookUrl` (type: `string`):

Optional — POST new listings as JSON to your own endpoint.

## `notificationLimit` (type: `integer`):

Maximum listings to include per notification batch.

## `notifyOnlyChanges` (type: `boolean`):

Only send notifications for new/changed listings (incremental mode).

## `appConnector` (type: `string`):

Optional. Pick a connected app under Settings → API & Integrations to receive your results. Notion is supported today (a run-summary page); other connectors are best-effort as Apify expands its catalog.

## `mcpIssueTeam` (type: `string`):

Only when the connected app is an issue tracker: the team (name or ID) the summary is created under, if that app requires one.

## `whatsappAccessToken` (type: `string`):

WhatsApp Cloud API access token from Meta Business Manager. The recipient must have messaged your business number within the last 24 hours.

## `whatsappPhoneNumberId` (type: `string`):

WhatsApp Business phone number ID (numeric, from Meta dashboard). Required when whatsappAccessToken is set.

## `whatsappTo` (type: `string`):

Recipient phone number in E.164 format without + (e.g. "33612345678"). Recipient must have messaged your business number within the last 24 hours.

## `webhookHeaders` (type: `object`):

Optional JSON object of custom HTTP headers for the webhook POST (e.g. {"Authorization":"Bearer ..."}).

## `descriptionFormat` (type: `string`):

Choose which representation of the listing description to include. `all` keeps every variant; the others keep only the selected one.

## `includeDetails` (type: `boolean`):

Fetch the detail page for each listing to retrieve the full description text and contact information. Increases run time and cost. Leave off for a fast, low-cost run.

## Actor input object example

```json
{
  "startUrls": [],
  "country": "ae",
  "instantDatabase": false,
  "dbHasEmail": false,
  "dbHasPhone": false,
  "dbHasWhatsapp": false,
  "location": "Dubai Marina",
  "purpose": "for-rent",
  "propertyType": "",
  "furnishingStatus": "any",
  "rentFrequency": "",
  "completionStatus": "",
  "sortBy": "default",
  "language": "en",
  "maxResults": 50,
  "compact": false,
  "excludeEmptyFields": false,
  "incrementalMode": false,
  "emitUnchanged": false,
  "emitExpired": false,
  "skipReposts": false,
  "notificationLimit": 5,
  "notifyOnlyChanges": false,
  "descriptionFormat": "all",
  "includeDetails": false
}
```

# Actor output Schema

## `results` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "startUrls": [],
    "location": "Dubai Marina",
    "maxResults": 50,
    "descriptionFormat": "all",
    "includeDetails": false
};

// Run the Actor and wait for it to finish
const run = await client.actor("blackfalcondata/bayut-scraper").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "startUrls": [],
    "location": "Dubai Marina",
    "maxResults": 50,
    "descriptionFormat": "all",
    "includeDetails": False,
}

# Run the Actor and wait for it to finish
run = client.actor("blackfalcondata/bayut-scraper").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "startUrls": [],
  "location": "Dubai Marina",
  "maxResults": 50,
  "descriptionFormat": "all",
  "includeDetails": false
}' |
apify call blackfalcondata/bayut-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=blackfalcondata/bayut-scraper",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/hdKt8qGfwUccWmddC/builds/UeMZj2xtO8O3nGGEC/openapi.json