{ "openapi": "3.0.1", "info": { "title": "Homegate Scraper (beta)", "description": "Scrape real estate listings from Homegate.ch — Switzerland's largest property marketplace. Extract rentals & purchases with filters for location, price, rooms. Clean JSON output with prices, addresses, coordinates, images. Pagination & anti-detection built in.", "version": "1.0", "x-build-id": "3cwMlOVCBqXqMSbVQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/covassoftware~homegate-scraper-beta/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-covassoftware-homegate-scraper-beta", "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/covassoftware~homegate-scraper-beta/runs": { "post": { "operationId": "runs-sync-covassoftware-homegate-scraper-beta", "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/covassoftware~homegate-scraper-beta/run-sync": { "post": { "operationId": "run-sync-covassoftware-homegate-scraper-beta", "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", "required": [ "offerType" ], "properties": { "mode": { "title": "Scraping Mode", "enum": [ "search", "details", "full" ], "type": "string", "description": "search = list results only (fast, less data). details = full data from specific URLs. full = search + auto-fetch complete details for each listing.", "default": "search" }, "offerType": { "title": "Offer Type", "enum": [ "rent", "buy" ], "type": "string", "description": "Whether to scrape rental or purchase listings.", "default": "rent" }, "locations": { "title": "Locations", "type": "array", "description": "City names, cantons, ZIP codes, or regions to search. Examples: 'zurich', 'canton-bern', '8001', 'region-bern-mittelland'.", "items": { "type": "string" }, "default": [ "zurich" ] }, "urls": { "title": "Direct URLs", "type": "array", "description": "Specific Homegate listing or search page URLs. Use this instead of locations for precise control.", "items": { "type": "string" } }, "propertyType": { "title": "Property Type", "enum": [ "all", "apartment", "house" ], "type": "string", "description": "Filter by property category.", "default": "all" }, "priceMin": { "title": "Min Price (CHF)", "minimum": 0, "type": "integer", "description": "Minimum price in CHF. For rent = monthly rent, for buy = purchase price." }, "priceMax": { "title": "Max Price (CHF)", "minimum": 0, "type": "integer", "description": "Maximum price in CHF." }, "roomsMin": { "title": "Min Rooms", "minimum": 1, "type": "number", "description": "Minimum number of rooms. Swiss convention supports .5 increments (e.g., 2.5 = 2 rooms + kitchen)." }, "roomsMax": { "title": "Max Rooms", "minimum": 1, "type": "number", "description": "Maximum number of rooms." }, "livingSpaceMin": { "title": "Min Living Space (m²)", "minimum": 0, "type": "integer", "description": "Minimum living space in square meters." }, "livingSpaceMax": { "title": "Max Living Space (m²)", "minimum": 0, "type": "integer", "description": "Maximum living space in square meters." }, "maxPages": { "title": "Max Pages", "minimum": 0, "type": "integer", "description": "Maximum number of search result pages to scrape. 0 = scrape all available pages.", "default": 1 }, "maxItems": { "title": "Max Items", "minimum": 0, "type": "integer", "description": "Maximum total listings to return. 0 = unlimited.", "default": 10 }, "language": { "title": "Output Language", "enum": [ "de", "en", "fr", "it" ], "type": "string", "description": "Language for title and description fields. Most listings are originally in German; other languages may be machine-translated.", "default": "de" }, "sortBy": { "title": "Sort Order", "enum": [ "dateCreated-desc", "dateCreated-asc", "resultingSearchablePrice-asc", "resultingSearchablePrice-desc" ], "type": "string", "description": "How to sort search results. Only affects search mode.", "default": "dateCreated-desc" }, "proxy": { "title": "Proxy Configuration", "type": "object", "description": "Swiss residential proxies are strongly recommended for reliable scraping. Datacenter proxies will likely be blocked by Cloudflare.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "CH" } }, "maxRetries": { "title": "Max Retries", "minimum": 0, "maximum": 10, "type": "integer", "description": "Maximum retry attempts per failed request.", "default": 3 }, "requestDelay": { "title": "Request Delay (ms)", "minimum": 500, "type": "integer", "description": "Minimum delay between requests in milliseconds. Lower values = faster but higher block risk.", "default": 1000 } } }, "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 } } } } } } } } } }