{ "openapi": "3.0.1", "info": { "title": "Immobilien Scout24", "description": "▎ Scrape real-estate ads from ImmobiliareScout24. Search by city, region or paste listing URLs to collect price, address, rooms, floor area, floor number, property type, energy class, features, images and contact info — exported as JSON, CSV or Excel.", "version": "0.0", "x-build-id": "QKdTcwoGvqtevbPi4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lukass~immobilien-scout24/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lukass-immobilien-scout24", "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/lukass~immobilien-scout24/runs": { "post": { "operationId": "runs-sync-lukass-immobilien-scout24", "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/lukass~immobilien-scout24/run-sync": { "post": { "operationId": "run-sync-lukass-immobilien-scout24", "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", "required": [ "proxy", "operation", "country" ], "properties": { "startUrl": { "title": "🔗 immobilienscout24.de URLs (easiest way)", "type": "array", "description": "Search on immobilienscout24.de in your browser, then paste the resulting URL(s) here — every filter you clicked (rooms, size, features, energy class, ...) is applied automatically. Works with search result pages, drawn map areas (/Suche/shape/...) and single property pages (/expose/...). Leave empty to build a search with the fields below.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "district": { "title": "Location", "type": "string", "description": "City or district to search, e.g. Berlin or Munich. Ignored when a URL is provided above." }, "country": { "title": "Country", "enum": [ "de", "at" ], "type": "string", "description": "Country the location belongs to", "default": "de" }, "operation": { "title": "Operation", "enum": [ "sale", "rent" ], "type": "string", "description": "Scrape properties for sale or for rent", "default": "sale" }, "propertyType": { "title": "Property type", "enum": [ "apartment", "house", "plot", "solid-house", "shorttermaccommodation", "flatshareroom", "garage", "office", "store", "industry", "gastronomy", "tradesite", "specialpurpose", "investment", "compulsoryauction" ], "type": "string", "description": "Type of property to scrape", "default": "apartment" }, "coordinates": { "title": "Coordinates (radius search)", "type": "string", "description": "Search around a point instead of a named place — latitude, longitude, e.g. 52.52, 13.405. Needs a radius below." }, "radiusKm": { "title": "Radius", "type": "integer", "description": "How far around the coordinates above to search" }, "minPrice": { "title": "Minimum price", "type": "integer", "description": "Purchase price for sale listings, base rent per month for rentals" }, "maxPrice": { "title": "Maximum price", "type": "integer", "description": "Purchase price for sale listings, base rent per month for rentals" }, "minRooms": { "title": "Minimum rooms", "type": "integer", "description": "Fewest rooms a listing may have, e.g. 3" }, "maxRooms": { "title": "Maximum rooms", "type": "integer", "description": "Most rooms a listing may have, e.g. 5" }, "minSize": { "title": "Minimum living space", "type": "integer", "description": "Smallest living space in m², e.g. 60" }, "maxSize": { "title": "Maximum living space", "type": "integer", "description": "Largest living space in m², e.g. 120" }, "minConstructionYear": { "title": "Built after", "type": "integer", "description": "Earliest construction year, e.g. 1990" }, "maxConstructionYear": { "title": "Built before", "type": "integer", "description": "Latest construction year, e.g. 2020" }, "equipment": { "title": "Must have", "type": "array", "description": "Only return listings with all of the selected features", "items": { "type": "string", "enum": [ "balcony", "builtinkitchen", "cellar", "garden", "lift", "guesttoilet", "parking", "handicappedaccessible" ], "enumTitles": [ "Balcony / terrace", "Fitted kitchen", "Cellar", "Garden", "Elevator", "Guest toilet", "Parking space", "Step-free access" ] } }, "petsAllowed": { "title": "Pets allowed", "type": "boolean", "description": "Rentals only — only return listings that allow pets", "default": false }, "excludeNewBuildProjects": { "title": "Exclude new-build projects", "type": "boolean", "description": "Skip developer project listings, which often repeat the same building many times", "default": false }, "sortBy": { "title": "Sort results by", "enum": [ "default", "newest", "priceAsc", "priceDesc", "sizeDesc" ], "type": "string", "description": "\"Newest first\" is the one to use for monitoring the market — combine it with a small item limit to get only fresh listings.", "default": "default" }, "maxItems": { "title": "Limit the number of items", "type": "integer", "description": "Stop after this many properties. Leave empty to scrape everything the search returns." }, "endPage": { "title": "Limit of scraped pages", "type": "integer", "description": "Stop after this many result pages (20 properties per page)" }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "RESIDENTIAL proxies are required — datacenter proxies are blocked by the site.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "debugLog": { "title": "Debug log", "type": "boolean", "description": "Log every request the Actor makes — useful when a search returns nothing", "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 } } } } } } } } } }