{ "openapi": "3.0.1", "info": { "title": "ImmoScout24 Scraper — German Property Listings, Cheap", "description": "ImmoScout24 Scraper for Germany: apartments and houses to rent or buy, plus offices, retail, plots and garages. Search by city or district, or paste a search URL. Price, area, rooms, address, energy class, optional full details and agency. From US$0.80 per 1,000 listings.", "version": "0.1", "x-build-id": "40mox2thaQ020Fcyh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fabrikit~immoscout24-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fabrikit-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/fabrikit~immoscout24-scraper/runs": { "post": { "operationId": "runs-sync-fabrikit-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/fabrikit~immoscout24-scraper/run-sync": { "post": { "operationId": "run-sync-fabrikit-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": { "realEstateType": { "title": "Category", "enum": [ "apartmentrent", "apartmentbuy", "houserent", "housebuy", "office", "store", "industry", "gastronomy", "investment", "garagerent", "garagebuy", "shorttermaccommodation", "livingbuysite", "tradesite", "compulsoryauction", "assistedliving" ], "type": "string", "description": "What to search for. Applies to the locations below (pasted URLs carry their own category).", "default": "apartmentrent" }, "locations": { "title": "Locations", "type": "array", "description": "Cities, districts or postcodes, one search per entry (for example: Köln, Berlin Mitte, München, 20095 Hamburg). A geo path such as /de/bayern/muenchen also works.", "items": { "type": "string" } }, "startUrls": { "title": "ImmoScout24 URLs (optional)", "type": "array", "description": "Search URLs like https://www.immobilienscout24.de/Suche/de/nordrhein-westfalen/koeln/wohnung-mieten?price=-1000 (their filters are kept) or single listing URLs https://www.immobilienscout24.de/expose/.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max listings", "minimum": 1, "type": "integer", "description": "Stop after this many listings in total.", "default": 50 }, "includeDetails": { "title": "Include details (extra cost)", "type": "boolean", "description": "Open each listing to add the description, costs (base rent, service charges, deposit), year built, heating, energy data, features, documents, all photos and agency data. Charged per listing with details.", "default": false }, "minPrice": { "title": "Min price (EUR)", "minimum": 0, "type": "integer", "description": "Minimum price: monthly rent for rentals, purchase price for sales (EUR per m² with price type 'rent per m²')." }, "maxPrice": { "title": "Max price (EUR)", "minimum": 0, "type": "integer", "description": "Maximum price." }, "priceType": { "title": "Price type", "enum": [ "default", "rentpermonth", "rentpersqm", "buy", "calculatedtotalrent" ], "type": "string", "description": "How the price filter is read. Leave on default unless you filter commercial listings (office, retail, industry), which default to rent per month.", "default": "default" }, "minLivingSpace": { "title": "Min area (m²)", "minimum": 0, "type": "integer", "description": "Minimum living or usable area." }, "maxLivingSpace": { "title": "Max area (m²)", "minimum": 0, "type": "integer", "description": "Maximum living or usable area." }, "minRooms": { "title": "Min rooms", "minimum": 0, "type": "integer", "description": "Minimum number of rooms." }, "maxRooms": { "title": "Max rooms", "minimum": 0, "type": "integer", "description": "Maximum number of rooms." }, "minConstructionYear": { "title": "Built from (year)", "minimum": 1000, "type": "integer", "description": "Earliest year of construction." }, "maxConstructionYear": { "title": "Built until (year)", "minimum": 1000, "type": "integer", "description": "Latest year of construction." }, "equipment": { "title": "Equipment", "type": "array", "description": "Only listings with all selected features.", "items": { "type": "string", "enum": [ "balcony", "builtinkitchen", "lift", "garden", "cellar", "guesttoilet", "handicappedaccessible", "parking" ], "enumTitles": [ "Balcony / terrace", "Fitted kitchen", "Lift", "Garden", "Cellar", "Guest toilet", "Step-free access", "Parking" ] } }, "apartmentTypes": { "title": "Apartment types", "type": "array", "description": "Only these apartment types (apartment categories).", "items": { "type": "string", "enum": [ "loft", "penthouse", "terracedflat", "roofstorey", "maisonette", "groundfloor", "raisedgroundfloor", "apartment", "other" ], "enumTitles": [ "Loft / studio", "Penthouse", "Terrace flat", "Attic flat", "Maisonette", "Ground floor", "Raised ground floor", "Apartment", "Other" ] } }, "energyEfficiencyClasses": { "title": "Energy class", "type": "array", "description": "Only these energy efficiency classes.", "items": { "type": "string", "enum": [ "a_plus", "a", "b", "c", "d", "e", "f", "g", "h" ], "enumTitles": [ "A+", "A", "B", "C", "D", "E", "F", "G", "H" ] } }, "newBuilding": { "title": "New builds only", "type": "boolean", "description": "Only new-build listings.", "default": false }, "hideProjects": { "title": "Hide development projects", "type": "boolean", "description": "Skip listings that are part of a building project.", "default": false }, "excludePrivate": { "title": "Skip private offers", "type": "boolean", "description": "Leave out listings from private landlords and sellers. Their personal data is never returned either way.", "default": false }, "sorting": { "title": "Sort order", "enum": [ "-firstactivation", "default", "price", "-price", "livingspace", "-livingspace", "rooms", "firstactivation" ], "type": "string", "description": "How ImmoScout24 sorts the results.", "default": "-firstactivation" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy settings. The default usually works; the Actor switches to German residential IPs by itself if it gets blocked.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }