{ "openapi": "3.0.1", "info": { "title": "ImmobilienScout24 Scraper", "description": "Scrape ImmobilienScout24 (ImmoScout24) apartments and houses for rent or sale anywhere in Germany: price, warm rent, m², rooms, price per m², address with coordinates, energy class, features, agent, photos and dates. Fast, filters, new-listing alerts. From $1 per 1,000 listings.", "version": "0.1", "x-build-id": "R7KewVmxIClLb7E9p" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tacps126~immobilienscout24-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tacps126-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/tacps126~immobilienscout24-scraper/runs": { "post": { "operationId": "runs-sync-tacps126-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/tacps126~immobilienscout24-scraper/run-sync": { "post": { "operationId": "run-sync-tacps126-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": { "locations": { "title": "Locations", "type": "array", "description": "Cities, districts or regions in Germany, in plain words (e.g. `Berlin`, `München Schwabing`, `Köln`), one per line.", "items": { "type": "string" } }, "propertyType": { "title": "Property type", "enum": [ "apartment", "house" ], "type": "string", "description": "What kind of property.", "default": "apartment" }, "offerType": { "title": "Rent or buy", "enum": [ "rent", "buy" ], "type": "string", "description": "Listings for rent or for sale.", "default": "rent" }, "startUrls": { "title": "Search URLs (optional)", "type": "array", "description": "Or paste ImmoScout24 search result pages from your browser, with any filters you set there. Each is crawled as given.", "items": { "type": "string" } }, "minPrice": { "title": "Min price (€)", "minimum": 0, "type": "number", "description": "Lowest price or monthly cold rent." }, "maxPrice": { "title": "Max price (€)", "minimum": 0, "type": "number", "description": "Highest price or monthly cold rent." }, "minArea": { "title": "Min living area (m²)", "minimum": 0, "type": "number", "description": "Min living area (m²)." }, "maxArea": { "title": "Max living area (m²)", "minimum": 0, "type": "number", "description": "Max living area (m²)." }, "minRooms": { "title": "Min rooms", "minimum": 0, "type": "number", "description": "Min rooms." }, "maxRooms": { "title": "Max rooms", "minimum": 0, "type": "number", "description": "Max rooms." }, "sort": { "title": "Sort by", "enum": [ "default", "newest" ], "type": "string", "description": "Order of results.", "default": "default" }, "seller": { "title": "Seller", "enum": [ "all", "private", "agent" ], "type": "string", "description": "Keep listings from everyone, only private sellers, or only agents. Skipped listings are never charged.", "default": "all" }, "maxItems": { "title": "Max listings", "minimum": 1, "type": "integer", "description": "Maximum number of listings to return in total.", "default": 200 }, "maxPagesPerSearch": { "title": "Max pages per search", "minimum": 1, "maximum": 500, "type": "integer", "description": "Result pages to read for each location or search URL (about 20 listings per page, more when new-build projects group their units).", "default": 10 }, "onlyNew": { "title": "Only new listings", "type": "boolean", "description": "Return only listings that no earlier run with the same input has delivered. Ideal for alerts — you pay only for new listings.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Optional name for the “only new” history, so several monitors can run side by side." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "German residential proxy is used by default — ImmoScout24 blocks cloud IPs.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "DE" } }, "tenantId": { "title": "Tenant ID", "type": "string", "description": "Optional label used to keep separate histories for different clients or teams." }, "debug": { "title": "Debug", "type": "boolean", "description": "Save extra diagnostics with the run.", "default": 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 } } } } } } } } } }