{ "openapi": "3.0.1", "info": { "title": "Immowelt Scraper ($0.65/1K) - German Property Listings", "description": "Scrape real-estate listings from Immowelt (immowelt.de), Germany's big property portal: apartments, houses, land and commercial property for sale and for rent. Filter by city, state or postcode, price, rooms and area. Newest first, with agent phone. Add-on: full details and energy data.", "version": "0.0", "x-build-id": "chXum3o9kjmYpLMMN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/carabain-digital~immowelt-listings/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-carabain-digital-immowelt-listings", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/carabain-digital~immowelt-listings/runs": { "post": { "operationId": "runs-sync-carabain-digital-immowelt-listings", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/carabain-digital~immowelt-listings/run-sync": { "post": { "operationId": "run-sync-carabain-digital-immowelt-listings", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "location": { "title": "Location", "type": "string", "description": "German city, state, borough or postcode. Several values separated by commas. Example: `Hamburg`, `Berlin, Potsdam` or `Bayern`. Required unless you give search URLs. Ignored when you give search URLs." }, "listing_type": { "title": "Sale or rent", "enum": [ "sale", "rent" ], "type": "string", "description": "`sale` for properties to buy, `rent` for rentals. Example: `rent`.", "default": "sale" }, "property_type": { "title": "Property type", "enum": [ "any", "house", "apartment", "land", "commercial", "parking" ], "type": "string", "description": "Type of property. `any` = houses and apartments. Example: `apartment`.", "default": "any" }, "min_price": { "title": "Minimum price (EUR)", "minimum": 0, "type": "integer", "description": "Lowest price in euro (rent: cold rent per month). Example: `200000`, for rent `800`." }, "max_price": { "title": "Maximum price (EUR)", "minimum": 0, "type": "integer", "description": "Highest price in euro (rent: cold rent per month). Example: `450000`, for rent `1500`." }, "min_rooms": { "title": "Minimum rooms", "minimum": 0, "type": "number", "description": "Minimum number of rooms (Zimmer, living room included). Half rooms count: `2.5`. Example: `3`." }, "min_living_area_m2": { "title": "Minimum living area (m2)", "minimum": 0, "type": "integer", "description": "Minimum living area in square metres. Example: `60`." }, "start_urls": { "title": "Search URLs (optional)", "type": "array", "description": "Search result pages copied from immowelt.de; they replace the filters above. Example: `https://www.immowelt.de/classified-search?distributionTypes=Rent&estateTypes=Apartment&locations=AD08DE8634&priceMax=1500`. Filters in the URL are kept; a `/suche/hamburg/wohnungen/mieten` style page works too. Leave empty to use the filters above.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "limit": { "title": "Max listings", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many listings (newest first). Example: `100`. Immowelt shows at most 10,000 results per search (333 pages): use a city, borough or price range to go deeper.", "default": 100 }, "includeDetails": { "title": "Full details (paid add-on)", "type": "boolean", "description": "Also open each listing's page: full description, coordinates (when the exact address is public), construction year, condition, heating, energy certificate data, amenities, deposit and all photos. Adds $1.00 per 1,000 listings on top of the base price. One extra request per listing, so runs take a little longer.", "default": false }, "trackHistory": { "title": "Price history (paid add-on)", "type": "boolean", "description": "Keep the price and status of every listing in a named store in your own Apify account and add first_seen_at, previous_price, price_change, price_change_pct, status_changed and price_history to each item. Run it on a schedule: the first run only starts the series. Adds $1.00 per 1,000 listings that already had history. Do not run two runs on the same store at once.", "default": false }, "historyStoreName": { "title": "History store name", "type": "string", "description": "Name of the key-value store that holds the history (letters a-z, digits, dashes). All our real-estate Actors use `realestate-history` by default, so history is shared between them. Use another name to keep a separate series per search, e.g. `gent-apartments`.", "default": "realestate-history" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Immowelt (DataDome) blocks datacenter IPs, so a German residential proxy is needed. The default (Apify Residential, country DE) works; a few exits are blocked and the Actor then retries on a fresh one. Change it only to use your own proxy.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "DE" } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }