{ "openapi": "3.0.1", "info": { "title": "Immowelt Property Listings Scraper", "description": "Scrapes property listings from Immowelt.de, Germany's second-largest real estate platform. Extract apartments, houses, and land for sale or rent with prices, room count, area, floor, address, energy class, and agent details.", "version": "0.0", "x-build-id": "LhfUSdF1rXQatCj1s" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~immowelt-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-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/parseforge~immowelt-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-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/parseforge~immowelt-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-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": { "startUrl": { "title": "Immowelt listing URL", "type": "string", "description": "Direct Immowelt search URL (e.g. https://www.immowelt.de/suche/berlin/wohnungen/kaufen). When provided, location/propertyType/transactionType are ignored." }, "maxItems": { "title": "Maximum properties", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of property listings to collect per run." }, "location": { "title": "City or postcode", "type": "string", "description": "City or region in Germany (e.g. 'muenchen', 'berlin', 'hamburg', 'frankfurt-am-main', 'koeln'). Use the URL slug format from immowelt.de." }, "propertyType": { "title": "Property Type", "enum": [ "wohnungen", "haeuser", "wohnungen-haeuser", "grundstuecke", "gewerbe", "garagen-stellplaetze" ], "type": "string", "description": "Type of property to search for.", "default": "wohnungen" }, "transactionType": { "title": "Transaction Type", "enum": [ "kaufen", "mieten" ], "type": "string", "description": "Buy or rent.", "default": "kaufen" }, "includeListingDetails": { "title": "🏠 Include listing details", "type": "boolean", "description": "Adds listingDetails from the expose page: full description, location and further information texts, price, rooms, living space, floor, full address with coordinates, feature lists, year built, building state, heating, the energy certificate (type, class, value, validity), all photos, floor plans, virtual tours, documents, and created and updated dates. One extra request per listing, shared with the other two extras. Charged only for a row that receives it.", "default": false }, "includeAgentContact": { "title": "📞 Include agent contact", "type": "boolean", "description": "Adds agentContact from the expose page: agency name and id, contact person, published phone numbers, agency website and postal address, profile and imprint links, publisher type, private owner flag, rating, review count and partner badges. One extra request per listing, shared with the other two extras. Charged only for a row that receives it.", "default": false }, "includePriceAnalysis": { "title": "💶 Include price analysis", "type": "boolean", "description": "Adds priceAnalysis from the expose page: buyer commission, running costs such as Hausgeld or Nebenkosten, the purchase cost breakdown (notary, land transfer tax, land registry, brokerage) with the estimated total, the estimated monthly rate, and the average, low and high price per square metre Immowelt publishes for the area. One extra request per listing, shared with the other two extras. Charged only for a row that receives it.", "default": false } } }, "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 } } } } } } } } } }