{ "openapi": "3.0.1", "info": { "title": "Immowelt Scraper - German Property Listings & Prices", "description": "Scrape Immowelt property listings for sale or rent by search URL, city or postcode. Export expose ids, addresses, prices, cold and warm rent, floor area, rooms, estate agencies and photos for market research and price monitoring.", "version": "0.1", "x-build-id": "uwwdMzHCFqzhHEoaz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s-r~immowelt-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s-r-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/s-r~immowelt-scraper/runs": { "post": { "operationId": "runs-sync-s-r-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/s-r~immowelt-scraper/run-sync": { "post": { "operationId": "run-sync-s-r-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": { "url": { "title": "Url", "type": "string", "description": "Immowelt classified-search URL; takes precedence over location and filters. Its page and order are preserved unless sort is explicitly supplied." }, "location": { "title": "Location", "type": "string", "description": "German city, district or postcode, resolved by Immowelt autocomplete." }, "location_id": { "title": "Location id", "type": "string", "description": "Immowelt place id, for example AD08DE6345 or POCODE216. Takes precedence over location." }, "operation": { "title": "Operation", "enum": [ "buy", "rent" ], "type": "string", "description": "Buy or rent. Rental price filters apply to monthly cold rent.", "default": "buy" }, "property_type": { "title": "Property type", "enum": [ "apartment", "house", "house_or_apartment", "plot" ], "type": "string", "description": "Property types to search.", "default": "apartment" }, "radius_km": { "title": "Radius km", "minimum": 0, "maximum": 100, "type": "integer", "description": "Search radius in kilometres; used with location or location_id.", "default": 0 }, "price_min": { "title": "Price min", "minimum": 0, "type": "integer", "description": "EUR asking price or monthly cold rent: minimum." }, "price_max": { "title": "Price max", "minimum": 0, "type": "integer", "description": "EUR asking price or monthly cold rent: maximum." }, "area_min": { "title": "Area min", "minimum": 0, "type": "integer", "description": "Living area in square metres: minimum." }, "area_max": { "title": "Area max", "minimum": 0, "type": "integer", "description": "Living area in square metres: maximum." }, "rooms_min": { "title": "Rooms min", "minimum": 0, "type": "integer", "description": "Total rooms (Zimmer), not bedrooms: minimum." }, "rooms_max": { "title": "Rooms max", "minimum": 0, "type": "integer", "description": "Total rooms (Zimmer), not bedrooms: maximum." }, "sort": { "title": "Sort", "enum": [ "default", "newest", "price_asc", "price_desc", "area_asc", "area_desc" ], "type": "string", "description": "Result order. Omit to preserve the order in a supplied URL; otherwise source default." }, "max_items": { "title": "Max items", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum unique listings across the search, including cursor continuation.", "default": 100 }, "cursor": { "title": "Cursor", "type": "string", "description": "Opaque next_cursor from a previous response. Resubmit the same search fields. Apify follows this automatically." } } }, "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 } } } } } } } } } }