List the current property inventory of one agency with the same listing-card shape as search, plus optional purpose and sort filters and pagination. A valid empty inventory is a successful response.
Run this endpoint
Endpoint
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.
4 optional filters available.
string
Required
Numeric agency id returned by the agency endpoint, e.g. 6168.
6168
string
Optional
for-sale or for-rent.
example
string
Optional
default, price-asc, price-desc, date-desc, v6-score or verified-score. Defaults to default.
relevance
integer
Optional
Zero-based page number. Defaults to 0.
1
integer
Optional
Listings per page, 1 to 50. Defaults to 20.
20
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/bayut/agency-listings?agency_external_id=6168&limit=20",
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
use Illuminate\Support\Facades\Http;
$response = Http::timeout(30)
->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
->get('https://scrappa.co/api/bayut/agency-listings?agency_external_id=6168&limit=20');
if ($response->successful()) {
echo $response->body();
} else {
echo "Error: " . $response->status();
}
const options = {
method: 'GET',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE'
}
};
fetch('https://scrappa.co/api/bayut/agency-listings?agency_external_id=6168&limit=20', 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));
const axios = require('axios');
const options = {
method: 'GET',
url: 'https://scrappa.co/api/bayut/agency-listings?agency_external_id=6168&limit=20',
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);
}
require 'net/http'
require 'uri'
uri = URI.parse("https://scrappa.co/api/bayut/agency-listings?agency_external_id=6168&limit=20")
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
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/agency-listings?agency_external_id=6168&limit=20", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
except Exception as e:
print(f"Error: {e}")
finally:
conn.close()
import requests
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
response = requests.get('https://scrappa.co/api/bayut/agency-listings?agency_external_id=6168&limit=20', headers=headers)
response.raise_for_status()
print(response.text)
except requests.exceptions.RequestException as e:
print(f"Error: {e}")
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/agency-listings?agency_external_id=6168&limit=20")
.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());
}
}
}
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
client := &http.Client{}
req, err := http.NewRequest("GET", "https://scrappa.co/api/bayut/agency-listings?agency_external_id=6168&limit=20", 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))
}
#!/bin/bash
curl -X GET \
-H "x-api-key: YOUR_API_KEY_HERE" \
"https://scrappa.co/api/bayut/agency-listings?agency_external_id=6168&limit=20"
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/agency-listings?agency_external_id=6168&limit=20"));
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
catch (Exception ex)
{
Console.WriteLine($"Error: {ex.Message}");
}
}
}
import axios from 'axios';
async function run(): Promise<void> {
try {
const response = await axios({
method: 'GET',
url: 'https://scrappa.co/api/bayut/agency-listings?agency_external_id=6168&limit=20',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE',
},
});
console.log(response.data);
} catch (error) {
console.error('Error:', error);
}
}
void run();
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/agency-listings?agency_external_id=6168&limit=20")
.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
{
"success": true,
"data": {
"listings": [
{
"id": "16769627",
"title": "Spacious Layout | Fully Furnished | Prime Location",
"url": "https://www.bayut.com/property/details-16769627.html",
"purpose": "for-rent",
"rooms": 3,
"baths": 3,
"price": {
"amount": 135000,
"currency": "AED",
"period": "yearly"
},
"area": {
"value": 137.87,
"unit": "sqm",
"sqft": 1484.03
},
"agency_name": "Driven Properties",
"photo_count": 12
}
]
},
"meta": {
"endpoint_family": "agency_listings",
"billable": true,
"pagination": {
"page": 0,
"limit": 20,
"total": 6865,
"has_more": true,
"next_page": 1,
"truncated": false
}
}
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
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"
}Invalid Source Response
Bayut returned an unexpected response shape. This response is not billable.
{
"meta": {
"billable": false,
"retryable": false,
"endpoint_family": "agency_listings"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "Bayut returned an unexpected response."
},
"success": false
}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": "agency_listings"
},
"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.