# /immowelt/properties/search

`POST /api/immowelt/properties/search`

Price: 20 credits

Search immowelt real estate listings by location (city, district, postal code, street or geo id) with transaction kind, property type and subtype, project type, price, living area, plot, rooms, construction year, features, building condition, furnishing, position in the building and energy class filters and ordering. Returns listing cards with title, property type, price with its label (Kaufpreis, Kaltmiete, Warmmiete), price per m², main area, plot area, divisibility, rooms, floor, availability, energy class, address, photos, tags, the property url and the listing agency. Covers both immowelt.de and immowelt.at.

## How to use it

Search immowelt listings in a location. location is free text (city 'Berlin', district, postal code '10115', street) or an immowelt geo id ('AD08DE8634'); domain selects immowelt.de or immowelt.at. Filter by distribution_types (Buy/Rent/Buy_Auction/Compulsory_Auction), estate_types, estate_sub_types, project_types, features_included/excluded, build_states, furnished, energy_classes, locations_in_building (Groundfloor/Half_Basement/Roof_Storey), and min/max price, area, plot, rooms and year; sort orders by date or price. Each result has id, global_id, url, document_title, property_type, distribution_type, provider_type, price, price_label (what the price stands for: Kaufpreis for sales, Kaltmiete or Warmmiete for rentals), price_per_m2, 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, divisible_from_m2, room_count, floor, availability, energy_class, headline, description, address, images, tags and agency.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `location` (string, required) — Location to search in: city, district, postal code or street, or an immowelt geo id (examples: "Berlin", "München", "10115", "AD08DE8634"; minLength: 1)
- `domain` (string) — Immowelt portal to query (default: "immowelt.de"; one of: "immowelt.de", "immowelt.at")
- `distribution_types` (array) — Transaction kinds to include (default: ["Buy"]; one of: "Buy", "Rent", "Buy_Auction", "Compulsory_Auction")
- `estate_types` (array) — Property types to include (default: []; one of: "Apartment", "House", "Plot", "Parking", "Senior", "Building", "Office", "Trading", "Storage_Production", "Gastronomy_Hotel", "Agriculture_Forestry", "Miscellaneous")
- `estate_sub_types` (array) — Property subtypes to include (default: []; one of: "Agriculture_Company", "Agriculture_Forestry", "Apart_Hotel", "Apartment_House", "Assisted_Living", "Atelier", "Barge", "Bed_N_Breakfast", "Boat_Dock", "Boutique", "Bungalow", "Cafe_Bar_Pub", "Campsite", "Car_Park", "Carport", "Castle", "Chalet", "Club_Discotheque", "Commercial", "Commercial_Parc", "Commercial_Villa", "Corner_Terrace_House", "Country_Cottage", "Coworking", "Double_Garage", "Duplex", "End_Terrace_House", "Farm_Ranch", "Farmhouse", "Fields", "Finca", "Fishing", "Flatsharing_Room", "Forestry", "Garage", "Garage_Area", "Garage_Repair", "Garden_House", "Gardening", "Gite", "Holiday_Park", "Hotel", "House_Park", "House_To_Build", "House_To_Build_With_Plot", "Hunting", "Industry", "Kiosk", "Kot", "Lakeside_Property", "Large_Town_House", "Leisure", "Leisure_Facility", "Living", "Living_And_Commercial", "Living_And_Commercial_Building", "Loft", "Loft_Atelier", "Logistics_Center", "Manor_House", "Mansion", "Meadow", "Medical", "Medical_Building", "Medical_Care", "Medical_Floor", "Mid_Terrace_House", "Mill", "Misc_Agriculture", "Misc_Storage", "Miscellaneous", "Mixed", "Mixed_Use_Building_Commercial", "Mobile_Home", "Mountain_Hut", "Multi_Family_House", "Multi_Storey", "Office_Building", "Office_Centre", "Office_Space", "Office_Storage_Building", "Open_Space", "Orchard", "Outdoor_Space", "Outside", "Parking_Area", "Pavilion", "Penthouse", "Production_Hall", "Residential_Complex", "Restaurant", "Riding", "Rustico", "Sales_Area", "Semidetached_House", "Shared_Office", "Shopping_Centre", "Showroom_Space", "Single_Family_House", "Single_Office", "Special_Real_Estate", "Special_Use", "Static_Caravan", "Store", "Street_Parking", "Structure", "Studio", "Terrace", "Terrace_House", "Town_House", "Underground_Garage", "Underground_Parking_Space", "Unfinished_Attic_Space", "Villa", "Warehouse_Hall", "Winery")
- `project_types` (array) — Project/offer types to include (default: []; one of: "Resale", "New_Build", "Projected", "Investment", "Flatsharing", "Life_Annuity", "Short_Time_Rental", "Stock", "Swap_Apartment")
- `features_included` (array) — Required features (default: []; one of: "Air_Condition", "Assisted_Living", "Balcony_Terrace", "Bathroom_Window", "Bathtub", "Cellar", "Commission_Free", "Elevator", "Exclusive", "Garden", "Kitchen_Fully_Equipped", "No_Media", "Parking_Garage", "Pets_Allowed", "Reduce_Mobility_Access", "Swimming_Pool", "Vacant")
- `features_excluded` (array) — Excluded features (default: []; one of: "Air_Condition", "Assisted_Living", "Balcony_Terrace", "Bathroom_Window", "Bathtub", "Cellar", "Commission_Free", "Elevator", "Exclusive", "Garden", "Kitchen_Fully_Equipped", "No_Media", "Parking_Garage", "Pets_Allowed", "Reduce_Mobility_Access", "Swimming_Pool", "Vacant")
- `build_states` (array) — Building condition filter (default: []; one of: "First_Time_Use", "First_Time_Use_After_Refurbishment", "Fully_Renovated", "Mint_Condition", "Modernised", "Need_Of_Renovation", "Negotiable", "No_Information", "Partly_Renovated", "Projected", "Refurbished", "Restructured", "Ripe_For_Demolition", "Well_Kept")
- `furnished` (array) — Furnishing filter (default: []; one of: "Full", "Part", "No", "Not_Applicable")
- `energy_classes` (array) — Energy efficiency class filter (default: []; one of: "A_PLUS", "A", "B", "C", "D", "E", "F", "G", "H")
- `locations_in_building` (array) — Position of the unit inside the building (default: []; one of: "Groundfloor", "Half_Basement", "Roof_Storey")
- `min_price` (integer, nullable) — Minimum price in EUR (min: 0)
- `max_price` (integer, nullable) — Maximum price in EUR (min: 0)
- `min_area` (integer, nullable) — Minimum living area in m² (min: 0)
- `max_area` (integer, nullable) — Maximum living area in m² (min: 0)
- `min_plot` (integer, nullable) — Minimum plot area in m² (min: 0)
- `max_plot` (integer, nullable) — Maximum plot area in m² (min: 0)
- `min_rooms` (number, nullable) — Minimum number of rooms (min: 0)
- `max_rooms` (number, nullable) — Maximum number of rooms (min: 0)
- `min_year` (integer, nullable) — Minimum construction year (min: 0)
- `max_year` (integer, nullable) — Maximum construction year (min: 0)
- `sort` (string) — Result ordering (default: "Default"; one of: "Default", "DateDesc", "PriceAsc", "PriceDesc")
- `count` (integer, required) — Max number of results to return (min: 1)

## Response

### 200 — Successful Response

- `@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 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: 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

Location could not be resolved

What to do: 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

What to do: 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

What to do: 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

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these 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.