{ "openapi": "3.0.1", "info": { "title": "Immowelt Property Scraper", "description": "The Immowelt Scraper helps you extract unlimited real estate listings from Immowelt with complete details including price, address, property type, size, amenities, images, and listing metadata. Perfect for market research, investment analysis, and real estate automation workflows.", "version": "0.0", "x-build-id": "dMOKWW7FdgbFJ3xKC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rigelbytes~immowelt-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rigelbytes-immowelt-property-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/rigelbytes~immowelt-property-scraper/runs": { "post": { "operationId": "runs-sync-rigelbytes-immowelt-property-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/rigelbytes~immowelt-property-scraper/run-sync": { "post": { "operationId": "run-sync-rigelbytes-immowelt-property-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", "required": [ "location" ], "properties": { "location": { "title": "Location", "type": "string", "description": "Location to search properties (Berlin, Frankfurt, etc.)", "default": "Berlin" }, "pages": { "title": "Pages to Scrape", "type": "integer", "description": "Number of pages to scrape, one page contains 60 listings", "default": 1 }, "priceMin": { "title": "Minimum Price (€)", "minimum": 0, "type": "integer", "description": "Minimum price in euros" }, "priceMax": { "title": "Maximum Price (€)", "minimum": 0, "type": "integer", "description": "Maximum price in euros" }, "numberOfRoomsMin": { "title": "Minimum Number of Rooms", "minimum": 0, "type": "number", "description": "Minimum number of rooms" }, "numberOfRoomsMax": { "title": "Maximum Number of Rooms", "minimum": 0, "type": "number", "description": "Maximum number of rooms" }, "spaceMin": { "title": "Minimum Living Space (m²)", "minimum": 0, "type": "integer", "description": "Minimum living space in square meters" }, "spaceMax": { "title": "Maximum Living Space (m²)", "minimum": 0, "type": "integer", "description": "Maximum living space in square meters" }, "plotSpaceMin": { "title": "Minimum Plot Space (m²)", "minimum": 0, "type": "integer", "description": "Minimum plot space in square meters" }, "plotSpaceMax": { "title": "Maximum Plot Space (m²)", "minimum": 0, "type": "integer", "description": "Maximum plot space in square meters" }, "yearOfConstructionMin": { "title": "Minimum Year of Construction", "minimum": 1800, "maximum": 2100, "type": "integer", "description": "Minimum year of construction" }, "yearOfConstructionMax": { "title": "Maximum Year of Construction", "minimum": 1800, "maximum": 2100, "type": "integer", "description": "Maximum year of construction" }, "distributionTypes": { "title": "Distribution Types", "type": "array", "description": "Select distribution types (buy, rent, auction)", "items": { "type": "string", "enum": [ "Buy", "Buy_Auction", "Compulsory_Auction", "Rent" ], "enumTitles": [ "Buy", "Buy Auction", "Compulsory Auction", "Rent" ] } }, "projectTypes": { "title": "Project Types", "uniqueItems": true, "type": "array", "description": "Select project types", "items": { "type": "string", "enum": [ "Resale", "Investment", "New_Build", "Projected", "Swap_Apartment", "Flatsharing", "Stock", "Short_Time_Rental" ], "enumTitles": [ "Existing Properties", "Investment", "New Construction", "Model/Fabricated Houses", "Swap Apartment", "Flatsharing", "Stock", "Short Time Rental" ] } }, "estateTypes": { "title": "Estate Types", "uniqueItems": true, "type": "array", "description": "Select real estate types", "items": { "type": "string", "enum": [ "House", "Apartment", "Senior", "Building", "Plot", "Parking", "Miscellaneous", "Office", "Trading", "Gastronomy_Hotel", "Storage_Production", "Agriculture_Forestry" ], "enumTitles": [ "House", "Apartment", "Senior", "Apartment Building", "Plot", "Parking", "Miscellaneous", "Office", "Trading", "Gastronomy/Hotel", "Storage/Production", "Agriculture/Forestry" ] } }, "estateSubTypes": { "title": "Estate Sub Types", "uniqueItems": true, "type": "array", "description": "Select real estate sub types", "items": { "type": "string", "enum": [ "Farmhouse", "Bungalow", "Semidetached_House", "Single_Family_House", "Finca", "Manor_House", "Multi_Family_House", "Terrace_House", "Corner_Terrace_House", "Mid_Terrace_House", "End_Terrace_House", "Rustico", "Castle", "Town_House", "Villa", "Loft", "Loft_Atelier", "Multi_Storey", "Penthouse", "Studio", "Terrace", "Outside", "Street_Parking", "Parking_Area", "Carport", "Duplex", "Garage", "Double_Garage", "Garage_Area", "Underground_Garage", "Underground_Parking_Space", "Farm_Ranch", "Forestry", "Gardening", "Orchard", "Hunting", "Fishing", "Agriculture_Company", "Riding", "Winery", "Outdoor_Space", "Production_Hall", "Warehouse_Hall", "Logistics_Center", "Garage_Repair", "Showroom_Space", "Shopping_Centre", "Kiosk", "Store", "Sales_Area", "Atelier", "Single_Office", "Office_Space", "Office_Building", "Office_Centre", "Office_Storage_Building", "Coworking", "Shared_Office", "Open_Space", "Medical", "Medical_Floor", "Medical_Building", "Cafe_Bar_Pub", "Club_Discotheque", "Hotel", "Apart_Hotel", "Restaurant" ], "enumTitles": [ "Farmhouse", "Bungalow", "Semidetached House", "Single Family House", "Finca", "Manor House", "Multi Family House", "Terrace House", "Corner Terrace House", "Mid Terrace House", "End Terrace House", "Rustico", "Castle", "Town House", "Villa", "Loft", "Loft Atelier", "Multi Storey", "Penthouse", "Studio", "Terrace", "Outside", "Street Parking", "Parking Area", "Carport", "Duplex", "Garage", "Double Garage", "Garage Area", "Underground Garage", "Underground Parking Space", "Farm/Ranch", "Forestry", "Gardening", "Orchard", "Hunting", "Fishing", "Agriculture Company", "Riding", "Winery", "Outdoor Space", "Production Hall", "Warehouse Hall", "Logistics Center", "Garage/Repair", "Showroom Space", "Shopping Centre", "Kiosk", "Store", "Sales Area", "Atelier", "Single Office", "Office Space", "Office Building", "Office Centre", "Office Storage Building", "Coworking", "Shared Office", "Open Space", "Medical", "Medical Floor", "Medical Building", "Cafe/Bar/Pub", "Club/Discotheque", "Hotel", "Apart Hotel", "Restaurant" ] } }, "featuresIncluded": { "title": "Features Included", "uniqueItems": true, "type": "array", "description": "Select features to include", "items": { "type": "string", "enum": [ "Parking_Garage", "Balcony_Terrace", "Garden", "Swimming_Pool", "Bathroom_Window", "Bathtub", "Cellar", "Kitchen_Fully_Equipped", "Vacant", "Commission_Free", "Assisted_Living", "Reduce_Mobility_Access", "Elevator" ], "enumTitles": [ "Parking/Garage", "Balcony/Terrace", "Garden", "Swimming Pool", "Bathroom with Window", "Bathtub", "Cellar", "Kitchen Fully Equipped", "Vacant", "Commission Free", "Assisted Living", "Accessible", "Elevator" ] } }, "energyCertificateClasses": { "title": "Energy Certificate Classes", "uniqueItems": true, "type": "array", "description": "Select energy certificate classes", "items": { "type": "string", "enum": [ "A_PLUS", "A", "B", "C", "D", "E", "F", "G", "H" ], "enumTitles": [ "A+", "A", "B", "C", "D", "E", "F", "G", "H" ] } }, "energyTypes": { "title": "Energy Types", "uniqueItems": true, "type": "array", "description": "Select energy types", "items": { "type": "string", "enum": [ "HEAT_PUMP", "SOLAR_HEAT", "SOLAR_POWER", "CENTRAL", "UNDERFLOOR" ], "enumTitles": [ "Heat Pump", "Solar Heat", "Solar Power", "Central", "Underfloor" ] } }, "furnished": { "title": "Furnished", "uniqueItems": true, "type": "array", "description": "Select furnishing status", "items": { "type": "string", "enum": [ "No", "Full" ], "enumTitles": [ "Not Furnished", "Fully Furnished" ] } }, "buildState": { "title": "Build State", "uniqueItems": true, "type": "array", "description": "Select build state", "items": { "type": "string", "enum": [ "Need_Of_Renovation" ], "enumTitles": [ "Needs Renovation" ] } }, "availableFromMax": { "title": "Available From (Max Date)", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "Maximum availability date (ISO format: YYYY-MM-DD)" }, "classifiedBusiness": { "title": "Classified Business", "enum": [ "Private", "Professional" ], "type": "string", "description": "Type of classified listing" }, "certificateOfEligibilityNeeded": { "title": "Certificate of Eligibility Needed", "enum": [ "Yes", "No" ], "type": "string", "description": "Whether certificate of eligibility is needed" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Select proxy groups or use your custom proxies", "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 } } } } } } } } } }