{ "openapi": "3.0.1", "info": { "title": "ImmoScout24 Scraper", "description": "Scrape ImmobilienScout24 (immobilienscout24.de) property listings by city or search URL: price, rooms, living space, address, coordinates, amenities, agent, and images. Export JSON, CSV, Excel.", "version": "1.0", "x-build-id": "g35vVpw6m7AsSYN6o" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parsebird~immoscout24-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parsebird-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/parsebird~immoscout24-scraper/runs": { "post": { "operationId": "runs-sync-parsebird-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/parsebird~immoscout24-scraper/run-sync": { "post": { "operationId": "run-sync-parsebird-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": { "mode": { "title": "Search mode", "enum": [ "location", "url" ], "type": "string", "description": "Search by location (city + state) or scrape ImmoScout24 search URLs directly.", "default": "location" }, "locations": { "title": "Locations", "type": "array", "description": "List of { \"state\": , \"city\": } objects. State slugs: baden-wuerttemberg, bayern, berlin, brandenburg, bremen, hamburg, hessen, mecklenburg-vorpommern, niedersachsen, nordrhein-westfalen, rheinland-pfalz, saarland, sachsen, sachsen-anhalt, schleswig-holstein, thueringen.", "default": [ { "state": "berlin", "city": "Berlin" } ] }, "urls": { "title": "Search URLs", "type": "array", "description": "ImmoScout24 search URLs (url mode). Your filters in the URL are kept. A pagenumber=N in the URL is used as the first page to scrape.", "items": { "type": "string" } }, "listingType": { "title": "Listing type", "enum": [ "buy", "rent" ], "type": "string", "description": "Buy or rent (location mode).", "default": "buy" }, "propertyType": { "title": "Property type", "enum": [ "apartment", "house" ], "type": "string", "description": "Apartment or house (location mode).", "default": "apartment" }, "priceMin": { "title": "Min price (EUR)", "minimum": 0, "type": "integer", "description": "Lower price bound in EUR." }, "priceMax": { "title": "Max price (EUR)", "minimum": 0, "type": "integer", "description": "Upper price bound in EUR." }, "roomsMin": { "title": "Min rooms", "minimum": 0, "type": "number", "description": "Minimum number of rooms." }, "roomsMax": { "title": "Max rooms", "minimum": 0, "type": "number", "description": "Maximum number of rooms." }, "livingSpaceMin": { "title": "Min living space (m²)", "minimum": 0, "type": "number", "description": "Minimum living area in m²." }, "livingSpaceMax": { "title": "Max living space (m²)", "minimum": 0, "type": "number", "description": "Maximum living area in m²." }, "constructionYearMin": { "title": "Min construction year", "minimum": 1800, "type": "integer", "description": "Earliest construction year." }, "constructionYearMax": { "title": "Max construction year", "minimum": 1800, "type": "integer", "description": "Latest construction year." }, "equipment": { "title": "Required amenities", "type": "array", "description": "Only listings that have all selected amenities.", "items": { "type": "string", "enum": [ "balcony", "builtinkitchen", "garden", "lift", "cellar", "guesttoilet", "barrierfree" ], "enumTitles": [ "Balcony/terrace", "Fitted kitchen", "Garden", "Lift", "Cellar", "Guest toilet", "Barrier-free" ] } }, "noCommission": { "title": "Commission-free only", "type": "boolean", "description": "For-sale searches only. ImmoScout24 has no commission-free filter for rentals; it is ignored (with a warning) when listing type is rent.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "default", "newest", "priceAsc", "priceDesc" ], "type": "string", "description": "Result ordering. 'Newest first' is the most useful for monitoring.", "default": "default" }, "maxPages": { "title": "Max pages per search", "minimum": 1, "type": "integer", "description": "About 20 listings per page.", "default": 2 }, "maxListings": { "title": "Max listings", "minimum": 1, "type": "integer", "description": "Total cap on listings saved across all searches. Leave empty for no limit. This is the billed row count." }, "fetchDetails": { "title": "Fetch listing details", "type": "boolean", "description": "Open each listing to add amenities, agent contact, full image gallery, and description. Turn off for a faster, list-only run.", "default": true }, "requestDelay": { "title": "Request delay (ms)", "minimum": 0, "type": "integer", "description": "Delay between API requests, in milliseconds.", "default": 300 }, "maxRetries": { "title": "Max retries", "minimum": 0, "type": "integer", "description": "Retries per request on errors.", "default": 4 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "German residential proxies are recommended.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "DE" } } } }, "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 } } } } } } } } } }