{ "openapi": "3.0.1", "info": { "title": "Homegate & ImmoScout24.ch Scraper – Swiss Real Estate", "description": "Scrape Swiss property listings from Homegate.ch, ImmoScout24.ch and Flatfox: rent & buy, CHF prices, rooms, m², address, GPS, features, agency, photos. Deduplicated across portals.", "version": "1.1", "x-build-id": "SIFwmPKAfKj8Nf9ML" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ninhothedev~swiss-real-estate-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ninhothedev-swiss-real-estate-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/ninhothedev~swiss-real-estate-scraper/runs": { "post": { "operationId": "runs-sync-ninhothedev-swiss-real-estate-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/ninhothedev~swiss-real-estate-scraper/run-sync": { "post": { "operationId": "run-sync-ninhothedev-swiss-real-estate-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": "Swiss cities, ZIP codes (PLZ/NPA), cantons (name or code like ZH, GE) or geo ids. Examples: Zürich, 8004, Lausanne, Kanton Zug, ZH. Each location is searched separately.", "default": [ "Zürich" ], "items": { "type": "string" } }, "offerType": { "title": "Rent or buy", "enum": [ "rent", "buy" ], "type": "string", "description": "Rental or sale listings.", "default": "rent" }, "propertyType": { "title": "Property type", "enum": [ "all", "apartment", "house", "multi_family_house", "parking", "commercial", "plot" ], "type": "string", "description": "Select a property category. All uses the broad Homegate/ImmoScout24 real-estate category (which can include commercial listings), but apartments and houses on Flatfox. Choose an explicit category for comparable coverage.", "default": "all" }, "portals": { "title": "Portals", "type": "array", "description": "Which portals to search. Homegate and ImmoScout24.ch share listing IDs, so duplicates are removed exactly. ImmoScout24.ch shares most listings with Homegate (same backend) and is often bot-protected; Homegate results include the ImmoScout24.ch link where available.", "items": { "type": "string", "enum": [ "homegate", "immoscout24", "flatfox" ], "enumTitles": [ "Homegate.ch", "ImmoScout24.ch", "Flatfox.ch" ] }, "default": [ "homegate", "flatfox" ] }, "maxItems": { "title": "Max listings", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Global maximum across all locations and portals, including saved rows on restart. An earlier portal can fill this limit before later portals are queried. The remaining paid-result allowance can stop the run sooner.", "default": 20 }, "priceMin": { "title": "Min price (CHF)", "minimum": 0, "type": "integer", "description": "Monthly rent or purchase price." }, "priceMax": { "title": "Max price (CHF)", "minimum": 0, "type": "integer", "description": "Monthly rent or purchase price." }, "roomsMin": { "title": "Min rooms", "minimum": 0, "type": "number", "description": "Swiss room count, e.g. 2.5" }, "roomsMax": { "title": "Max rooms", "minimum": 0, "type": "number", "description": "Swiss room count, e.g. 4.5" }, "areaMin": { "title": "Min area (m²)", "minimum": 0, "type": "integer", "description": "Living area (lot area for plots, usable area for commercial)." }, "areaMax": { "title": "Max area (m²)", "minimum": 0, "type": "integer", "description": "Living area (lot area for plots, usable area for commercial)." }, "sortBy": { "title": "Sort", "enum": [ "newest", "price_asc", "price_desc", "default" ], "type": "string", "description": "Ordering within each source stream; results are not globally sorted across portals or locations. Fresh scheduled runs can contain previously seen listings.", "default": "newest" }, "searchUrls": { "title": "Search or listing URLs", "type": "array", "description": "Optional. Paste search result URLs from homegate.ch or immoscout24.ch (all filters kept) or single listing URLs (homegate.ch/rent/123..., immoscout24.ch/mieten/123..., flatfox.ch/...). Used in addition to locations.", "items": { "type": "string" } }, "includeDetails": { "title": "Include detail page data", "type": "boolean", "description": "Request additional Homegate/ImmoScout24 detail fields when available. Slower; after two initial failed detail probes without a success, keep search data and skip further details. Inspect RUN_SUMMARY for errors and enrichment coverage.", "default": false }, "dedupeAcrossPortals": { "title": "Deduplicate across portals", "type": "boolean", "description": "Merge matching shared SMG listing IDs across Homegate and ImmoScout24. Flatfox matches only when it supplies an smg_id. Different IDs for the same property are not automatically merged.", "default": true }, "descriptionLanguage": { "title": "Description language", "enum": [ "auto", "de", "fr", "it", "en" ], "type": "string", "description": "Preferred language for title/description if the listing provides it.", "default": "auto" }, "maxPagesPerSearch": { "title": "Max pages per search", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum Homegate/ImmoScout24 search pages, capped at 50. Flatfox instead considers at most 400 candidates per category before filtering. Split broad searches into smaller areas; full inventory coverage is not guaranteed.", "default": 50 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Swiss residential proxies are recommended (portals use DataDome bot protection).", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "CH" } } } }, "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 } } } } } } } } } }