{ "openapi": "3.0.1", "info": { "title": "ImmoScout24 Scraper - Property Listings, Agent Phone & Energy", "description": "Scrape ImmobilienScout24 listings in Germany: apartments, houses, land and commercial for sale and rent with price, area, rooms, address, coordinates, energy data, photos and advertiser details. No login. Export CSV, Excel, JSON or XML.", "version": "0.1", "x-build-id": "P20WkK7VzNoxXpdLx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~immobilienscout24-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-immobilienscout24-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/parseforge~immobilienscout24-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-immobilienscout24-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/parseforge~immobilienscout24-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-immobilienscout24-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": { "startUrls": { "title": "Listing or search URLs", "type": "array", "description": "Optional. Paste immobilienscout24.de listing pages (/expose/123456789) to read them in full, or search pages (/Suche/de/...) to run the same search here. Leave empty to search by place below.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "locations": { "title": "Places", "type": "array", "description": "Cities, districts, states or 5-digit postcodes in Germany, one per line (for example Berlin, Hamburg Altona, Bayern, 80331). A postcode or street searches within the radius below.", "items": { "type": "string" } }, "realEstateType": { "title": "Property type and offer", "enum": [ "apartmentrent", "apartmentbuy", "houserent", "housebuy", "flatshareroom", "shorttermaccommodation", "garagerent", "garagebuy", "livingbuysite", "livingrentsite", "tradesite", "office", "store", "gastronomy", "industry", "investment", "compulsoryauction", "assistedliving", "seniorcare" ], "type": "string", "description": "What to search for. Sale and rent are separate searches on the portal.", "default": "apartmentrent" }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000" }, "includeDetails": { "title": "Read the full listing page", "type": "boolean", "description": "On: one extra request per listing adds the description, full equipment list, energy data, advertiser name, phone and imprint, all photos and more (about 70 fields). Off: only the fields shown in the search results (about 25).", "default": true }, "priceMin": { "title": "Minimum price (EUR)", "minimum": 0, "type": "integer", "description": "Purchase price for sale, base rent per month for rent." }, "priceMax": { "title": "Maximum price (EUR)", "minimum": 0, "type": "integer", "description": "Purchase price for sale, base rent per month for rent." }, "priceAsTotalRent": { "title": "Apply the price range to the total rent", "type": "boolean", "description": "Rentals only. Compares the price range with the total rent including service charges instead of the base rent.", "default": false }, "areaMin": { "title": "Minimum living area (m2)", "minimum": 0, "type": "integer", "description": "Living space of apartments and houses." }, "areaMax": { "title": "Maximum living area (m2)", "minimum": 0, "type": "integer", "description": "Living space of apartments and houses." }, "roomsMin": { "title": "Minimum rooms", "minimum": 0, "type": "number", "description": "Number of rooms, halves allowed (2.5)." }, "roomsMax": { "title": "Maximum rooms", "minimum": 0, "type": "number", "description": "Number of rooms, halves allowed (2.5)." }, "yearBuiltMin": { "title": "Built from year", "minimum": 0, "type": "integer", "description": "Earliest construction year." }, "yearBuiltMax": { "title": "Built until year", "minimum": 0, "type": "integer", "description": "Latest construction year." }, "floorMin": { "title": "Lowest floor", "type": "integer", "description": "Floor number, 0 is the ground floor." }, "floorMax": { "title": "Highest floor", "type": "integer", "description": "Floor number, 0 is the ground floor." }, "equipment": { "title": "Must have", "type": "array", "description": "Listings must offer all the selected features.", "items": { "type": "string", "enum": [ "balcony", "lift", "cellar", "builtinkitchen", "garden", "guesttoilet", "parking" ], "enumTitles": [ "Balcony or terrace", "Lift", "Cellar", "Fitted kitchen", "Garden use", "Guest toilet", "Parking space" ] } }, "apartmentTypes": { "title": "Apartment types", "type": "array", "description": "Apartment searches only. Matches any of the selected types.", "items": { "type": "string", "enum": [ "apartment", "groundfloor", "raisedgroundfloor", "roofstorey", "maisonette", "loft", "penthouse", "halfbasement", "other" ], "enumTitles": [ "Standard apartment", "Ground floor", "Raised ground floor", "Attic (Dachgeschoss)", "Maisonette", "Loft", "Penthouse", "Basement apartment", "Other" ] } }, "energyClasses": { "title": "Energy efficiency class", "type": "array", "description": "Matches any of the selected 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" ] } }, "petsAllowed": { "title": "Pets", "enum": [ "yes", "negotiable", "no" ], "type": "string", "description": "Rentals only." }, "minInternetMbit": { "title": "Minimum internet speed", "enum": [ "16", "50", "100", "250", "1000" ], "type": "string", "description": "Only listings at addresses with at least this download speed." }, "newBuildOnly": { "title": "New builds only", "type": "boolean", "description": "Only newly built properties.", "default": false }, "excludeNewBuildProjects": { "title": "Skip developer projects", "type": "boolean", "description": "Leave out units that belong to a new-build project listing.", "default": false }, "sortBy": { "title": "Sort order", "enum": [ "standard", "newest", "oldest", "priceAsc", "priceDesc" ], "type": "string", "description": "Newest first is handy for monitoring new listings.", "default": "standard" }, "radiusKm": { "title": "Radius for postcodes and streets (km)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Searches around a postcode or street reach this far from its centre. Cities, districts and states ignore it.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. If the portal ever refuses the connection, the Actor switches to a German proxy on its own.", "default": { "useApifyProxy": 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 } } } } } } } } } }