Happy Endpoint

Search agencies by location

Search for real estate agencies in Dubai/UAE by location. Returns agencies with active listings in the specified location.

GET
/agency-search

Authorization

RapidApiKey
X-RapidAPI-Key<token>

In: header

Query Parameters

location_id*string
  • Location external ID
  • Get from /autocomplete endpoint (externalID field)
  • Example: 5001 (Dubai)
  • Example: 1 for whole of dubai, 3 for whole of Abu Dhabi
Length1 <= length
page?integer
  • Page number (starts from 1)
  • Results per page: 40
Default1
Range1 <= value
langs?string
  • Comma-separated language codes: en, ar, ru, zh
Default"en"

Header Parameters

X-RapidAPI-Host*string
Default"bayut14.p.rapidapi.com"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/agency-search?location_id=1" \  -H "X-RapidAPI-Host: bayut14.p.rapidapi.com"
{
  "success": true,
  "data": {
    "agencies": [
      null
    ],
    "total": 0,
    "page": 0,
    "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": "API_ERROR"
}