/immowelt/places/search

POST /api/immowelt/places/search

Price: 1 credit

Search immowelt places (geo ids) by free text: city, district, postal code or street. Returns matching places with their geo id, display name, place type, postal codes, coordinates and parent hierarchy. Use the returned geo id as the location for the property search endpoint. Covers immowelt.de and immowelt.at.

How to use it

Autocomplete immowelt locations. keyword is free text (city 'Berlin', district, postal code '10115', street); domain selects immowelt.de or immowelt.at. Each result has id (the geo id used by property search), name, labels, type_key, subtype, country_code, postal_codes, latitude, longitude and parents.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — City, district, postal code or street to look up (examples: "Berlin", "München", "10115", "Prenzlauer Berg"; minLength: 1)
• domain string — Immowelt portal to query (default: "immowelt.de"; one of: "immowelt.de", "immowelt.at")
• count integer required — Max number of place suggestions to return (min: 1; max: 10)

Response

• @type string (default: "ImmoweltPlace")
• id string required
• name string nullable
• labels array (default: [])
• type_key string nullable
• subtype string nullable
• country_code string nullable
• postal_codes array (default: [])
• latitude number nullable
• longitude number nullable
• parents array (default: [])
  • @type string (default: "ImmoweltPlaceParent")
  • id string nullable
  • type_key string nullable
  • name string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.