{ "openapi": "3.0.1", "info": { "title": "ImmobilienScout24 Listings Scraper", "description": "ImmobilienScout24 Listings Scraper SD - ImmobilienScout24 Listings Scraper is a real estate data tool that extracts ImmoScout24 rent and sale listings: price, rooms, m2, rent and buying costs, commission, energy, address, photos, agent and full description, with the site's own filters.", "version": "1.0", "x-build-id": "gVIGYnM1zQvTPalfB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/neuro-scraper~immobilienscout24-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-neuro-scraper-immobilienscout24-listings-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/neuro-scraper~immobilienscout24-listings-scraper/runs": { "post": { "operationId": "runs-sync-neuro-scraper-immobilienscout24-listings-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/neuro-scraper~immobilienscout24-listings-scraper/run-sync": { "post": { "operationId": "run-sync-neuro-scraper-immobilienscout24-listings-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": { "location": { "title": "Location", "type": "string", "description": "City, district, quarter or postcode as you would type it on ImmobilienScout24 (Berlin, München, Hamburg-Altona, 10115) - resolved with ImmobilienScout24's own location search on every run. A postcode searches its quarter(s) and keeps only listings with that postcode. A geopath such as /de/bayern/muenchen is used as is." }, "locations": { "title": "More locations", "type": "array", "description": "Further locations, one per line, searched with the same property type and filters (e.g. Köln, Frankfurt am Main).", "items": { "type": "string" } }, "startUrls": { "title": "Search or listing URLs", "type": "array", "description": "ImmobilienScout24 links copied from the browser: search pages (https://www.immobilienscout24.de/Suche/de/berlin/berlin/wohnung-mieten?price=-1500, radius searches /Suche/radius/...) keep their area, type and filters; listing pages (https://www.immobilienscout24.de/expose/168052908) are scraped as single listings. The filters below are added when the link does not set them.", "items": { "type": "string" } }, "properties": { "title": "Listing IDs", "type": "array", "description": "ImmobilienScout24 listing IDs (Scout-ID, e.g. 168052908) to fetch directly with full detail.", "items": { "type": "string" } }, "latitude": { "title": "Latitude (radius search)", "type": "number", "description": "Centre of a radius search, e.g. 48.137. Used together with Longitude and Radius." }, "longitude": { "title": "Longitude (radius search)", "type": "number", "description": "Centre of a radius search, e.g. 11.575." }, "radiusKm": { "title": "Radius (km)", "minimum": 1, "maximum": 200, "type": "integer", "description": "Radius of the coordinate search in km (also used when a typed location resolves to a point instead of an area).", "default": 10 }, "operation": { "title": "Rent or buy", "enum": [ "rent", "buy" ], "type": "string", "description": "Rental or sale listings for Location / coordinates (search URLs carry their own).", "default": "rent" }, "propertyType": { "title": "Property type", "enum": [ "apartment", "house", "plot", "garage", "temporary-living", "shared-flat", "prefab-house" ], "type": "string", "description": "ImmobilienScout24's property category.", "default": "apartment" }, "minPrice": { "title": "Min price (EUR)", "minimum": 0, "type": "integer", "description": "ImmobilienScout24's price filter (rent per month or purchase price), e.g. 500." }, "maxPrice": { "title": "Max price (EUR)", "minimum": 0, "type": "integer", "description": "Upper price bound, e.g. 1500." }, "priceType": { "title": "Rent price means", "enum": [ "rentpermonth", "calculatedtotalrent" ], "type": "string", "description": "Rent searches only: whether Min/Max price apply to the net rent or the total rent." }, "minRooms": { "title": "Min rooms", "minimum": 0, "type": "number", "description": "e.g. 2 (half rooms allowed: 2.5)." }, "maxRooms": { "title": "Max rooms", "minimum": 0, "type": "number", "description": "e.g. 4." }, "minLivingSpace": { "title": "Min living space (m2)", "minimum": 0, "type": "integer", "description": "e.g. 50." }, "maxLivingSpace": { "title": "Max living space (m2)", "minimum": 0, "type": "integer", "description": "e.g. 120." }, "minGround": { "title": "Min plot area (m2)", "minimum": 0, "type": "integer", "description": "Plots: ImmobilienScout24's plot-area filter. Houses: applied by the Actor to the detail's plot area (needs Fetch details)." }, "maxGround": { "title": "Max plot area (m2)", "minimum": 0, "type": "integer", "description": "Upper plot-area bound (same rules as Min plot area)." }, "minConstructionYear": { "title": "Min construction year", "minimum": 1000, "maximum": 2100, "type": "integer", "description": "e.g. 1990." }, "maxConstructionYear": { "title": "Max construction year", "minimum": 1000, "maximum": 2100, "type": "integer", "description": "e.g. 2026." }, "apartmentTypes": { "title": "Apartment types", "type": "array", "description": "Apartment searches: any of these apartment types.", "items": { "type": "string", "enum": [ "apartment", "groundfloor", "halfbasement", "loft", "maisonette", "other", "penthouse", "raisedgroundfloor", "roofstorey", "terracedflat" ], "enumTitles": [ "Flat (Etagenwohnung)", "Ground floor", "Half basement", "Loft", "Maisonette", "Other", "Penthouse", "Raised ground floor", "Roof storey", "Terraced flat" ] } }, "buildingTypes": { "title": "House types", "type": "array", "description": "House searches: any of these house types.", "items": { "type": "string", "enum": [ "singlefamilyhouse", "semidetachedhouse", "midterracehouse", "endterracehouse", "terracehouse", "multifamilyhouse", "bungalow", "villa", "farmhouse", "castlemanorhouse", "specialrealestate", "otherrealestate" ], "enumTitles": [ "Single-family house", "Semi-detached house", "Mid-terrace house", "End-terrace house", "Terraced house", "Multi-family house", "Bungalow", "Villa", "Farmhouse", "Castle / manor house", "Special property", "Other" ] } }, "equipment": { "title": "Equipment", "type": "array", "description": "Only listings with all of these features (ImmobilienScout24's equipment filter).", "items": { "type": "string", "enum": [ "balcony", "builtinkitchen", "garden", "parking", "cellar", "lift", "guesttoilet", "handicappedaccessible" ], "enumTitles": [ "Balcony / terrace", "Fitted kitchen", "Garden", "Garage / parking space", "Cellar", "Lift", "Guest toilet", "Step-free access" ] } }, "energyEfficiencyClasses": { "title": "Energy efficiency classes", "type": "array", "description": "Any of these energy 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" ] } }, "newBuildingOnly": { "title": "New buildings only", "type": "boolean", "description": "Only new-build listings (Neubau).", "default": false }, "excludeNewBuildProjects": { "title": "Exclude new-build project units", "type": "boolean", "description": "Leave out units of developer projects (Neubauprojekte) - ImmobilienScout24's own exclusion filter plus a check of each card's project flag.", "default": false }, "publishedAfter": { "title": "Published after", "type": "string", "description": "Only listings published on or after this day (YYYY-MM-DD). Searches newest first and stops at older listings. The app gives the age as text ('2 days ago', 'a month ago'), so beyond about 4 weeks the cut is approximate." }, "sortBy": { "title": "Sort by", "enum": [ "standard", "newest", "priceAsc", "priceDesc", "livingSpaceAsc", "livingSpaceDesc" ], "type": "string", "description": "ImmobilienScout24's sort orders.", "default": "standard" }, "fetchDetails": { "title": "Fetch details", "type": "boolean", "description": "Open every listing's expose for descriptions, all costs (deposit, ancillary/heating costs, Hausgeld, commission, land transfer tax, notary, land registry), bathrooms, bedrooms, energy data, features, all photos and the agent. Off = only the search-card fields (faster).", "default": true }, "monitorMode": { "title": "Monitor mode (only new listings)", "type": "boolean", "description": "Remember the listing IDs delivered for each search (named key-value store immobilienscout24-monitor) and on later runs return only listings not delivered before. The first run returns everything it finds.", "default": false }, "language": { "title": "Language", "enum": [ "en", "de" ], "type": "string", "description": "Language of ImmobilienScout24's labels and texts (titles, criteria, 'published' text). Advertisers' descriptions stay as written.", "default": "en" }, "maxItems": { "title": "Max listings", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Total listings to return. The Actor follows ImmobilienScout24's page numbers (50 listings per page) until this number or the last page of each search (measured: 247 pages / 12,341 listings reachable).", "default": 50 }, "startPage": { "title": "Start page", "minimum": 1, "type": "integer", "description": "Result page to start from (50 listings per page) - e.g. to continue a run that reached its limit. A pagenumber in a search URL is used when this is 1.", "default": 1 }, "maxPages": { "title": "Max pages per search", "minimum": 0, "type": "integer", "description": "Stop each search after this many result pages (0 = no page limit; Max listings still applies).", "default": 0 }, "maxConcurrency": { "title": "Parallel detail requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many listing details are fetched at the same time (each through its own proxy session). ImmoScout24 rate-limits its app API: when it answers 'Request blocked', all requests pause (60-180 s) and continue.", "default": 2 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "RESIDENTIAL in Germany is the default. ImmobilienScout24's app API also answered from other countries in our tests.", "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 }, "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 } } } } } } } } } }