Autocomplete

Turn a free-text place into structured Immobiliare geography suggestions — nations, regions, provinces, cities (comuni) or zones. Use the returned region_id / province_id / city_id to drive precise /search and /market-insights/prices queries.

Query Parameters

query

string

required

Partial location — city, province, region or zone, e.g. Milano.

market

string

default:"it"

Market to search in. One of it, es, gr, lu.

Response

suggestions

Suggestion[]

Geography suggestions, most relevant first.

Show Suggestion

string

Id of the suggested geography entity.

label

string

Human-readable label, e.g. Milano.

type

string

One of nation, region, province, comune, zone.

region_id

string

Region id — feed to /search and /market-insights/prices.

province_id

string

Province id.

city_id

string

City (comune) id.

macrozone_ids

integer[]

Macrozone ids when the suggestion is a zone.

url

string

Search-results path on the market’s portal.

market

string

Echo of the requested market.

Example

const res = await fetch(
  "https://api.scrapebadger.com/v1/immobiliare/autocomplete?" +
    new URLSearchParams({ query: "Milano", market: "it" }),
  { headers: { "X-API-Key": process.env.SCRAPEBADGER_API_KEY } },
);
const data = await res.json();

import requests

res = requests.get(
    "https://api.scrapebadger.com/v1/immobiliare/autocomplete",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"query": "Milano", "market": "it"},
)
data = res.json()

curl "https://api.scrapebadger.com/v1/immobiliare/autocomplete?query=Milano&market=it" \
  -H "X-API-Key: YOUR_API_KEY"

Response

{
  "suggestions": [
    {
      "id": "8042",
      "label": "Milano",
      "type": "comune",
      "region_id": "10",
      "province_id": "MI",
      "city_id": "8042",
      "macrozone_ids": [],
      "url": "/vendita-case/milano/"
    },
    {
      "id": "MI",
      "label": "Milano (provincia)",
      "type": "province",
      "region_id": "10",
      "province_id": "MI",
      "city_id": null,
      "macrozone_ids": [],
      "url": "/vendita-case/milano-provincia/"
    },
    {
      "id": "10046",
      "label": "Navigli - Darsena, Milano",
      "type": "zone",
      "region_id": "10",
      "province_id": "MI",
      "city_id": "8042",
      "macrozone_ids": [10046],
      "url": "/vendita-case/milano/navigli/"
    }
  ],
  "market": "it"
}

Each autocomplete request costs 2 credits. Failed requests are not charged.

Overview

Search

Listings

Agencies

Insights

Reference

Query Parameters

Response

Example

​Query Parameters

​Response

​Example

Query Parameters

Response

Example