Get location suggestions based on a search query. - BayutAPI Documentation

GET /autocomplete

Get location suggestions based on a search query.

Description

The autocomplete endpoint returns location suggestions as users type, enabling you to build responsive search experiences. It matches against areas, buildings, communities, and landmarks across the UAE.

Each result includes the location's external ID, which you can use with the search-property endpoint's location_ids parameter. This creates a seamless search flow from location selection to property results.

The endpoint supports multi-language responses, making it suitable for Arabic and English property search interfaces.

Parameters

Name	Type	Required	Description	Example
`query`	string	Required	The search query string for location autocomplete suggestions.	`dubai marina`
`langs`	string	Optional	Comma-separated language codes for localized results. Available: 'en', 'ar', 'ru', 'zh'. Default: 'en'.	`en`

Code Examples

curl --request GET \
  --url 'https://bayut14.p.rapidapi.com/autocomplete?query=dubai%20marina&langs=en' \
  --header 'x-rapidapi-host: bayut14.p.rapidapi.com' \
  --header 'x-rapidapi-key: YOUR_API_KEY'

import requests

url = "https://bayut14.p.rapidapi.com/autocomplete"

querystring = {
    "query": "dubai marina",
    "langs": "en"
}

headers = {
    "x-rapidapi-key": "YOUR_API_KEY",
    "x-rapidapi-host": "bayut14.p.rapidapi.com"
}

response = requests.get(url, headers=headers, params=querystring)
print(response.json())

const url = 'https://bayut14.p.rapidapi.com/autocomplete?query=dubai%20marina&langs=en';

const options = {
  method: 'GET',
  headers: {
    'x-rapidapi-key': 'YOUR_API_KEY',
    'x-rapidapi-host': 'bayut14.p.rapidapi.com'
  }
};

const response = await fetch(url, options);
const data = await response.json();
console.log(data);

Example Response

Response

{
  "success": true,
  "data": {
    "locations": [
      {
        "id": 36,
        "externalID": "5003",
        "name": {
          "en": "Dubai Marina"
        },
        "slug": {
          "en": "/dubai/dubai-marina"
        },
        "type": "neighborhood",
        "level": 2,
        "path": "Dubai > Dubai Marina",
        "adCount": 12450,
        "geography": {
          "lat": 25.0805,
          "lng": 55.1403
        }
      }
    ],
    "total": 1
  }
}

Use Cases

Build a location search bar for property portals
Resolve user input to location IDs for property search
Create multilingual property search interfaces

Related Endpoints

GET /search-property

Search for properties with advanced filters.

GET /search-new-projects

Search for new development projects and off-plan properties.

Try this endpoint now

Subscribe to BayutAPI on RapidAPI and start making requests in minutes.

Get API Key View Pricing