{ "openapi": "3.0.1", "info": { "title": "ImmobilienScout24 Scraper - ImmoScout24 Germany Listings", "description": "Scrape German ImmoScout24 rental and sale listings with prices, addresses, areas, rooms, agents, photos and coordinates. For investors, proptech teams and agents. Optional expose details.", "version": "0.1", "x-build-id": "DvS6WsdF8Xakoxy9y" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s-r~immobilienscout24-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s-r-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/s-r~immobilienscout24-scraper/runs": { "post": { "operationId": "runs-sync-s-r-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/s-r~immobilienscout24-scraper/run-sync": { "post": { "operationId": "run-sync-s-r-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": "Starturls", "type": "array", "description": "German ImmoScout24 search URLs, as strings or URL objects. Existing filters are preserved; page size and page number are managed automatically." }, "location": { "title": "Location", "maxLength": 300, "type": "string", "description": "German city or district, resolved to the first searchable location. May be combined with startUrls." }, "dealType": { "title": "Dealtype", "enum": [ "rent", "buy" ], "type": "string", "description": "Transaction type for the location search. Explicit search URLs keep their own transaction type.", "default": "rent" }, "propertyType": { "title": "Propertytype", "enum": [ "apartment", "house", "plot" ], "type": "string", "description": "Property type for the location search. Plots require dealType buy.", "default": "apartment" }, "maxItems": { "title": "Maxitems", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum unique listings across all searches, including grouped units.", "default": 100 }, "sorting": { "title": "Sorting", "enum": [ "0", "2", "3", "4", "5", "6", "7", "8" ], "type": "string", "description": "Sort code for location searches. 2 requests the newest listings first; omit for the portal default." }, "includeGroupedUnits": { "title": "Includegroupedunits", "type": "boolean", "description": "Include individual units grouped under development listings. Each unit has grouped_under.", "default": true }, "includeDeactivated": { "title": "Includedeactivated", "type": "boolean", "description": "Include listings marked deactivated by the portal.", "default": false }, "includeDetails": { "title": "Includedetails", "type": "boolean", "description": "Fetch expose descriptions, bedrooms, bathrooms, floor and additional costs for each delivered listing.", "default": false }, "cursor": { "title": "Cursor", "maxLength": 250000, "type": "string", "description": "Opaque next_cursor from the previous response. Keep the original search options and repeat maxItems, or send the remaining volume." }, "minPrice": { "title": "Minprice", "minimum": 0, "type": "integer", "description": "Minimum cold monthly rent or purchase price in EUR for location searches." }, "maxPrice": { "title": "Maxprice", "minimum": 0, "type": "integer", "description": "Maximum cold monthly rent or purchase price in EUR for location searches." }, "minRooms": { "title": "Minrooms", "minimum": 0, "type": "integer", "description": "Minimum total rooms, not bedrooms for location searches." }, "maxRooms": { "title": "Maxrooms", "minimum": 0, "type": "integer", "description": "Maximum total rooms, not bedrooms for location searches." }, "minLivingSpace": { "title": "Minlivingspace", "minimum": 0, "type": "integer", "description": "Minimum living area in square metres for location searches." }, "maxLivingSpace": { "title": "Maxlivingspace", "minimum": 0, "type": "integer", "description": "Maximum living area in square metres for location searches." } } }, "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 } } } } } } } } } }