Bayut Scraper

ENDPOINTS
GET/locations/autocomplete

Autocomplete Locations

Get search-box suggestions for cities, communities and towers: IDs, slugs, coordinates and live listing counts.

QUERY PARAMS

Start of a city, community, sub-community or building name, e.g. palm, dubai marina or jvc.

Only this kind of place: neighbourhood (communities and sub-communities) or condo-building (towers and buildings).

Default: every type

Allowed values: neighbourhood, condo-building

Language of names, titles and descriptions.

Default: en

Allowed values: en, ar, zh, ru, de, fr, es, it, nl

Number of suggestions to return.

Default: 10

Allowed values: 1-50

{
  "query": "palm",
  "count": 10,
  "results": [
    {
      "id": 5460,
      "name": "Palm Jumeirah",
      "slug": "/dubai/palm-jumeirah",
      "link": "https://www.bayut.com/for-sale/property/dubai/palm-jumeirah/",
      "type": "neighbourhood",
      "level": 2,
      "city": "Dubai",
      "hierarchy": [
        {
          "id": 5001,
          "name": "UAE",
          "slug": "/uae",
          "level": 0,
          "type": null
        },
        {
          "id": 5002,
          "name": "Dubai",
          "slug": "/dubai",
          "level": 1,
          "type": null
        },
        {
          "id": 5460,
          "name": "Palm Jumeirah",
          "slug": "/dubai/palm-jumeirah",
          "level": 2,
          "type": "neighbourhood"
        }
      ],
      "coordinates": {
        "latitude": 25.118690512606,
        "longitude": 55.135936456106
      },
      "listings_count": 5957,
      "aliases": [
        "Palm Jumeira",
        "Palm Jumera",
        "Palm Jumerah",
        "Palm Jumaira",
        "Palm Jumairah"
      ],
      "has_children": true,
      "completion_status": "both"
    },
    {
      "id": 5486,
      "name": "Palm Jebel Ali",
      "slug": "/dubai/palm-jebel-ali",
      "link": "https://www.bayut.com/for-sale/property/dubai/palm-jebel-ali/",
      "type": "neighbourhood",
      "level": 2,
      "city": "Dubai",
      "hierarchy": [
        {
          "id": 5001,
          "name": "UAE",
          "slug": "/uae",
          "level": 0,
          "type": null
        },
        {
          "id": 5002,
          "name": "Dubai",
          "slug": "/dubai",
          "level": 1,
          "type": null
        },
        {
          "id": 5486,
          "name": "Palm Jebel Ali",
          "slug": "/dubai/palm-jebel-ali",
          "level": 2,
          "type": "neighbourhood"
        }
      ],
      "coordinates": {
        "latitude": 25.000545960248,
        "longitude": 54.987946990059
      },
      "listings_count": 592,
      "aliases": [
        "Jebel Ali Palm",
        "Palm Jabel Ali",
        "Jebel Ali Island"
      ],
      "has_children": true,
      "completion_status": "both"
    },
    {
      "id": 5483,
      "name": "Garden Homes Palm Jumeirah",
      "slug": "/dubai/palm-jumeirah/garden-homes-palm-jumeirah",
      "link": "https://www.bayut.com/for-sale/property/dubai/palm-jumeirah/garden-homes-palm-jumeirah/",
      "type": null,
      "level": 3,
      "city": "Dubai",
      "hierarchy": [
        {
          "id": 5001,
          "name": "UAE",
          "slug": "/uae",
          "level": 0,
          "type": null
        },
        {
          "id": 5002,
          "name": "Dubai",
          "slug": "/dubai",
          "level": 1,
          "type": null
        },
        {
          "id": 5460,
          "name": "Palm Jumeirah",
          "slug": "/dubai/palm-jumeirah",
          "level": 2,
          "type": "neighbourhood"
        },
        {
          "id": 5483,
          "name": "Garden Homes Palm Jumeirah",
          "slug": "/dubai/palm-jumeirah/garden-homes-palm-jumeirah",
          "level": 3,
          "type": null
        }
      ],
      "coordinates": {
        "latitude": 25.120519,
        "longitude": 55.130744
      },
      "listings_count": 409,
      "aliases": null,
      "has_children": true,
      "completion_status": "completed"
    },
    {
      "id": 11216,
      "name": "The Palm Beach Towers",
      "slug": "/dubai/palm-jumeirah/the-palm-beach-towers",
      "link": "https://www.bayut.com/for-sale/property/dubai/palm-jumeirah/the-palm-beach-towers/",
      "type": null,
      "level": 3,
      "city": "Dubai",
      "hierarchy": [
        {
          "id": 5001,
          "name": "UAE",
          "slug": "/uae",
          "level": 0,
          "type": null
        },
        {
          "id": 5002,
          "name": "Dubai",
          "slug": "/dubai",
          "level": 1,
          "type": null
        },
        {
          "id": 5460,
          "name": "Palm Jumeirah",
          "slug": "/dubai/palm-jumeirah",
          "level": 2,
          "type": "neighbourhood"
        },
        {
          "id": 11216,
          "name": "The Palm Beach Towers",
          "slug": "/dubai/palm-jumeirah/the-palm-beach-towers",
          "level": 3,
          "type": null
        }
      ],
      "coordinates": {
        "latitude": 25.100751,
        "longitude": 55.15502
      },
      "listings_count": 318,
      "aliases": null,
      "has_children": true,
      "completion_status": "off-plan"
    },
    {
      "id": 5467,
      "name": "Signature Villas Palm Jumeirah",
      "slug": "/dubai/palm-jumeirah/signature-villas-palm-jumeirah",
      "link": "https://www.bayut.com/for-sale/property/dubai/palm-jumeirah/signature-villas-palm-jumeirah/",
      "type": null,
      "level": 3,
      "city": "Dubai",
      "hierarchy": [
        {
          "id": 5001,
          "name": "UAE",
          "slug": "/uae",
          "level": 0,
          "type": null
        },
        {
          "id": 5002,
          "name": "Dubai",
          "slug": "/dubai",
          "level": 1,
          "type": null
        },
        {
          "id": 5460,
          "name": "Palm Jumeirah",
          "slug": "/dubai/palm-jumeirah",
          "level": 2,
          "type": "neighbourhood"
        },
        {
          "id": 5467,
          "name": "Signature Villas Palm Jumeirah",
          "slug": "/dubai/palm-jumeirah/signature-villas-palm-jumeirah",
          "level": 3,
          "type": null
        }
      ],
      "coordinates": {
        "latitude": 25.120519,
        "longitude": 55.130744
      },
      "listings_count": 239,
      "aliases": null,
      "has_children": true,
      "completion_status": "completed"
    },
    {
      "id": 17719,
      "name": "Palmiera",
      "slug": "/dubai/the-oasis-by-emaar/palmiera",
      "link": "https://www.bayut.com/for-sale/property/dubai/the-oasis-by-emaar/palmiera/",
      "type": "neighbourhood",
      "level": 3,
      "city": "Dubai",
      "hierarchy": [
        {
          "id": 5001,
          "name": "UAE",
          "slug": "/uae",
          "level": 0,
          "type": null
        },
        {
          "id": 5002,
          "name": "Dubai",
          "slug": "/dubai",
          "level": 1,
          "type": null
        },
        {
          "id": 16663,
          "name": "The Oasis by Emaar",
          "slug": "/dubai/the-oasis-by-emaar",
          "level": 2,
          "type": "neighbourhood"
        },
        {
          "id": 17719,
          "name": "Palmiera",
          "slug": "/dubai/the-oasis-by-emaar/palmiera",
          "level": 3,
          "type": "neighbourhood"
        }
      ],
      "coordinates": {
        "latitude": 25.005274426294,
        "longitude": 55.210447982116
      },
      "listings_count": 219,
      "aliases": null,
      "has_children": false,
      "completion_status": "off-plan"
    },
    {
      "id": 8483,
      "name": "The Palm Tower",
      "slug": "/dubai/palm-jumeirah/the-palm-tower",
      "link": "https://www.bayut.com/for-sale/property/dubai/palm-jumeirah/the-palm-tower/",
      "type": "condo-building",
      "level": 3,
      "city": "Dubai",
      "hierarchy": [
        {
          "id": 5001,
          "name": "UAE",
          "slug": "/uae",
          "level": 0,
          "type": null
        },
        {
          "id": 5002,
          "name": "Dubai",
          "slug": "/dubai",
          "level": 1,
          "type": null
        },
        {
          "id": 5460,
          "name": "Palm Jumeirah",
          "slug": "/dubai/palm-jumeirah",
          "level": 2,
          "type": "neighbourhood"
        },
        {
          "id": 8483,
          "name": "The Palm Tower",
          "slug": "/dubai/palm-jumeirah/the-palm-tower",
          "level": 3,
          "type": "condo-building"
        }
      ],
      "coordinates": {
        "latitude": 25.113844,
        "longitude": 55.139982
      },
      "listings_count": 217,
      "aliases": null,
      "has_children": false,
      "completion_status": "completed"
    },
    {
      "id": 12984,
      "name": "Seven Palm (Tower A)",
      "slug": "/dubai/palm-jumeirah/seven-palm",
      "link": "https://www.bayut.com/for-sale/property/dubai/palm-jumeirah/seven-palm/",
      "type": "condo-building",
      "level": 3,
      "city": "Dubai",
      "hierarchy": [
        {
          "id": 5001,
          "name": "UAE",
          "slug": "/uae",
          "level": 0,
          "type": null
        },
        {
          "id": 5002,
          "name": "Dubai",
          "slug": "/dubai",
          "level": 1,
          "type": null
        },
        {
          "id": 5460,
          "name": "Palm Jumeirah",
          "slug": "/dubai/palm-jumeirah",
          "level": 2,
          "type": "neighbourhood"
        },
        {
          "id": 12984,
          "name": "Seven Palm (Tower A)",
          "slug": "/dubai/palm-jumeirah/seven-palm",
          "level": 3,
          "type": "condo-building"
        }
      ],
      "coordinates": {
        "latitude": 25.111515,
        "longitude": 55.138575
      },
      "listings_count": 205,
      "aliases": null,
      "has_children": false,
      "completion_status": "completed"
    },
    {
      "id": 11436,
      "name": "FIVE Palm Jumeirah",
      "slug": "/dubai/palm-jumeirah/five-palm-jumeirah",
      "link": "https://www.bayut.com/for-sale/property/dubai/palm-jumeirah/five-palm-jumeirah/",
      "type": "condo-building",
      "level": 3,
      "city": "Dubai",
      "hierarchy": [
        {
          "id": 5001,
          "name": "UAE",
          "slug": "/uae",
          "level": 0,
          "type": null
        },
        {
          "id": 5002,
          "name": "Dubai",
          "slug": "/dubai",
          "level": 1,
          "type": null
        },
        {
          "id": 5460,
          "name": "Palm Jumeirah",
          "slug": "/dubai/palm-jumeirah",
          "level": 2,
          "type": "neighbourhood"
        },
        {
          "id": 11436,
          "name": "FIVE Palm Jumeirah",
          "slug": "/dubai/palm-jumeirah/five-palm-jumeirah",
          "level": 3,
          "type": "condo-building"
        }
      ],
      "coordinates": {
        "latitude": 25.104144,
        "longitude": 55.148481
      },
      "listings_count": 187,
      "aliases": null,
      "has_children": false,
      "completion_status": "completed"
    },
    {
      "id": 5468,
      "name": "The Fairmont Palm Residences",
      "slug": "/dubai/palm-jumeirah/residences-palm-jumeirah",
      "link": "https://www.bayut.com/for-sale/property/dubai/palm-jumeirah/residences-palm-jumeirah/",
      "type": "neighbourhood",
      "level": 3,
      "city": "Dubai",
      "hierarchy": [
        {
          "id": 5001,
          "name": "UAE",
          "slug": "/uae",
          "level": 0,
          "type": null
        },
        {
          "id": 5002,
          "name": "Dubai",
          "slug": "/dubai",
          "level": 1,
          "type": null
        },
        {
          "id": 5460,
          "name": "Palm Jumeirah",
          "slug": "/dubai/palm-jumeirah",
          "level": 2,
          "type": "neighbourhood"
        },
        {
          "id": 5468,
          "name": "The Fairmont Palm Residences",
          "slug": "/dubai/palm-jumeirah/residences-palm-jumeirah",
          "level": 3,
          "type": "neighbourhood"
        }
      ],
      "coordinates": {
        "latitude": 25.110168420476,
        "longitude": 55.141410488002
      },
      "listings_count": 167,
      "aliases": null,
      "has_children": true,
      "completion_status": "completed"
    }
  ]
}