/immowelt/properties

POST /api/immowelt/properties

Price: 20 credits

Get full immowelt real estate property (expose) details by property id (Online-ID or legacy id) or a property URL: title, property type and subtype, distribution and transaction type, price and price per m² with the price label (Kaufpreis, Kaltmiete, Warmmiete, ...), commission, recurring costs such as the monthly Hausgeld, monthly financing rate, main area (living, office, sales, storage, restaurant or overall, whichever the property type uses), plot area, divisibility, rooms, floor, availability, construction year, condition, energy class and certificate, address, main, area and additional descriptions, grouped features, market price comparison, photos, floorplans, videos, virtual tours, attached documents, geo hierarchy, tags and the listing agency.

How to use it

Fetch a single immowelt property (expose) by id (Online-ID like '26VSFPAJV6VF' or legacy uuid) or a property URL. domain selects the immowelt.de or immowelt.at portal. Returns one item with id, global_id, url, document_title, property_type, property_sub_type, distribution_type, transaction_type, is_new_build, is_active, created_at, updated_at, headline, description, location_description, additional_description (free text 'Weitere Informationen': heating type, energy source, keywords), price, price_label (what the price stands for: Kaufpreis for sales, Kaltmiete, Warmmiete or Nettomiete zzgl. NK for rentals), price_per_m2, currency, commission_percent, commission_note, price_note, price_details (recurring and extra price positions such as Hausgeld, with label, display value and parsed amount), monthly_rate, area_m2 (the main area of the property: living area for residential, office, sales, storage, restaurant or overall area for commercial), plot_m2, is_divisible and divisible_from_m2 (commercial units let in parts), room_count, floor, availability, construction_year, condition, energy_class, energy_certificate, reference, address, keyfacts, feature_sections, price_comparison, images, floorplans, videos, virtual_tours, documents (attached PDF exposes, floorplans and energy certificates), geo_id_hierarchy, tags and agency (id, name, contact_person, phones, website, address, profile_url, publisher_type, badge).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• property string required — Property id (Online-ID or legacy id) or a property (expose) URL containing it (examples: "26VSFPAJV6VF", "75ec666c-6818-4fdc-886e-f9d01e41ed5c"; minLength: 1)
• domain string — Immowelt portal to query (default: "immowelt.de"; one of: "immowelt.de", "immowelt.at")

Response

• @type string (default: "ImmoweltProperty")
• id string required
• global_id string nullable
• url string nullable
• document_title string nullable
• property_type string nullable
• property_sub_type string nullable
• distribution_type string nullable
• transaction_type string nullable
• is_new_build boolean nullable
• is_active boolean nullable
• created_at integer nullable
• updated_at integer nullable
• headline string nullable
• description string nullable
• location_description string nullable
• additional_description string nullable
• price number nullable
• price_label string nullable
• price_per_m2 number nullable
• currency string nullable
• commission_percent number nullable
• commission_note string nullable
• price_note string nullable
• price_details array (default: [])
  • @type string (default: "ImmoweltPriceDetail")
  • group string nullable
  • label string nullable
  • value string nullable
  • amount number nullable
• monthly_rate number nullable
• area_m2 number nullable
• plot_m2 number nullable
• is_divisible boolean nullable
• divisible_from_m2 number nullable
• room_count number nullable
• floor string nullable
• availability string nullable
• construction_year integer nullable
• condition string nullable
• energy_class string nullable
• energy_certificate object nullable
  • @type string (default: "ImmoweltEnergyCertificate")
  • energy_class string nullable
  • certificate_type string nullable
  • consumption string nullable
  • energy_source string nullable
  • validity string nullable
• reference string nullable
• address object nullable
  • @type string (default: "ImmoweltAddress")
  • city string nullable
  • zip_code string nullable
  • district string nullable
  • region string nullable
  • country string nullable
  • federal_state_geo_id string nullable
• keyfacts array (default: [])
• feature_sections array (default: [])
  • @type string (default: "ImmoweltFeatureSection")
  • features array (default: [])
• price_comparison object nullable
  • @type string (default: "ImmoweltPriceComparison")
  • value number nullable
  • low number nullable
  • high number nullable
  • accuracy integer nullable
  • price_per_m2 number nullable
• images array (default: [])
• floorplans array (default: [])
• videos array (default: [])
  • @type string (default: "ImmoweltMedia")
  • url string nullable
• virtual_tours array (default: [])
  • @type string (default: "ImmoweltMedia")
  • url string nullable
• documents array (default: [])
  • @type string (default: "ImmoweltDocument")
  • url string nullable
  • document_title string nullable
  • file_type string nullable
• geo_id_hierarchy array (default: [])
  • @type string (default: "ImmoweltGeoLevel")
  • id string nullable
  • type_key string nullable
• tags object nullable
  • @type string (default: "ImmoweltTags")
  • has_3d_visit boolean nullable
  • has_brokerage_fee boolean nullable
  • is_new boolean nullable
• agency object nullable
  • @type string (default: "ImmoweltListingAgency")
  • id string nullable
  • name string nullable
  • contact_person string nullable
  • is_private_owner boolean nullable
  • publisher_type string nullable
  • phones array (default: [])
  • website string nullable
  • address string nullable
  • profile_url string nullable
  • image string nullable
  • badge object nullable
    • @type string (default: "ImmoweltBadge")
    • description string nullable
    • image string nullable
    • duration 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 — Property not found (well-formed but nonexistent or expired property 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.