Happy Endpoint

Search for locations on Bayut or PropertyFinder

Search for location names and get their platform-specific IDs. Use the returned location_id in the /search-properties endpoint for faster searches (skips auto-resolve).

GET
/autocomplete

Authorization

RapidApiKey
X-RapidAPI-Key<token>

In: header

Query Parameters

platform*string
  • Data source platform
  • bayut — Search locations on Bayut
  • propertyfinder — Search locations on PropertyFinder
Value in"bayut" | "propertyfinder"
query*string
  • Location search query
  • Examples: Dubai Marina, Palm Jumeirah, Business Bay, JBR
Length1 <= length <= 200

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/autocomplete?platform=bayut&query=Dubai+Marina" \  -H "X-RapidAPI-Host: uae-real-estate-api.p.rapidapi.com"
{
  "success": true,
  "platform": "bayut",
  "data": [
    {
      "location_id": "5002",
      "name": "Dubai Marina",
      "type": "neighborhood",
      "path": "Dubai > Dubai Marina",
      "coordinates": {
        "lat": 25.0805,
        "lon": 55.1403
      }
    }
  ]
}
{
  "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"
}

healthGET

Comprehensive UAE property data combining Bayut and PropertyFinder listings.

Search properties for rent or saleGET

Search properties on Bayut or PropertyFinder. Pass a location name (e.g. 'Dubai Marina') and we auto-resolve it, or pass a location_id directly for faster results. Filter by property type, bedrooms, price range, area, and more.