{ "openapi": "3.0.1", "info": { "title": "Immowelt Property Listings Scraper", "description": "Scrape public Immowelt property listings into structured records with prices, rooms, areas, locations, images, descriptions, and source URLs for German real-estate research.", "version": "1.0", "x-build-id": "dlFcrh6O0dWbMU5xh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/muhammadafzal~immowelt-property-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-muhammadafzal-immowelt-property-listings-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/muhammadafzal~immowelt-property-listings-scraper/runs": { "post": { "operationId": "runs-sync-muhammadafzal-immowelt-property-listings-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/muhammadafzal~immowelt-property-listings-scraper/run-sync": { "post": { "operationId": "run-sync-muhammadafzal-immowelt-property-listings-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": { "searchUrls": { "title": "Immowelt search URLs", "maxItems": 20, "type": "array", "description": "Use this for public Immowelt result pages, for example https://www.immowelt.de/suche/wohnungen/mieten. Search filters should be encoded in the URL; direct expose URLs belong in startUrls.", "items": { "type": "string" }, "default": [ "https://www.immowelt.de/suche/wohnungen/mieten" ] }, "startUrls": { "title": "Listing URLs", "maxItems": 50, "type": "array", "description": "Use this for public Immowelt search or expose pages you already know. Example: https://www.immowelt.de/expose/183d17ce-dac2-4769-9d50-a6d39e16fec0.", "items": { "type": "object", "properties": { "url": { "type": "string", "title": "Immowelt URL", "description": "A public Immowelt search or expose URL." } }, "required": [ "url" ] } }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 500, "type": "integer", "description": "Use this to cap listings written to the dataset and control run time; valid range is 1–500 and the default is 20.", "default": 20 }, "maxPages": { "title": "Maximum pages per search", "minimum": 1, "maximum": 20, "type": "integer", "description": "Use this to limit pagination for each search URL; page numbers are added as the public Immowelt page query parameter. Range 1–20; default 1.", "default": 1 }, "scrapeDetails": { "title": "Try detail enrichment", "type": "boolean", "description": "Use true to attempt each public expose page for richer descriptions, agency, and images. If Immowelt blocks a detail page, the Actor returns its available search-card data. Default false for faster, more reliable runs.", "default": false }, "useProxy": { "title": "Use Apify Proxy", "type": "boolean", "description": "Use this when direct Immowelt requests are challenged or rate-limited. Proxy usage may incur Apify platform charges; default false.", "default": false }, "proxyCountry": { "title": "Proxy country", "pattern": "^[A-Za-z]{2}$", "maxLength": 2, "type": "string", "description": "Optional two-letter proxy country code, such as DE. Leave blank to use the default proxy routing." } } }, "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 } } } } } } } } } }