GET /autocomplete

Get location suggestions and IDs for property searches. Returns location IDs and slugs that can be used as input for property search, agent search, and agency search endpoints.

Authorization

RapidApiKey

X-RapidAPI-Key<token>

In: header

Query Parameters

query*string

Location search query
Examples: dubai marina, palm jumeirah, downtown dubai
Minimum 1 character

Length1 <= length <= 200

langs?string

Comma-separated language codes for localized results
Available: en (English), ar (Arabic), ru (Russian), zh (Chinese)
Example: en,ar returns English + Arabic names
Default: en

Default"en"

Header Parameters

X-RapidAPI-Host*string

Default"bayut14.p.rapidapi.com"

Response Body

`application/json`

curl -X GET "https://example.com/autocomplete?query=dubai" \  -H "X-RapidAPI-Host: bayut14.p.rapidapi.com"

{
  "success": true,
  "data": {
    "locations": [
      {
        "id": 36,
        "externalID": "5003",
        "name": {
          "en": "Dubai Marina",
          "ar": "دبي مارينا"
        },
        "slug": {
          "en": "/dubai/dubai-marina"
        },
        "level": 2,
        "type": "neighborhood",
        "geography": null,
        "path": "Dubai > Dubai Marina",
        "adCount": 12450
      }
    ],
    "total": 5
  }
}

{
  "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"
}

Search for locations in Dubai/UAE

Authorization

Query Parameters

Header Parameters

Response Body

200application/json

400application/json

500application/json

502application/json

`application/json`

`application/json`

`application/json`

`application/json`