{ "openapi": "3.0.1", "info": { "title": "Immowelt.de Scraper: rent & buy flats, houses (search + alerts)", "description": "Immowelt scraper for immowelt.de: flats and houses to rent or buy in any German city, by filters or any immowelt search URL. Rows with price and price type (Kaltmiete, Kaufpreis), rooms, living and plot area, street, district, city, postcode, agency and photos. Monitor mode alerts on new listings.", "version": "0.1", "x-build-id": "P2vpxCjPUsFz40Plm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datahamster~immowelt-listings/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datahamster-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/datahamster~immowelt-listings/runs": { "post": { "operationId": "runs-sync-datahamster-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/datahamster~immowelt-listings/run-sync": { "post": { "operationId": "run-sync-datahamster-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": { "distribution": { "title": "Rent or buy", "enum": [ "rent", "buy" ], "type": "string", "description": "Whether to search rentals or properties for sale. Accepted values: rent (Mieten), buy (Kaufen). Example: \"rent\".", "default": "rent" }, "estate": { "title": "Estate type", "enum": [ "apartment", "house" ], "type": "string", "description": "Property type. Accepted values: apartment (Wohnung), house (Haus). Example: \"apartment\".", "default": "apartment" }, "locations": { "title": "Cities", "type": "array", "description": "German city names as written on immowelt, one per search; each is searched and paginated separately. Example: [\"Berlin\", \"München\"]. Ignored when searchUrls is set.", "default": [ "Berlin" ], "items": { "type": "string" } }, "priceTo": { "title": "Max price (EUR)", "minimum": 0, "type": "integer", "description": "Maximum price in euros: monthly Kaltmiete when distribution is rent, Kaufpreis when it is buy. Example: 1500. Optional." }, "roomsFrom": { "title": "Min rooms", "minimum": 1, "type": "integer", "description": "Minimum number of rooms (Zimmer), whole number. Example: 3. Optional." }, "areaFrom": { "title": "Min living area (m²)", "minimum": 0, "type": "integer", "description": "Minimum living area in square metres. Example: 60. Optional." }, "searchUrls": { "title": "Search URLs (advanced)", "type": "array", "description": "Any immowelt.de/suche/... result URLs with the filters you set on the site; overrides distribution, estate and locations. Example: [\"https://www.immowelt.de/suche/berlin/wohnungen/mieten\"]. Optional.", "items": { "type": "string" } }, "maxPages": { "title": "Pages", "minimum": 1, "maximum": 3, "type": "integer", "description": "Result pages per search. immowelt renders only the first 32 results server-side; further pages load client-side and usually repeat page 1 (duplicates are never charged), so keep this at 1 and use narrower searches - districts, price bands, room counts - to go deeper. Example: 1.", "default": 1 }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Stop the run after this many listings; you are charged only for listings actually pushed. Example: 20.", "default": 20 }, "mode": { "title": "Mode", "enum": [ "scrape", "monitor" ], "type": "string", "description": "scrape = return all matching listings; monitor = return only listings that are new or changed price since the previous run of this saved Task. Example: \"scrape\".", "default": "scrape" }, "monitorKey": { "title": "Monitor key", "type": "string", "description": "Optional state key for monitor mode when the actor is started directly instead of from a saved Task; any stable string, e.g. \"berlin-wohnung-miete\"." }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Optional HTTPS URL that receives a POST with the monitor-mode change summary (JSON). Example: \"https://hooks.example.com/immowelt\"." }, "telegramBotToken": { "title": "Telegram bot token", "type": "string", "description": "Optional Telegram bot token used to send monitor-mode change summaries. Format: \"123456789:AA...\"." }, "telegramChatId": { "title": "Telegram chat id", "type": "string", "description": "Optional Telegram chat id that receives monitor-mode summaries. Example: \"-1001234567890\"." } } }, "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 } } }, "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 } } } } } } } } } }