Skip to content
Scrappa Get API key
Bayut API 1 credit/request

Bayut Locations API Documentation

GET https://scrappa.co/api/bayut/locations?query=Dubai+Marina

Look up the Bayut location tree by name: emirates, communities and buildings, with the numeric id used by the search location filter, the public slug and url, the parent hierarchy, the live listing count and the coordinates. A valid empty result is a successful response.

Bayut Locations API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/bayut/locations?query=Dubai+Marina
Auth header
x-api-key
Cost
1 credit/request
query = Dubai Marina
Response preview
200 OK
{
    "success": true,
    "data": {
        "locations": [
            {
                "external_id": "5003",
                "name": "Dubai Marina",
                "slug": "/dubai/dubai-marina",
                "url": "https://www.bayut.com/dubai/dubai-marina",
                "type": "neighbourhood",
                "ad_count": 10083,
                "has_children": true,
                "level": 2,
                "hierarchy": [
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

3 optional filters available.

query string Required

Location name, e.g. Dubai Marina.

Example value Dubai Marina
level integer Optional

1 = emirate, 2 = community, 3 = building.

Example value 10
page integer Optional

Zero-based page number. Defaults to 0.

Example value 1
limit integer Optional

Locations per page, 1 to 50. Defaults to 20.

Example value 10

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/bayut/locations?query=Dubai+Marina",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-api-key: YOUR_API_KEY_HERE"
    ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
PHP
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/bayut/locations?query=Dubai+Marina');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
JavaScript
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/bayut/locations?query=Dubai+Marina', options)
    .then(response => {
        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return response.text();
    })
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/bayut/locations?query=Dubai+Marina',
    headers: {
        x-api-key: 'YOUR_API_KEY_HERE',
    }
};

try {
    const response = await axios(options);
    console.log(response.data);
} catch (error) {
    console.error('Error:', error.message);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/bayut/locations?query=Dubai+Marina")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'

request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'

begin
    response = http.request(request)
    puts response.body
rescue => e
    puts "Error: #{e.message}"
end
Python
import http.client
import json

conn = http.client.HTTPSConnection("scrappa.co")

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    conn.request("GET", "/api/bayut/locations?query=Dubai+Marina", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
Python
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/bayut/locations?query=Dubai+Marina', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class ApiExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("https://scrappa.co/api/bayut/locations?query=Dubai+Marina")
        .addHeader("x-api-key", "YOUR_API_KEY_HERE")
            .build();

        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.out.println("Error: " + response.code());
            }
        } catch (IOException e) {
            System.out.println("Error: " + e.getMessage());
        }
    }
}
Go
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/bayut/locations?query=Dubai+Marina", nil)
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }
    req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")

    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error making request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }

    fmt.Println(string(body))
}
Terminal
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/bayut/locations?query=Dubai+Marina"
C#
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");

        try
        {
            var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/bayut/locations?query=Dubai+Marina"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/bayut/locations?query=Dubai+Marina',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
RUST
use reqwest::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    let response = client
        .get("https://scrappa.co/api/bayut/locations?query=Dubai+Marina")
        .header("x-api-key", "YOUR_API_KEY_HERE")
        .send()
        .await?;

    println!("{}", response.text().await?);

    Ok(())
}

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

success data meta
JSON Response
200 OK
{
    "success": true,
    "data": {
        "locations": [
            {
                "external_id": "5003",
                "name": "Dubai Marina",
                "slug": "/dubai/dubai-marina",
                "url": "https://www.bayut.com/dubai/dubai-marina",
                "type": "neighbourhood",
                "ad_count": 10083,
                "has_children": true,
                "level": 2,
                "hierarchy": [
                    "UAE",
                    "Dubai",
                    "Dubai Marina"
                ],
                "latitude": 25.083189748036,
                "longitude": 55.14430056087
            }
        ]
    },
    "meta": {
        "endpoint_family": "locations",
        "billable": true,
        "pagination": {
            "page": 0,
            "limit": 20,
            "total": 778,
            "has_more": true,
            "next_page": 1,
            "truncated": false
        }
    }
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A public parameter or range is invalid. This response is not billable.

{
    "errors": {
        "limit": [
            "The limit may not exceed 50 listings."
        ]
    },
    "message": "The request validation failed"
}
502

Invalid Source Response

Bayut returned an unexpected response shape. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "locations"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "Bayut returned an unexpected response."
    },
    "success": false
}
503

Service Unavailable

The transport or Bayut was unavailable after retries. This response is not billable and is safe to retry.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "locations"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "The Bayut API is temporarily unavailable. Please retry."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.