/immowelt/agencies

POST /api/immowelt/agencies

Price: 10 credits

Get an immowelt real estate agency profile by profile id (or profile URL): company name, legal name, registration and VAT numbers, legal representative, description, email and phone, website, address, spoken languages, memberships, services, opening hours, logo and cover image, rating and the team members with their contacts.

How to use it

Fetch a single immowelt agency profile by id (32-char hex '66c00542...' or legacy numeric '2754181') or profile URL. domain selects immowelt.de or immowelt.at. Returns one item with id, profile_id, company_name, legal_company_name, registration_number, vat_number, legal_representative, intermediary_type, description, email, phone, mobile, website, address, spoken_languages, memberships, services, opening_hours, image (agency logo), cover, rating_average, rating_count, review_count, badge and team (first_name, last_name, role, email, phone, mobile, image).

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")

Response

• @type string (default: "ImmoweltAgency")
• id string required
• profile_id string nullable
• company_name string nullable
• legal_company_name string nullable
• registration_number string nullable
• vat_number string nullable
• legal_representative string nullable
• intermediary_type string nullable
• description string nullable
• email string nullable
• phone string nullable
• mobile string nullable
• website string nullable
• address object nullable
  • @type string (default: "ImmoweltAgencyAddress")
  • street string nullable
  • postal_code string nullable
  • city string nullable
  • region string nullable
  • country string nullable
• spoken_languages array (default: [])
• memberships array (default: [])
• services array (default: [])
• opening_hours array (default: [])
  • @type string (default: "ImmoweltOpeningHours")
  • day string nullable
  • morning_open string nullable
  • morning_close string nullable
  • afternoon_open string nullable
  • afternoon_close string nullable
• image string nullable
• cover string nullable
• rating_average number nullable
• rating_count integer nullable
• review_count integer nullable
• badge object nullable
  • @type string (default: "ImmoweltAgencyBadge")
  • name string nullable
  • level string nullable
• team array (default: [])
  • @type string (default: "ImmoweltTeamMember")
  • first_name string nullable
  • last_name string nullable
  • salutation string nullable
  • role string nullable
  • email string nullable
  • phone string nullable
  • mobile string nullable
  • image 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.