{ "openapi": "3.0.1", "info": { "title": "ImmoScout24 Scraper: Listings & Price Changes", "description": "Scrape ImmobilienScout24 (ImmoScout24) real estate listings across Germany: rent and sale, with price, rent, size, rooms and address. Monitor a search for new listings, price changes and removed ones, and add details like Hausgeld, rental income and commission. Flats, houses, land, offices.", "version": "0.1", "x-build-id": "RnyXMPiIPcDWjW2VO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kaleidoscopelabs~immobilienscout24-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kaleidoscopelabs-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/kaleidoscopelabs~immobilienscout24-scraper/runs": { "post": { "operationId": "runs-sync-kaleidoscopelabs-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/kaleidoscopelabs~immobilienscout24-scraper/run-sync": { "post": { "operationId": "run-sync-kaleidoscopelabs-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": { "searchUrls": { "title": "Search URLs", "minItems": 1, "type": "array", "description": "ImmobilienScout24 searches as your browser shows them, one URL per line: run a search on www.immobilienscout24.de, set its filters and sorting, then copy the address bar. Each URL starts with https://www.immobilienscout24.de/Suche/.", "default": [ "https://www.immobilienscout24.de/Suche/de/berlin/berlin/wohnung-mieten?price=-1500&numberofrooms=2.0-&sorting=2" ], "items": { "type": "string" } }, "listingsPerSearch": { "title": "Listings per search", "minimum": 0, "type": "integer", "description": "How many of each search's first results the run stores: 100 stores the listings among its first 100 results. 0 stores every listing a search holds. A result with too little to store, or a listing two of your searches find (stored once, for one of them), leaves its place empty, so a search can end with fewer.", "default": 100 }, "mode": { "title": "What to store", "enum": [ "all", "new", "changes" ], "type": "string", "description": "All stores each search's listings on every run. New stores only the listings this monitor has not seen before among each search's first results (up to Listings per search): sort your search by newest first, so that an older listing moving up the results is not taken for a new one. Changes also stores changed listings, with what they were before and their price history, and listings taken offline (gone from the search, and their page says so): checked only when a run reads the whole search. A listing counts as changed when its price, total rent, living space, rooms or title changes; each changed record lists what changed, with the old and new value. Other fields, such as the availability date, are not compared. A monitor's first run stores the current listings as new, unless Start from now is on.", "default": "all" }, "startFromNow": { "title": "Start from now", "type": "boolean", "description": "On a monitor's first run, record the searches' current listings without storing them, so that later runs deliver only what comes after. Off: the first run stores the current listings.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Keeps this monitor's memory apart from another's on the same search: two schedules on one search with different names (such as weekly-report) each receive every new listing. Leave empty if one monitor watches each search; do not run one monitor twice at the same time." }, "includeDetails": { "title": "Include details ($)", "type": "boolean", "description": "Read each stored listing's page too, charged as a listing with details: costs (service charge, deposit, house money, rental income), availability, floors, bedrooms and bathrooms, condition, energy certificate, parking, features, documents, and the lister's descriptions as published. A listing with details is charged as a listing with details. With a monitor, only new and changed listings are read.", "default": true }, "includeContact": { "title": "Include contact", "type": "boolean", "description": "Add the lister's contact person, company and address to each listing, as its contact field. This is personal data: turn it on only if you have a lawful reason to process it. Needs Include details.", "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 } } } } } } } } } }