{ "openapi": "3.0.1", "info": { "title": "Immowelt.de Scraper - Rent & Buy Listings, New Listings Monitor", "description": "Scrape immowelt.de apartments and houses for rent or sale by city: cold and warm rent, price, m², rooms, €/m², address, district, floor, energy class, agency, photos. Only-new mode for alerts. Duplicates are free.", "version": "0.1", "x-build-id": "JqelNcK4RR68Y1gb6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/aidnurs~immowelt-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-aidnurs-immowelt-scraper", "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/aidnurs~immowelt-scraper/runs": { "post": { "operationId": "runs-sync-aidnurs-immowelt-scraper", "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/aidnurs~immowelt-scraper/run-sync": { "post": { "operationId": "run-sync-aidnurs-immowelt-scraper", "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": { "locations": { "title": "Locations", "type": "array", "description": "German cities or towns to search, one per line (\"Berlin\", \"München\", \"Frankfurt am Main\"). Each city page also links its districts, which the Actor reads too (see below).", "items": { "type": "string" } }, "dealType": { "title": "Rent or buy", "enum": [ "rent", "buy" ], "type": "string", "description": "Listings for rent (Miete) or for sale (Kauf). Applies to 'Locations'.", "default": "rent" }, "propertyType": { "title": "Property type", "enum": [ "apartment", "house" ], "type": "string", "description": "Apartments (Wohnungen) or houses (Häuser). Applies to 'Locations'.", "default": "apartment" }, "startUrls": { "title": "Search URLs", "type": "array", "description": "Optional: immowelt.de search pages such as https://www.immowelt.de/suche/mieten/wohnung/berlin/berlin-10115/ad08de8634 or a district / feature page (…/suche/mieten/wohnung/balkon-terrasse/…). Filtered result URLs with 'classified-search?' are closed by immowelt's robots.txt and are skipped: use the filters below instead.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max listings", "minimum": 1, "type": "integer", "description": "Maximum number of listings to save in this run. You only pay for listings saved to the dataset.", "default": 50 }, "includeDistricts": { "title": "Include district pages", "type": "boolean", "description": "Also read the district pages linked from each city page (Berlin: 25 districts). Each search page shows up to 30 listings, so districts multiply coverage.", "default": true }, "includeRoomVariants": { "title": "Include room-count pages", "type": "boolean", "description": "Also read the 1- to 6-room pages linked from each city page for more coverage.", "default": false }, "onlyNewListings": { "title": "Only new listings since last run", "type": "boolean", "description": "Remember the listings you already received and return only new ones. Schedule the Actor (e.g. hourly) for flat alerts.", "default": false }, "stateKey": { "title": "Memory key for 'only new listings'", "type": "string", "description": "Separate memory per alert: use a different key for each saved search.", "default": "default" }, "minPrice": { "title": "Min price (EUR)", "minimum": 0, "type": "integer", "description": "Applied by the Actor to the main price (cold rent or purchase price). Listings without a price are skipped when set." }, "maxPrice": { "title": "Max price (EUR)", "minimum": 0, "type": "integer", "description": "Applied by the Actor to the main price (cold rent or purchase price)." }, "minRooms": { "title": "Min rooms", "minimum": 0, "type": "integer", "description": "Applied by the Actor." }, "maxRooms": { "title": "Max rooms", "minimum": 0, "type": "integer", "description": "Applied by the Actor." }, "minArea": { "title": "Min living area (m²)", "minimum": 0, "type": "integer", "description": "Applied by the Actor." }, "maxArea": { "title": "Max living area (m²)", "minimum": 0, "type": "integer", "description": "Applied by the Actor." }, "sellerType": { "title": "Seller type", "enum": [ "all", "agency", "private" ], "type": "string", "description": "Agencies, private owners or both.", "default": "all" }, "keepContactsInDescription": { "title": "Keep contact details in description", "type": "boolean", "description": "By default phone numbers and personal e-mails in the description snippet are masked. Enable only with a lawful basis (GDPR). Names of private owners and contact persons are never collected.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Usually not needed. If immowelt rate-limits the run (HTTP 429), the Actor switches to Apify Proxy when it is enabled here.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }