{ "openapi": "3.0.1", "info": { "title": "ImmoScout24 ImmobilienScout24 Scraper: Phones, Emails | $1.1/1k", "description": "Scrape immobilienscout24.de rentals, sales and commercial listings from $1.10/1k: Kaltmiete, Warmmiete, Nebenkosten, Kaution, size, rooms, Energieausweis, photos, GPS address, agent phone, Impressum and agency e-mails. Search by URL, city or postcode. 130+ fields.", "version": "1.0", "x-build-id": "hvRPBsdSI59LTJulV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pro100chok~immobilienscout24-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pro100chok-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/pro100chok~immobilienscout24-scraper/runs": { "post": { "operationId": "runs-sync-pro100chok-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/pro100chok~immobilienscout24-scraper/run-sync": { "post": { "operationId": "run-sync-pro100chok-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": "Search or listing URLs", "type": "array", "description": "Paste any immobilienscout24.de search results URL (with all your filters from the website) or a listing URL like https://www.immobilienscout24.de/expose/170528322. Mix both freely.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "locations": { "title": "Locations", "type": "array", "description": "Or just type places: a city, district or postcode (e.g. 'Hamburg', 'München Schwabing', '10115'). Each location is searched with the property type and filters below.", "items": { "type": "string" } }, "realEstateType": { "title": "Property type (for Locations)", "enum": [ "apartmentrent", "apartmentbuy", "houserent", "housebuy", "flatshareroom", "shorttermaccommodation", "livingbuysite", "garagerent", "garagebuy", "office", "store", "gastronomy", "industry", "specialpurpose", "tradesite", "investment", "compulsoryauction", "housetype", "assistedliving" ], "type": "string", "description": "What to search for in each location. Ignored for search URLs, which carry their own type.", "default": "apartmentrent" }, "maxItems": { "title": "Max listings", "minimum": 1, "type": "integer", "description": "Maximum number of listings to return across all searches. Each listing is one row.", "default": 100 }, "fetchDetails": { "title": "Full listing details", "type": "boolean", "description": "Open every listing for the full data: description, all costs, energy certificate, all photos, agent name, phone, company, Impressum and website. Turn off for a fast list-only scan (price, size, rooms, address, photo).", "default": true }, "extractEmails": { "title": "Find agency e-mails", "type": "boolean", "description": "Visit the agency's own website (homepage, Impressum, Kontakt) to collect e-mail addresses and social profiles. Every agency website is visited only once per run. Requires full listing details.", "default": true }, "language": { "title": "Labels language", "enum": [ "de", "en" ], "type": "string", "description": "Language of the labels in 'criteria' and of values like condition or heating type. Listing descriptions stay in the language the advertiser wrote them in.", "default": "de" }, "minPrice": { "title": "Min price (€)", "minimum": 0, "type": "integer", "description": "Minimum price or cold rent in euros. Applies to Locations only." }, "maxPrice": { "title": "Max price (€)", "minimum": 0, "type": "integer", "description": "Maximum price or cold rent in euros. Applies to Locations only." }, "minRooms": { "title": "Min rooms", "minimum": 0, "type": "number", "description": "Minimum number of rooms. Applies to Locations only." }, "maxRooms": { "title": "Max rooms", "minimum": 0, "type": "number", "description": "Maximum number of rooms. Applies to Locations only." }, "minLivingSpace": { "title": "Min living space (m²)", "minimum": 0, "type": "integer", "description": "Minimum living / floor space in square metres. Applies to Locations only." }, "maxLivingSpace": { "title": "Max living space (m²)", "minimum": 0, "type": "integer", "description": "Maximum living / floor space in square metres. Applies to Locations only." }, "minPlotArea": { "title": "Min plot area (m²)", "minimum": 0, "type": "integer", "description": "Minimum plot size in square metres (houses and plots). Applies to Locations only." }, "maxPlotArea": { "title": "Max plot area (m²)", "minimum": 0, "type": "integer", "description": "Maximum plot size in square metres (houses and plots). Applies to Locations only." }, "minConstructionYear": { "title": "Built from year", "minimum": 1000, "type": "integer", "description": "Only listings built in or after this year. Applies to Locations only." }, "maxConstructionYear": { "title": "Built until year", "minimum": 1000, "type": "integer", "description": "Only listings built in or before this year. Applies to Locations only." }, "equipment": { "title": "Must have", "type": "array", "description": "Only listings that have all of these. Applies to Locations only.", "items": { "type": "string", "enum": [ "balcony", "builtinkitchen", "garden", "lift", "cellar", "guesttoilet", "parking", "handicappedaccessible" ], "enumTitles": [ "Balcony / terrace", "Fitted kitchen", "Garden", "Elevator", "Cellar", "Guest toilet", "Garage / parking", "Step-free" ] } }, "energyEfficiencyClasses": { "title": "Energy efficiency classes", "type": "array", "description": "Only listings with one of these energy classes. Applies to Locations only.", "items": { "type": "string", "enum": [ "a_plus", "a", "b", "c", "d", "e", "f", "g", "h" ], "enumTitles": [ "A+", "A", "B", "C", "D", "E", "F", "G", "H" ] } }, "newBuildOnly": { "title": "New builds only", "type": "boolean", "description": "Only new-build listings. Applies to Locations only.", "default": false }, "excludeSwapFlats": { "title": "Exclude swap flats", "type": "boolean", "description": "Hide flat-swap (Tauschwohnung) offers. Applies to Locations only.", "default": false }, "sorting": { "title": "Sort by", "enum": [ "standard", "-firstactivation", "price", "-price", "livingspace", "-livingspace" ], "type": "string", "description": "Order of results. With a limit, 'Newest first' returns the freshest listings. Applies to Locations only; search URLs keep their own sorting.", "default": "standard" }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many listings are fetched in parallel.", "default": 20 }, "maxRetries": { "title": "Max retries", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many times a failed request is retried before the listing is skipped.", "default": 6 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy servers used for the requests. Residential proxies in Germany are used by default.", "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 } } } } } } } } } }