← Home Get Locations

Get Locations

GEThttps://api.bayut.com/v1/locations

This endpoint lists location to be used in create/update properties endpoints.The Locations API helps you search and find places with location level.You can search by title (for example, "Dubai Marina") or filter step-by-step using location levels.It understands location relationships, so results stay accurate and relevant.The API returns results in pages and supports both English and Arabic.

🔐 Bearer Token: Provide your bearer token in the Authorization header when making requests to protected resources.
Query Parameters
NameTypeRequiredDescriptionExample
titlestringOptionalThe title filter, categori(es) with matching title would be returned.Jumeirah
per_pagestringOptionalThe number of results per page.10
level_1stringOptionalFilter locations with level_1UAE
level_2stringOptionalFilter locations with level_2Dubai
level_3stringOptionalFilter locations with level_3Jumeirah
level_4stringOptionalFilter locations with level_4La Mer
level_5stringOptionalFilter locations with level_5Port de La Mer
level_6stringOptionalFilter locations with level_6La Sirene
level_7stringOptionalFilter locations with level_7La Sirene 2
level_8stringOptionalFilter locations with level_8La Sirene Tower 6
Response Schema
NameTypeRequiredDescriptionExample
dataobjectOptionalRepresents a geographical location or area (e.g., country, city, community, sub-community) within the property listing hierarchy.
idintegerOptionalThe unique identifier for the location.14550
breadcrumbobjectOptionalThe hierarchical path of the location from the top level (country) to the most specific area.
coordinatesobjectOptionalThe geographical coordinates of the location (present only when both latitude and longitude exist).
linksobjectOptionalThe links to pages.
firststringOptionalThe link to first page.
laststringOptionalThe link to last page.
prevstringOptionalThe link to previous page.
nextstringOptionalThe link to next page.
metaobjectOptionalMeta about pagination data.
current_pageintegerOptionalThe page you are currently on.
fromintegerOptionalThe first page of the paginated results.
pathstringOptionalThe path of the current page.
tointegerOptionalThe last page of the paginated results.
totalintegerOptionalThe total number of results.
Responses
200
401⚠️
403⚠️
Code Examples
curl --location 'https://api.bayut.com/v1/locations?title=Jumeirah&per_page=10&level_1=UAE&level_2=Dubai&level_3=Jumeirah&level_4=La%20Mer&level_5=Port%20de%20La%20Mer&level_6=La%20Sirene&level_7=La%20Sirene%202&level_8=La%20Sirene%20Tower%206' \
--header 'Authorization: Bearer <token>'
{
    "data": [
        {
            "id": 5013,
            "title": {
                "en": "23 Marina",
                "ar": "مارينا 23"
            },
            "breadcrumb": {
                "en": [
                    "UAE",
                    "Dubai",
                    "Dubai Marina",
                    "23 Marina"
                ],
                "ar": [
                    "الإمارات",
                    "دبي",
                    "دبي مارينا",
                    "مارينا 23"
                ]
            },
            "coordinates": {
                "latitude": 25.0897673516359,
                "longitude": 55.1508039236069
            }
        }
    ]
}