---
title: "Location Autocomplete"
method: GET
path: "/immowelt/locations"
tags: ["Immowelt"]
---

# Location Autocomplete

`GET /immowelt/locations`

## Request

- Base URL: `https://scrappa.co/api`
- URL: `https://scrappa.co/api/immowelt/locations`
- Auth: API key in header `X-API-KEY`

Search for locations to get location IDs for property search.

## Query parameters

- `query` string, required
- `limit` integer, nullable

## Response `200`

- union
  - object
    - `success` boolean, required
    - `error` object, required
      - `code` 'UPSTREAM_ERROR', required
      - `message` 'Location request failed', required
  - object
    - `success` boolean, required
    - `locations` object[], required
      - `id` string, required
      - `name` string, required
      - `type` union, required
        - string
        - 'geocode'
      - `postal_code` string, nullable, required
      - `full_name` string, required
      - `lat` number, nullable, required
      - `lon` number, nullable, required
      - `radius_km` 10, required
      - `source` 'nominatim', required
  - object
    - `success` boolean, required
    - `locations` unknown[], required
      - unknown
  - object
    - `success` boolean, required
    - `locations` unknown[], required
      - unknown
  - object
    - `success` boolean, required
    - `locations` union, required
      - string
      - string[]
  - object
    - `success` boolean, required
    - `locations` string[], required

## Other responses

- `401`: Unauthorized - API key is missing or invalid
- `422`: Validation error
- `503`

---

[API](https://skmtc.dev/scrappa/apis/scrappa-api-documentation.md) · [All operations](https://skmtc.dev/scrappa/apis/scrappa-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/scrappa/apis/scrappa-api-documentation/revisions/2f4af6143d10?raw)
