Bayut

Search API

GET https://api.dataextractorpro.com/search ⚡ 1 Credit

Retrieve property listings quickly using the Search API with powerful filtering options including location, price range, property type, and amenities.

Overview

This API endpoint allows programmatically extracting clean, structured data for Bayut.

Authentication

Include your API key in the request header:

                                x-api-key: YOUR_API_KEY
                            

Request Parameters

Parameter	Type	Required	Description & Allowed Values
locationExternalIDs LocationExternalIDs	text	Required	Values for parameter locationExternalIDs can be obtained from autocmplete endpoint.
purpose Purpose	select	Required	Defines whether the property listing is intended for sale or rent. Allowed Values: for-sale for-rent
page page	text	Optional	page
rentFreq Rent Frequency	select	Optional	Rent Frequency Allowed Values: yearly monthly weekly daily
categories categories	text	Optional	Filters properties by category or subcategory. The parameter accepts either a main category (residential or commercial) or one or more subcategories separated by commas. Main category options residential commercial Residential subcategories apartments townhouses villa-compound residential-plots residential-building penthouse hotel-apartments residential-floors Commercial subcategories offices warehouses commercial-villas commercial-plots commercial-buildings industrial-land showrooms shops labour-camps bulk-units commercial-floors factories mixed-use-land commercial-properties Valid examples categories=residential categories=commercial,residential categories=apartments categories=apartments,townhouses categories=showrooms,shops,factories
completionStatus completionStatus	select	Optional	Filters properties based on construction or completion status. Allowed Values: completed under-construction
rooms rooms	text	Optional	Specifies the number of bedrooms for the property. Multiple values can be provided. eg. rooms=2 rooms=2,3,4
baths baths	text	Optional	Specifies the number of bathrooms. Multiple values can be provided.
minPrice minPrice	number	Optional	Filters results by minimum property price.
maxPrice maxPrice	text	Optional	Filters results by maximum property price.
minArea minArea	number	Optional	Filters properties by minimum property size (area).
maxArea maxArea	number	Optional	Filters properties by maximum property size (area).
furnished furnished	select	Optional	furnished Allowed Values: true false

Code Examples

Error Responses

400 Invalid Parameters

One or more required parameters are missing or invalid.

{
    "status": "error",
    "message": "Parameter 'q' is required"
}

401 Unauthorized

Invalid or missing API key in x-api-key header.

{
    "status": "error",
    "message": "Invalid API key"
}

429 Rate Limit / Quota Exceeded

API key usage quota has been exhausted.

{
    "status": "error",
    "message": "Usage limit reached"
}

500 Internal Server Error

An unexpected server error occurred during extraction.

{
    "status": "error",
    "message": "Internal extraction error"
}

← Previous Endpoint Autocomplete Next Endpoint → Property Details