{ "openapi": "3.0.1", "info": { "title": "ImmoScout24 Scraper ($0.65/1K) - German Property Listings", "description": "Scrape property listings from ImmoScout24 (immobilienscout24.de), Germany's biggest real-estate portal: apartments, houses, land, garages and WG rooms for rent or sale. Filter by city, price, rooms and area. Newest first. Add-ons: full details with agent phone, price history.", "version": "0.0", "x-build-id": "QmIAcabxIwnhaMRjv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/carabain-digital~immoscout24-listings/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-carabain-digital-immoscout24-listings", "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/carabain-digital~immoscout24-listings/runs": { "post": { "operationId": "runs-sync-carabain-digital-immoscout24-listings", "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/carabain-digital~immoscout24-listings/run-sync": { "post": { "operationId": "run-sync-carabain-digital-immoscout24-listings", "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": "German city, district or state as ImmoScout24's location box knows it. Several separated by commas. Example: `Berlin`, `München`, `Köln - Ehrenfeld` or `Bayern`. Postcodes are not supported (use the district name). Leave empty for all of Germany. Ignored when you give search URLs." }, "listing_type": { "title": "Sale or rent", "enum": [ "sale", "rent" ], "type": "string", "description": "`sale` for properties to buy, `rent` for rentals. Example: `rent`.", "default": "sale" }, "property_type": { "title": "Property type", "enum": [ "any", "apartment", "house", "land", "parking", "room" ], "type": "string", "description": "Type of property. `any` = apartments and houses. Example: `apartment`.", "default": "any" }, "min_price": { "title": "Minimum price (EUR)", "minimum": 0, "type": "integer", "description": "Lowest price in euro (rent: cold rent per month). Example: `200000`, for rent `800`." }, "max_price": { "title": "Maximum price (EUR)", "minimum": 0, "type": "integer", "description": "Highest price in euro (rent: cold rent per month). Example: `450000`, for rent `1500`." }, "min_rooms": { "title": "Minimum rooms", "minimum": 0, "type": "integer", "description": "Minimum number of rooms (German count: living rooms and bedrooms, kitchen and bathroom excluded). Example: `2`." }, "min_living_area_m2": { "title": "Minimum living area (m2)", "minimum": 0, "type": "integer", "description": "Minimum living area in square metres. Example: `60`." }, "start_urls": { "title": "Search URLs (optional)", "type": "array", "description": "Search result pages copied from immobilienscout24.de; they replace the filters above. Example: `https://www.immobilienscout24.de/Suche/de/berlin/berlin/wohnung-mieten?price=-1500.0`. Filters in the URL (price, rooms, living space ...) are kept; results always come newest first. Region and radius searches are supported, drawn map areas are not.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "limit": { "title": "Max listings", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many listings (newest first). Example: `100`.", "default": 100 }, "includeDetails": { "title": "Full details (paid add-on)", "type": "boolean", "description": "Also open each listing's exposé: description, features and location texts, all attributes (floor, deposit, heating, energy certificate ...), bedrooms, bathrooms, plot area, construction year, total rent and service charges, state, agent name, phone and profile, all photos. Adds $1.00 per 1,000 listings on top of the base price. One extra request per listing, so runs take a little longer (about 6 s per 100 listings).", "default": false }, "trackHistory": { "title": "Price history (paid add-on)", "type": "boolean", "description": "Keep the price and status of every listing in a named store in your own Apify account and add first_seen_at, previous_price, price_change, price_change_pct, status_changed and price_history to each item. Run it on a schedule: the first run only starts the series. Adds $1.00 per 1,000 listings that already had history. Do not run two runs on the same store at once.", "default": false }, "historyStoreName": { "title": "History store name", "type": "string", "description": "Name of the key-value store that holds the history (letters a-z, digits, dashes). All our real-estate Actors use `realestate-history` by default, so history is shared between them. Use another name to keep a separate series per search, e.g. `gent-apartments`.", "default": "realestate-history" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "ImmoScout24 blocks datacenter IPs, so a German residential proxy is needed. The default (Apify Residential, country DE) works; change it only to use your own proxy.", "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 } } } } } } } } } }