{ "openapi": "3.0.1", "info": { "title": "Immowelt.de Scraper", "description": "Scrape Immowelt.de, a leading German property marketplace. Look up listings by id or URL, find similar listings, search for sale or rent by city/district/postcode or URL with filters, resolve locations via autocomplete, and pull agencies (by location and their listings).", "version": "1.0", "x-build-id": "2iSvVGeQhW9ns5jPF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/one-api~immowelt-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-one-api-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/one-api~immowelt-scraper/runs": { "post": { "operationId": "runs-sync-one-api-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/one-api~immowelt-scraper/run-sync": { "post": { "operationId": "run-sync-one-api-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": { "property_inputs": { "title": "Listing id or immowelt.de URL (one per line)", "type": "array", "description": "Auto-detects each entry and calls the right endpoint:\n• An Immowelt listing id (e.g. `256Q14GY2JL7`, or the legacyId UUID) → `/details/byid`\n• An `https://www.immowelt.de/expose/...` URL → `/details/byurl`\n\nEach row = one full property record (price, size, rooms, energy class, coordinates, features, photos, agency contact + phone).", "items": { "type": "string" } }, "similar_ids": { "title": "Listing id to find similar listings for (one per line)", "type": "array", "description": "For each listing id, returns listings in the same area / type / price band via `/details/similar`. Use the Results-per-page filter below to cap how many. One row per similar listing.", "items": { "type": "string" } }, "search_inputs": { "title": "Location or search-results URL (one per line)", "type": "array", "description": "Auto-detects each entry and routes to the right `/search/*` endpoint:\n• An immowelt.de results URL, e.g. `https://www.immowelt.de/suche/berlin/wohnungen/mieten` → `/search/byurl`\n• Anything else (city, district or postcode, e.g. `Berlin`, `München`, `10115`) → `/search/bylocation`\n\nThe filters below apply to every `bylocation` query. Each hit returns one row per listing.", "items": { "type": "string" } }, "searchType": { "title": "Deal type", "enum": [ "For_Sale", "For_Rent" ], "type": "string", "description": "Buy (kaufen) or rent (mieten). Applies to Search and Agency sections.", "default": "For_Sale" }, "propertyType": { "title": "Property type", "enum": [ "", "Apartment", "House", "Land", "Office", "Garage", "Parking", "Investment" ], "type": "string", "description": "Type to search for. Comma-separate for multiple, or leave as Any.", "default": "" }, "priceRange": { "title": "Price range (€)", "type": "string", "description": "Format: `min:200000,max:600000` — or just `min:200000` / `max:600000`.", "default": "" }, "rooms": { "title": "Rooms (Zimmer)", "type": "string", "description": "Number of rooms, e.g. `min:3` or `min:2,max:4`.", "default": "" }, "bedrooms": { "title": "Bedrooms", "type": "string", "description": "Number of bedrooms, e.g. `min:2`.", "default": "" }, "areaRange": { "title": "Living area (m²)", "type": "string", "description": "Living area in m², e.g. `min:60,max:140`.", "default": "" }, "plotRange": { "title": "Plot / land area (m²)", "type": "string", "description": "Plot or land area in m² (houses & land), e.g. `min:300`.", "default": "" }, "yearBuilt": { "title": "Year built", "type": "string", "description": "Construction year, e.g. `min:2010`.", "default": "" }, "sortOrder": { "title": "Sort order", "enum": [ "Recommended", "Newest", "Price_Low_to_High", "Price_High_to_Low", "Largest_Area" ], "type": "string", "description": "Result ordering for `/search/bylocation`.", "default": "Recommended" }, "pages": { "title": "Pages per search", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many pages to fetch for each `/search/bylocation` query (~30 listings per page).", "default": 1 }, "resultCount": { "title": "Results per page", "minimum": 1, "maximum": 100, "type": "integer", "description": "Listings per page for search, and how many similar listings to return (1–100; ~30/page upstream).", "default": 20 }, "autocomplete_inputs": { "title": "Location text to resolve (one per line)", "type": "array", "description": "Resolve a German city / district / postcode to the Immowelt placeId used by Search via `/autocomplete`. Each suggestion = one row.", "items": { "type": "string" } }, "agency_location_inputs": { "title": "Location to find agencies in (one per line)", "type": "array", "description": "Real-estate agencies currently advertising in a location, with each one's listing count and logo, via `/agent/search`. Uses the Deal type above. Each agency = one row.", "items": { "type": "string" } }, "agency_listings_inputs": { "title": "Location | Agency name (one per line)", "type": "array", "description": "Listings held by a named agency in a location, via `/agent/listings`. One entry per line, formatted as `Location | Agency name`, e.g. `Berlin | BSK Immobilien GmbH` (agency name is case-insensitive, partial match). Discover agency names with the Agencies-by-location section. Uses the Deal type above. One row per listing.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }