{ "openapi": "3.0.1", "info": { "title": "ImmoScout24 Scraper – Germany Real Estate", "description": "Export German ImmoScout24 apartment, house and plot listings with prices, size and location. Start with a city or search URL and a bounded result limit.", "version": "1.0", "x-build-id": "1OQZrabXjLeErtTjj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ninhothedev~immoscout24-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ninhothedev-immoscout24-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/ninhothedev~immoscout24-scraper/runs": { "post": { "operationId": "runs-sync-ninhothedev-immoscout24-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/ninhothedev~immoscout24-scraper/run-sync": { "post": { "operationId": "run-sync-ninhothedev-immoscout24-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": { "searchUrl": { "title": "ImmoScout24 search URL (optional)", "type": "string", "description": "Paste a German https://www.immobilienscout24.de/Suche/de/... search URL. When supplied, its source filters replace city/type/price/room/area form filters. Starts from page one." }, "city": { "title": "City", "type": "string", "description": "German city name. Defaults to Berlin; ignored when searchUrl is supplied. For an exact location or an unsupported city path, paste the website search URL.", "default": "Berlin" }, "maxItems": { "title": "Maximum unique listings (whole run)", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Global limit after deduplication and before optional details. Console prefill 5 for a small first run; API default 2000 preserves existing maxPages workflows.", "default": 2000 }, "propertyType": { "title": "Property Type", "enum": [ "wohnung", "haus", "grundstueck" ], "type": "string", "description": "Type of property to search for: apartment (Wohnung), house (Haus), or plot (Grundstück).", "default": "wohnung" }, "priceType": { "title": "Buy or Rent", "enum": [ "kauf", "miete" ], "type": "string", "description": "Whether to search for properties for sale (Kaufen) or for rent (Mieten).", "default": "kauf" }, "priceMin": { "title": "Min. Price (€)", "minimum": 0, "type": "integer", "description": "Minimum price in Euro. Leave empty for no lower price limit." }, "priceMax": { "title": "Max. Price (€)", "minimum": 0, "type": "integer", "description": "Maximum price in Euro. Leave empty for no upper price limit." }, "roomsMin": { "title": "Min. Rooms", "minimum": 1, "type": "number", "description": "Minimum number of rooms (supports half rooms, e.g. 2.5). Leave empty for no lower limit." }, "roomsMax": { "title": "Max. Rooms", "minimum": 1, "type": "number", "description": "Maximum number of rooms (supports half rooms, e.g. 4.5). Leave empty for no upper limit." }, "areaMin": { "title": "Min. Area (m²)", "minimum": 0, "type": "integer", "description": "Minimum living area in square meters. Leave empty for no lower limit." }, "areaMax": { "title": "Max. Area (m²)", "minimum": 0, "type": "integer", "description": "Maximum living area in square meters. Leave empty for no upper limit." }, "maxPages": { "title": "Max. Result Pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum source pages to request (1–50). The scraper stops earlier at maxItems, the run budget or the last source page. Listing counts per page can vary.", "default": 5 }, "enrichDetails": { "title": "Enrich with Detail Pages", "type": "boolean", "description": "Attempt each selected listing page to add description (up to 20,000 characters) and photos/fields when exposed. Adds requests and runtime. See detail_status per row; failed detail attempts retain the valid search record.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Optional Apify Proxy settings. Configured proxy failures stop the run instead of silently using a direct connection. A proxy does not guarantee access." } } }, "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 } } } } } } } } } }