Happy Endpoint

Search real estate agents

Search agents by name (Bayut only) or by location (both platforms). For Bayut, you can search by agent name or filter by location/purpose/category. For PropertyFinder, location is required.

GET
/search-agents

Authorization

RapidApiKey
X-RapidAPI-Key<token>

In: header

Query Parameters

platform*string
  • Data source platform
Value in"bayut" | "propertyfinder"
query?string
  • Agent name to search for
  • Bayut only. PropertyFinder requires location instead.
Length1 <= length <= 200
location?string
  • Location name (auto-resolved to location_id)
Length1 <= length <= 200
location_id?string
  • Platform-specific location ID from /autocomplete
purpose?string
  • Filter agents by transaction purpose
  • Default: buy
Default"buy"
Value in"rent" | "buy"
category?string
  • Property category filter (Bayut location-search only)
Default"residential"
Value in"residential" | "commercial"
page?integer
  • Page number (starts from 1)
Default1
Range1 <= value

Header Parameters

X-RapidAPI-Host*string
Default"uae-real-estate-api.p.rapidapi.com"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/search-agents?platform=bayut" \  -H "X-RapidAPI-Host: uae-real-estate-api.p.rapidapi.com"
{
  "success": true,
  "platform": "bayut",
  "data": {
    "agents": [
      null
    ],
    "total": 20,
    "page": 1,
    "totalPages": 0,
    "hitsPerPage": 0
  }
}
{
  "success": false,
  "message": "Invalid request: Missing required parameter",
  "error": "VALIDATION_ERROR"
}
{
  "success": false,
  "message": "Internal server error. Please try again later.",
  "error": "INTERNAL_ERROR"
}
{
  "success": false,
  "message": "Service temporarily unavailable. Please try again later.",
  "error": "PLATFORM_ERROR"
}