/immowelt/prices

POST /api/immowelt/prices

Price: 10 credits

Get the immowelt real estate price index for a place (geo id): current average, low and high price per m² for apartments and houses (overall and per room count), the price evolution over 1 month, 6 months, 1 and 5 years, the monthly/yearly price history, and the most expensive and cheapest neighbouring areas.

How to use it

Get the immowelt price index for a place by geo id ('AD08DE8634'). domain selects immowelt.de or immowelt.at. Returns one item with place_id, place_name, place_type, postal_code, latitude, longitude, transaction_type and apartment/house/hybrid price blocks (average, low, high, accuracy, date, room_prices per room count, evolution over time and history), plus most_expensive_area and cheapest_area.

Parameters

access-token string required

Request body

timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
place string required — Immowelt geo id of the place to get price indices for (from the places search endpoint) (examples: "AD08DE8634", "NBH2DE91302090"; minLength: 1)
domain string — Immowelt portal to query (default: "immowelt.de"; one of: "immowelt.de", "immowelt.at")

Response

@type string (default: "ImmoweltPrices")
place_id string required
place_name string nullable
place_type string nullable
postal_code string nullable
latitude number nullable
longitude number nullable
transaction_type string nullable
apartment object nullable
- @type string (default: "ImmoweltAccommodationPrice")
- accommodation_type string nullable
- average number nullable
- low number nullable
- high number nullable
- accuracy integer nullable
- date string nullable
- room_prices array (default: [])
  - @type string (default: "ImmoweltRoomPrice")
  - rooms integer nullable
  - price_per_m2 number nullable
- evolution array (default: [])
  - @type string (default: "ImmoweltPriceEvolution")
  - period_unit string nullable
  - period_value integer nullable
  - percent number nullable
  - level string nullable
- history array (default: [])
  - @type string (default: "ImmoweltPriceHistoryPoint")
  - date string nullable
  - price_per_m2 number nullable
  - evolution number nullable
house object nullable
- @type string (default: "ImmoweltAccommodationPrice")
- accommodation_type string nullable
- average number nullable
- low number nullable
- high number nullable
- accuracy integer nullable
- date string nullable
- room_prices array (default: [])
  - @type string (default: "ImmoweltRoomPrice")
  - rooms integer nullable
  - price_per_m2 number nullable
- evolution array (default: [])
  - @type string (default: "ImmoweltPriceEvolution")
  - period_unit string nullable
  - period_value integer nullable
  - percent number nullable
  - level string nullable
- history array (default: [])
  - @type string (default: "ImmoweltPriceHistoryPoint")
  - date string nullable
  - price_per_m2 number nullable
  - evolution number nullable
hybrid object nullable
- @type string (default: "ImmoweltAccommodationPrice")
- accommodation_type string nullable
- average number nullable
- low number nullable
- high number nullable
- accuracy integer nullable
- date string nullable
- room_prices array (default: [])
  - @type string (default: "ImmoweltRoomPrice")
  - rooms integer nullable
  - price_per_m2 number nullable
- evolution array (default: [])
  - @type string (default: "ImmoweltPriceEvolution")
  - period_unit string nullable
  - period_value integer nullable
  - percent number nullable
  - level string nullable
- history array (default: [])
  - @type string (default: "ImmoweltPriceHistoryPoint")
  - date string nullable
  - price_per_m2 number nullable
  - evolution number nullable
most_expensive_area object nullable
- @type string (default: "ImmoweltChildArea")
- name string nullable
- url string nullable
- apartment_average number nullable
- house_average number nullable
cheapest_area object nullable
- @type string (default: "ImmoweltChildArea")
- name string nullable
- url string nullable
- apartment_average number nullable
- house_average number 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 — Price data not found for the given geo id 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.