{ "openapi": "3.0.1", "info": { "title": "Germany Property Tracker: Immowelt, Kleinanzeigen", "description": "Scrape German property listings from Immowelt, Kleinanzeigen and ImmoScout24 (beta) in one run. Merges the same home across portals and tracks new listings, price drops, price rises, removed listings and days on market.", "version": "0.1", "x-build-id": "onGHzYCqNmomULUZ2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apizilla~germany-property-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apizilla-germany-property-tracker", "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/apizilla~germany-property-tracker/runs": { "post": { "operationId": "runs-sync-apizilla-germany-property-tracker", "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/apizilla~germany-property-tracker/run-sync": { "post": { "operationId": "run-sync-apizilla-germany-property-tracker", "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": [ "searches" ], "properties": { "searches": { "title": "Searches", "type": "array", "description": "One entry per search. Use a search URL from a supported portal, for example {\"url\": \"https://www.kleinanzeigen.de/s-wohnung-mieten/berlin/c203l3331\"}. Or describe the search and we build the URL for every portal: {\"location\": \"Berlin\", \"operation\": \"rent\", \"propertyType\": \"apartment\", \"minPrice\": 500, \"maxPrice\": 1500, \"minRooms\": 2, \"minSize\": 50}. operation is \"rent\" or \"sale\". propertyType is \"apartment\" or \"house\". Prices are in EUR. For rent, price means Kaltmiete (cold rent)." }, "portals": { "title": "Portals", "type": "array", "description": "Which portals to scrape. ImmoScout24 is in beta: it has strong bot protection and needs a RESIDENTIAL proxy. Default: Immowelt and Kleinanzeigen.", "items": { "type": "string", "enum": [ "immowelt", "kleinanzeigen", "immoscout24" ], "enumTitles": [ "Immowelt", "Kleinanzeigen (real estate)", "ImmoScout24 (beta, needs residential proxy)" ] }, "default": [ "immowelt", "kleinanzeigen" ] }, "maxListingsPerPortal": { "title": "Max listings per portal", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many listings from each portal (all searches together). Lower is cheaper and faster.", "default": 200 }, "includeDetails": { "title": "Include details", "type": "boolean", "description": "Open every listing page to get the full description, Nebenkosten, Heizkosten, Kaution, Baujahr, coordinates and all features. Slower and costs one extra event per listing. Off means list page data only.", "default": false }, "browserForBeta": { "title": "Use a real browser for the beta portal", "type": "boolean", "description": "ImmoScout24 (beta) blocks plain requests. When this is on, the Actor opens ImmoScout24 in a real browser (Firefox) with a residential proxy, like a normal visitor. It is slower and costs more. It does not solve captchas: if ImmoScout24 asks for one, ImmoScout24 is skipped. Other portals always use fast plain requests.", "default": true }, "monitor": { "title": "Monitor changes", "type": "boolean", "description": "Compare with the previous run and mark each listing as new, price_drop, price_rise, back or unchanged. Listings that disappeared are added as removed. Use with a schedule (for example every day).", "default": false }, "monitorId": { "title": "Monitor ID", "type": "string", "description": "Name of the saved state for monitoring. Runs with the same ID are compared with each other. Letters, numbers and dashes only. Leave empty to build it from your searches." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy is recommended. If you do not pick a proxy group, all portals use RESIDENTIAL proxies in Germany. Datacenter proxies get blocked by these portals.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }