{ "openapi": "3.0.1", "info": { "title": "ImmoScout24 API Scraper", "description": "Scrape ImmoScout24 real-estate listings (Germany) via the app's private mobile API: search by a human location string with filters, get full listing details incl. all images, facts, agent & contact.", "version": "0.0", "x-build-id": "TGdtL6czlfW8hEtt5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rl1987~immoscout24-api-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rl1987-immoscout24-api-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/rl1987~immoscout24-api-scraper/runs": { "post": { "operationId": "runs-sync-rl1987-immoscout24-api-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/rl1987~immoscout24-api-scraper/run-sync": { "post": { "operationId": "run-sync-rl1987-immoscout24-api-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": "A human-friendly location to search (city, district, ZIP or address), e.g. 'Berlin' or 'München - Schwabing'. Resolved to a geocode via the app's own mobile autocomplete." }, "geocodes": { "title": "Geocode (advanced)", "type": "string", "description": "Optional raw geocode or geopath (e.g. '1276003001' or '/de/berlin/berlin'). Overrides Location. For power users." }, "priceMin": { "title": "Min price (€)", "type": "integer", "description": "Minimum price / rent." }, "priceMax": { "title": "Max price (€)", "type": "integer", "description": "Maximum price / rent." }, "roomsMin": { "title": "Min rooms", "type": "integer", "description": "Minimum number of rooms." }, "roomsMax": { "title": "Max rooms", "type": "integer", "description": "Maximum number of rooms." }, "livingSpaceMin": { "title": "Min living space (m²)", "type": "integer", "description": "Minimum living space in m²." }, "livingSpaceMax": { "title": "Max living space (m²)", "type": "integer", "description": "Maximum living space in m²." }, "sorting": { "title": "Sorting", "enum": [ "", "-firstactivation", "price", "-price", "livingspace", "-livingspace", "rooms", "-rooms" ], "type": "string", "description": "Result ordering.", "default": "" }, "includeDetails": { "title": "Include full listing details", "type": "boolean", "description": "Fetch the full /expose detail for every result (description, all images, facts, agent, contact). Slower but far richer.", "default": true }, "maxItems": { "title": "Max items", "type": "integer", "description": "Maximum number of listings to return (0 = all).", "default": 100 }, "pageSize": { "title": "Page size", "type": "integer", "description": "Results fetched per API page (1-100).", "default": 50 }, "realEstateType": { "title": "Real estate type", "enum": [ "apartmentrent", "apartmentbuy", "houserent", "housebuy", "livingbuysite", "livingrentsite", "flatshareroom", "garagerent", "garagebuy", "office", "store", "gastronomy", "industry", "investment", "compulsoryauction", "shorttermaccommodation", "assistedliving", "seniorcare", "specialpurpose", "tradesite", "housetype" ], "type": "string", "description": "The kind of property to search for." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Route requests through a proxy (Residential Apify Proxy by default).", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } }, "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 } } } } } } } } } }