/immowelt/agencies/properties

POST /api/immowelt/agencies/properties

Price: 10 credits

List the real estate listings of an immowelt agency by profile id: returns the agency's active listing references (property id, url and coordinates), enriched with the full listing card where available.

How to use it

List an immowelt agency's listings by agency id (32-char hex or legacy numeric) or profile URL. domain selects immowelt.de or immowelt.at. Each result has id, url, latitude, longitude and listing (the full property card with title, price, area, rooms, energy class, images and agency when available). Fetch full details for any listing via the properties endpoint using its id.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• agency string required — Agency profile id (32-char hex or legacy numeric id) or an agency profile URL (examples: "66c00542be9d41bc8abc9e2773dc8d82", "2754181"; minLength: 1)
• domain string — Immowelt portal to query (default: "immowelt.de"; one of: "immowelt.de", "immowelt.at")
• count integer required — Max number of agency listings to return (min: 1)

Response

• @type string (default: "ImmoweltAgencyListing")
• id string required
• url string nullable
• latitude number nullable
• longitude number nullable
• listing object nullable
  • @type string (default: "ImmoweltPropertyCard")
  • id string required
  • global_id string nullable
  • url string nullable
  • document_title string nullable
  • property_type string nullable
  • distribution_type string nullable
  • provider_type string nullable
  • created_at integer nullable
  • updated_at integer nullable
  • price number nullable
  • price_label string nullable
  • price_per_m2 number nullable
  • currency string 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
  • energy_class string nullable
  • headline string nullable
  • description 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
  • images array (default: [])
  • 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 — Agency not found for the given profile 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.