Bayut Python API Docs | dltHub

Bayut API is a property finder API that scrapes and returns structured real estate data from bayut.com for UAE properties, agencies, agents, developers, transactions, amenities, floorplans and related resources. The REST API base URL is https://uae-real-estate2.p.rapidapi.com and All requests require a RapidAPI key passed in request headers.

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Bayut data in under 10 minutes.

---

What data can I load from Bayut?

Here are some of the endpoints you can load from Bayut:

---

How do I authenticate with the Bayut API?

Authentication is via the RapidAPI platform: include your RapidAPI key in the request headers (x-rapidapi-key) and the RapidAPI host header (x-rapidapi-host) when calling the base URL.

1. Get your credentials

1. Sign in or create an account on RapidAPI (https://rapidapi.com).
2. Subscribe to the Bayut API (listed as "Bayut API" / "uae-real-estate2" on RapidAPI marketplace).
3. In the RapidAPI dashboard for the subscribed API, copy the provided API key (x-rapidapi-key).
4. Use that key in request headers for API calls.

2. Add them to .dlt/secrets.toml

Copy
[sources.bayut_api_source]
api_key = "your_rapidapi_key_here"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.

---

How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

Copy
uv venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

Copy
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

Copy
dlt ai toolkit rest-api-pipeline install

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the Bayut API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

Copy
python bayut_api_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline bayut_api_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset bayut_api_data
The duckdb destination used duckdb:/bayut_api.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
dlt pipeline bayut_api_pipeline show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.

---

Python pipeline example

This example loads properties_search and locations_search from the Bayut API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def bayut_api_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://uae-real-estate2.p.rapidapi.com",
            "auth": {
                "type": "api_key",
                "api_key": api_key,
            },
        },
        "resources": [
            {"name": "properties_search", "endpoint": {"path": "properties_search", "data_selector": "results"}},
            {"name": "locations_search", "endpoint": {"path": "locations_search?query={query}", "data_selector": "results"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="bayut_api_pipeline",
        destination="duckdb",
        dataset_name="bayut_api_data",
    )
    load_info = pipeline.run(bayut_api_source())
    print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.

---

How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("bayut_api_pipeline").dataset()
sessions_df = data.locations_search.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM bayut_api_data.locations_search LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("bayut_api_pipeline").dataset()
data.locations_search.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.

---

What destinations can I load Bayut data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Troubleshooting

Authentication failures

If you receive 401 or 403 errors, verify you are using a valid RapidAPI subscription key and that headers include x-rapidapi-key (your API key) and x-rapidapi-host (uae-real-estate2.p.rapidapi.com). Ensure your RapidAPI subscription is active.

Rate limits and quotas

Requests are governed by your RapidAPI subscription plan. If you receive 429 responses, back off and check your RapidAPI dashboard limits or upgrade your plan.

Pagination

Most list endpoints return a top-level "results" array together with pagination fields such as "count" and "page". Use the page parameter (commonly starting at 0 or 1 per endpoint docs) to iterate pages.

Endpoint‑specific response shapes

• Many search/list endpoints return an object with a "results" array (e.g., properties_search, locations_search, agencies_by_name, agents_by_name, developers_search, amenities_search, transactions).
• floorplans returns either a "floorplans" array (when specific) or "child_locations" array (when location is broader).
• Single‑resource endpoints (property, agency, agent) return a single JSON object with the resource fields, not wrapped in "results".

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.

---

Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-runtime — Deploy, schedule, and monitor your pipeline in production.

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack