{"openapi":"3.1.0","info":{"title":"syte-backend","description":"\n### Overview\n\nThe **syte Platform** offers developers access to powerful AI-driven real estate data and analytics through its REST API, enabling the creation of applications for analyzing building potential, energy efficiency, and property value.\n\n### Coverage\n\nWith comprehensive data for **62 million properties** and **55 million buildings**, syte provides **99% coverage of Germany**.\n\n### Capabilities\n\nDevelopers can leverage syte's AI models to:\n- Predict building potential\n- Calculate photovoltaic yield\n- Forecast energy demand\n- Generate renovation plans\n\n### Use Cases\n\nThis award-winning technology is scalable and fast, supporting use cases such as:\n- Lead generation\n- Urban planning\n- Property valuation\n- Energy consulting\n    ","version":"4.1.0"},"paths":{"/api/cadastral/buildings":{"get":{"tags":["Cadastral","Partner API"],"summary":"Get Buildings as GeoJSON","description":"Query buildings in a given bounding box. Returns a GeoJSON feature collection. Some metrics are concealed depending on your authentication and results out of the subscription areas are excluded.","operationId":"get_buildings_as_geojson_api_cadastral_buildings_get","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"top","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Top bound latitude coordinate in EPSG 4326","title":"Top"},"description":"Top bound latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.991191}}},{"name":"left","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Left bound longitude coordinate in EPSG 4326","title":"Left"},"description":"Left bound longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.591723}}},{"name":"bottom","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Bottom bound latitude coordinate in EPSG 4326","title":"Bottom"},"description":"Bottom bound latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.990776}}},{"name":"right","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Right bound longitude coordinate in EPSG 4326","title":"Right"},"description":"Right bound longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.592227}}},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":90,"minimum":-90},{"type":"null"}],"description":"Center latitude coordinate in EPSG 4326","title":"Lat"},"description":"Center latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.9909653}}},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":180,"minimum":-180},{"type":"null"}],"description":"Center longitude coordinate in EPSG 4326","title":"Lng"},"description":"Center longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.5918667}}},{"name":"autoshrink","in":"query","required":false,"schema":{"type":"boolean","description":"If set the bounding box will be shrunk silently if too large. Otherwise a `bounding-box-too-large` error is responded.","default":false,"title":"Autoshrink"},"description":"If set the bounding box will be shrunk silently if too large. Otherwise a `bounding-box-too-large` error is responded."},{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","description":"If set a download will be started for the requested resource","default":false,"title":"Download"},"description":"If set a download will be started for the requested resource","examples":{"True":{"value":true}}},{"name":"format","in":"query","required":false,"schema":{"enum":["geojson","dxf"],"type":"string","description":"The format of the download","default":"geojson","title":"Format"},"description":"The format of the download","examples":{"geojson":{"value":"geojson"},"dxf":{"value":"dxf"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcealedBuildingCollection"}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/cadastral/property-buildings":{"get":{"tags":["Cadastral","Partner API"],"summary":"Get Buildings belonging to a property as GeoJSON","description":"Query buildings in a given property. Returns a GeoJSON feature collection if format is geojson, geometries only for other formats. Some metrics are concealed depending of your authentication and results out of the subscription areas are excluded.","operationId":"get_buildings_for_property_api_cadastral_property_buildings_get","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"parcel_identifier","in":"query","required":true,"schema":{"type":"string","description":"Parcel identifier, property identifier or custom property identifier","title":"Parcel Identifier"},"description":"Parcel identifier, property identifier or custom property identifier","examples":{"Münster Fernholzstraße 33":{"value":"DENW49AL00009b0v"},"Berlin Dennewitzstraße 2":{"value":"DEBE01YYK0002NvW"},"München Isartalstraße 30":{"value":"DEBYvAAAAABTeGhf"},"Frankfurt Stralsunder Straße 10":{"value":"DEHE06200001eAaR"},"Hamburg Rothenbaumchaussee 199":{"value":"DEHHALKAV0000wN6"},"Kiel Lutherstraße 9":{"value":"DESHPDHK0001ub9p"},"Bad Sulza Gartenstraße 7":{"value":"DETHL51P00000i8T"},"Werdau Weißenbrunn 3a":{"value":"DESNALK0f0009giL"},"Custom Property":{"value":"CUSTOM-KLUv_SA9_QAAkAADAA0Ls2FXJbfjZH6l_zKOjwUAYCMoDGzhsmmBKw=="}}},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":90,"minimum":-90},{"type":"null"}],"description":"Parcel latitude coordinate in EPSG 4326","title":"Lat"},"description":"Parcel latitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":51.9909653},"Berlin Dennewitzstraße 2":{"value":52.4996479},"München Isartalstraße 30":{"value":48.1206001},"Frankfurt Stralsunder Straße 10":{"value":50.1294342},"Hamburg Rothenbaumchaussee 199":{"value":53.5784523},"Kiel Lutherstraße 9":{"value":54.3151818},"Bad Sulza Gartenstraße 7":{"value":51.0860736},"Werdau Weißenbrunn 3a":{"value":50.7053124}}},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":180,"minimum":-180},{"type":"null"}],"description":"Parcel longitude coordinate in EPSG 4326","title":"Lng"},"description":"Parcel longitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":7.5918667},"Berlin Dennewitzstraße 2":{"value":13.3698984},"München Isartalstraße 30":{"value":11.5606595},"Frankfurt Stralsunder Straße 10":{"value":8.6702905},"Hamburg Rothenbaumchaussee 199":{"value":9.9883648},"Kiel Lutherstraße 9":{"value":10.1169388},"Bad Sulza Gartenstraße 7":{"value":11.6291221},"Werdau Weißenbrunn 3a":{"value":12.4199148}}},{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","description":"If set a download will be started for the requested resource","default":false,"title":"Download"},"description":"If set a download will be started for the requested resource","examples":{"True":{"value":true}}},{"name":"format","in":"query","required":false,"schema":{"enum":["geojson","dxf"],"type":"string","description":"The format of the download","default":"geojson","title":"Format"},"description":"The format of the download","examples":{"geojson":{"value":"geojson"},"dxf":{"value":"dxf"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcealedBuildingCollection"}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/cadastral/building/{building_identifier}":{"get":{"tags":["Cadastral","Partner API"],"summary":"Get a Building as GeoJSON","description":"Get details for a single building based on the identifier. Some metrics are concealed depending on your authentication and results out of the subscription areas are not allowed.","operationId":"get_building_by_identifier_as_geojson_api_cadastral_building__building_identifier__get","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"building_identifier","in":"path","required":true,"schema":{"type":"string","description":"Building Identifier","title":"Building Identifier"},"description":"Building Identifier","examples":{"Münster Fernholzstraße 33":{"value":"DENW49AL00009XTV"},"Berlin Dennewitzstraße 2":{"value":"DEBE01YYK0002Q3o"},"München Isartalstraße 30":{"value":"DEBYvAAAAABTeGiB"},"Frankfurt Stralsunder Straße 10":{"value":"DEHE06200001eBUl"},"Hamburg Rothenbaumchaussee 199":{"value":"DEHHALKAV0000yuD"},"Kiel Lutherstraße 9":{"value":"DESHPDHK0001ujRg"},"Bad Sulza Gartenstraße 7":{"value":"DETHL51P00000zjQ"},"Werdau Weißenbrunn 3a":{"value":"DESNALK0f000B70D"}}},{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","description":"If set a download will be started for the requested resource","default":false,"title":"Download"},"description":"If set a download will be started for the requested resource","examples":{"True":{"value":true}}},{"name":"format","in":"query","required":false,"schema":{"enum":["geojson","dxf"],"type":"string","description":"The format of the download","default":"geojson","title":"Format"},"description":"The format of the download","examples":{"geojson":{"value":"geojson"},"dxf":{"value":"dxf"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcealedBuilding"}}}},"403":{"description":"You are not allowed to access this resource.","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/cadastral/building-at":{"get":{"tags":["Cadastral","Partner API"],"summary":"Get a Building as GeoJSON by Lat/Lng","description":"Get details for a single building based on the coordinates. Some metrics are concealed depending on your authentication and results out of the subscription areas are not allowed.","operationId":"get_building_at_coordinate_as_geojson_api_cadastral_building_at_get","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"lat","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Parcel latitude coordinate in EPSG 4326","title":"Lat"},"description":"Parcel latitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":51.9909653},"Berlin Dennewitzstraße 2":{"value":52.4996479},"München Isartalstraße 30":{"value":48.1206001},"Frankfurt Stralsunder Straße 10":{"value":50.1294342},"Hamburg Rothenbaumchaussee 199":{"value":53.5784523},"Kiel Lutherstraße 9":{"value":54.3151818},"Bad Sulza Gartenstraße 7":{"value":51.0860736},"Werdau Weißenbrunn 3a":{"value":50.7053124}}},{"name":"lng","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Parcel longitude coordinate in EPSG 4326","title":"Lng"},"description":"Parcel longitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":7.5918667},"Berlin Dennewitzstraße 2":{"value":13.3698984},"München Isartalstraße 30":{"value":11.5606595},"Frankfurt Stralsunder Straße 10":{"value":8.6702905},"Hamburg Rothenbaumchaussee 199":{"value":9.9883648},"Kiel Lutherstraße 9":{"value":10.1169388},"Bad Sulza Gartenstraße 7":{"value":11.6291221},"Werdau Weißenbrunn 3a":{"value":12.4199148}}},{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","description":"If set a download will be started for the requested resource","default":false,"title":"Download"},"description":"If set a download will be started for the requested resource","examples":{"True":{"value":true}}},{"name":"format","in":"query","required":false,"schema":{"enum":["geojson","dxf"],"type":"string","description":"The format of the download","default":"geojson","title":"Format"},"description":"The format of the download","examples":{"geojson":{"value":"geojson"},"dxf":{"value":"dxf"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcealedBuilding"}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed, e.g. the provided download token is invalid or expired.","content":{"application/json":{"example":{"detail":"Invalid download token"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/cadastral/building-near-by":{"get":{"tags":["Cadastral","Partner API"],"summary":"Get a Building as GeoJSON near Lat/Lng","description":"Get details for a single building within a specific radius of a coordinate. Some metrics are concealed depending on your authentication and authorization state.","operationId":"get_building_nearby_as_geojson_api_cadastral_building_near_by_get","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"radius","in":"query","required":false,"schema":{"type":"integer","maximum":300,"minimum":0,"description":"Radius tolerance in meters to find entities within.","default":30,"title":"Radius"},"description":"Radius tolerance in meters to find entities within."},{"name":"primary_only","in":"query","required":false,"schema":{"type":"boolean","description":"If True, only primary buildings will be returned.","default":false,"title":"Primary Only"},"description":"If True, only primary buildings will be returned."},{"name":"lat","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Parcel latitude coordinate in EPSG 4326","title":"Lat"},"description":"Parcel latitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":51.9909653},"Berlin Dennewitzstraße 2":{"value":52.4996479},"München Isartalstraße 30":{"value":48.1206001},"Frankfurt Stralsunder Straße 10":{"value":50.1294342},"Hamburg Rothenbaumchaussee 199":{"value":53.5784523},"Kiel Lutherstraße 9":{"value":54.3151818},"Bad Sulza Gartenstraße 7":{"value":51.0860736},"Werdau Weißenbrunn 3a":{"value":50.7053124}}},{"name":"lng","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Parcel longitude coordinate in EPSG 4326","title":"Lng"},"description":"Parcel longitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":7.5918667},"Berlin Dennewitzstraße 2":{"value":13.3698984},"München Isartalstraße 30":{"value":11.5606595},"Frankfurt Stralsunder Straße 10":{"value":8.6702905},"Hamburg Rothenbaumchaussee 199":{"value":9.9883648},"Kiel Lutherstraße 9":{"value":10.1169388},"Bad Sulza Gartenstraße 7":{"value":11.6291221},"Werdau Weißenbrunn 3a":{"value":12.4199148}}},{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","description":"If set a download will be started for the requested resource","default":false,"title":"Download"},"description":"If set a download will be started for the requested resource","examples":{"True":{"value":true}}},{"name":"format","in":"query","required":false,"schema":{"enum":["geojson","dxf"],"type":"string","description":"The format of the download","default":"geojson","title":"Format"},"description":"The format of the download","examples":{"geojson":{"value":"geojson"},"dxf":{"value":"dxf"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcealedBuilding"}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed, e.g. the provided download token is invalid or expired.","content":{"application/json":{"example":{"detail":"Invalid download token"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/3d/building-surfaces/{building_identifier}":{"get":{"tags":["3D Building Models","Partner API"],"summary":"Get Building Surfaces As Geojson","description":"Get the surfaces of a buildings, including their geometry and orientation.","operationId":"get_building_surfaces_as_geojson_api_3d_building_surfaces__building_identifier__get","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"building_identifier","in":"path","required":true,"schema":{"type":"string","description":"Building identifier","title":"Building Identifier"},"description":"Building identifier","examples":{"Münster Fernholzstraße 33":{"value":"DENW49AL00009XTV"},"Berlin Dennewitzstraße 2":{"value":"DEBE01YYK0002Q3o"},"München Isartalstraße 30":{"value":"DEBYvAAAAABTeGiB"},"Frankfurt Stralsunder Straße 10":{"value":"DEHE06200001eBUl"},"Hamburg Rothenbaumchaussee 199":{"value":"DEHHALKAV0000yuD"},"Kiel Lutherstraße 9":{"value":"DESHPDHK0001ujRg"},"Bad Sulza Gartenstraße 7":{"value":"DETHL51P00000zjQ"},"Werdau Weißenbrunn 3a":{"value":"DESNALK0f000B70D"}}},{"name":"surface_type","in":"query","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/SurfaceTypeStr"},"description":"Surface types to return. Can be repeated.","title":"Surface Type"},"description":"Surface types to return. Can be repeated."},{"name":"crs","in":"query","required":false,"schema":{"$ref":"#/components/schemas/CRSOption","description":"Coordinate reference system to use for the geometries in the response. Defaults to EPSG:4326 (or rather urn:ogc:def:crs:OGC::CRS84)","default":4326},"description":"Coordinate reference system to use for the geometries in the response. Defaults to EPSG:4326 (or rather urn:ogc:def:crs:OGC::CRS84)"},{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildingSurfaceResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/3d/gltf/{building_id}":{"get":{"tags":["3D Building Models","Partner API"],"summary":"Get Gltf","description":"Get the glTF file","operationId":"get_gltf_api_3d_gltf__building_id__get","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"building_id","in":"path","required":true,"schema":{"type":"string","description":"Building identifier","title":"Building Id"},"description":"Building identifier","examples":{"Münster Fernholzstraße 33":{"value":"DENW49AL00009XTV"},"Berlin Dennewitzstraße 2":{"value":"DEBE01YYK0002Q3o"},"München Isartalstraße 30":{"value":"DEBYvAAAAABTeGiB"},"Frankfurt Stralsunder Straße 10":{"value":"DEHE06200001eBUl"},"Hamburg Rothenbaumchaussee 199":{"value":"DEHHALKAV0000yuD"},"Kiel Lutherstraße 9":{"value":"DESHPDHK0001ujRg"},"Bad Sulza Gartenstraße 7":{"value":"DETHL51P00000zjQ"},"Werdau Weißenbrunn 3a":{"value":"DESNALK0f000B70D"}}},{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/3d/lidar/{property_identifier}":{"get":{"tags":["3D Building Models","Partner API"],"summary":"Get Lidar For Property","description":"Get a 3D LiDAR point cloud for a parcel. Properties virtually bundle multiple parcels into one property if their buildings overlap. The response will contain all LiDAR points over the property as a list of items in the form: [X, Y, Z, Level, NormalX, NormalY, NormalZ, Building ID, Roof]","operationId":"get_lidar_for_property_api_3d_lidar__property_identifier__get","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"property_identifier","in":"path","required":true,"schema":{"type":"string","description":"Parcel identifier","title":"Property Identifier"},"description":"Parcel identifier","examples":{"Münster Fernholzstraße 33":{"value":"PROPERTY-DENW49AL00009b0v"},"Berlin Dennewitzstraße 2":{"value":"PROPERTY-DEBE01YYK0002NvW"},"München Isartalstraße 30":{"value":"PROPERTY-DEBYvAAAAABTeGhf"},"Frankfurt Stralsunder Straße 10":{"value":"PROPERTY-DEHE06200001eAaR"},"Hamburg Rothenbaumchaussee 199":{"value":"PROPERTY-DEHHALKAV0000wN6"},"Kiel Lutherstraße 9":{"value":"PROPERTY-DESHPDHK0001ub9p"},"Bad Sulza Gartenstraße 7":{"value":"PROPERTY-DETHL51P00000i8T"},"Werdau Weißenbrunn 3a":{"value":"PROPERTY-DESNALK0f0009giL"}}},{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","prefixItems":[{"type":"number"},{"type":"number"},{"type":"number"},{"type":"integer"},{"type":"number"},{"type":"number"},{"type":"number"},{"anyOf":[{"type":"string"},{"type":"null"}]},{"anyOf":[{"type":"boolean"},{"type":"null"}]}],"minItems":9,"maxItems":9,"title":"Response Get Lidar For Property Api 3D Lidar  Property Identifier  Get"}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/cadastral/parcels":{"get":{"tags":["Cadastral","Partner API"],"summary":"Get Parcels as GeoJSON","description":"Query parcels in a given bounding box. Returns a GeoJSON feature collection. Results out of the subscription area are excluded","operationId":"get_parcels_as_geojson_api_cadastral_parcels_get","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"top","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Top bound latitude coordinate in EPSG 4326","title":"Top"},"description":"Top bound latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.991191}}},{"name":"left","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Left bound longitude coordinate in EPSG 4326","title":"Left"},"description":"Left bound longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.591723}}},{"name":"bottom","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Bottom bound latitude coordinate in EPSG 4326","title":"Bottom"},"description":"Bottom bound latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.990776}}},{"name":"right","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Right bound longitude coordinate in EPSG 4326","title":"Right"},"description":"Right bound longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.592227}}},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":90,"minimum":-90},{"type":"null"}],"description":"Center latitude coordinate in EPSG 4326","title":"Lat"},"description":"Center latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.9909653}}},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":180,"minimum":-180},{"type":"null"}],"description":"Center longitude coordinate in EPSG 4326","title":"Lng"},"description":"Center longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.5918667}}},{"name":"autoshrink","in":"query","required":false,"schema":{"type":"boolean","description":"If set the bounding box will be shrunk silently if too large. Otherwise a `bounding-box-too-large` error is responded.","default":false,"title":"Autoshrink"},"description":"If set the bounding box will be shrunk silently if too large. Otherwise a `bounding-box-too-large` error is responded."},{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","description":"If set a download will be started for the requested resource","default":false,"title":"Download"},"description":"If set a download will be started for the requested resource","examples":{"True":{"value":true}}},{"name":"format","in":"query","required":false,"schema":{"enum":["geojson","dxf"],"type":"string","description":"The format of the download","default":"geojson","title":"Format"},"description":"The format of the download","examples":{"geojson":{"value":"geojson"},"dxf":{"value":"dxf"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcealedParcelCollection"}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/cadastral/parcel/{parcel_identifier}":{"get":{"tags":["Cadastral","Partner API"],"summary":"Get Parcel as GeoJSON","description":"Query parcel by id. Returns a GeoJSON feature with the parcel properties and geometry.","operationId":"get_parcel_as_geojson_api_cadastral_parcel__parcel_identifier__get","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"parcel_identifier","in":"path","required":true,"schema":{"type":"string","description":"Building Identifier","title":"Parcel Identifier"},"description":"Building Identifier","examples":{"Münster Fernholzstraße 33":{"value":"DENW49AL00009b0v"},"Berlin Dennewitzstraße 2":{"value":"DEBE01YYK0002NvW"},"München Isartalstraße 30":{"value":"DEBYvAAAAABTeGhf"},"Frankfurt Stralsunder Straße 10":{"value":"DEHE06200001eAaR"},"Hamburg Rothenbaumchaussee 199":{"value":"DEHHALKAV0000wN6"},"Kiel Lutherstraße 9":{"value":"DESHPDHK0001ub9p"},"Bad Sulza Gartenstraße 7":{"value":"DETHL51P00000i8T"},"Werdau Weißenbrunn 3a":{"value":"DESNALK0f0009giL"}}},{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","description":"If set a download will be started for the requested resource","default":false,"title":"Download"},"description":"If set a download will be started for the requested resource","examples":{"True":{"value":true}}},{"name":"format","in":"query","required":false,"schema":{"enum":["geojson","dxf"],"type":"string","description":"The format of the download","default":"geojson","title":"Format"},"description":"The format of the download","examples":{"geojson":{"value":"geojson"},"dxf":{"value":"dxf"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcealedParcel"}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/cadastral/parcel-at":{"get":{"tags":["Cadastral","Partner API"],"summary":"Get a Parcel as GeoJSON by Lat/Lng","description":"Get details of a parcel at a specific coordinate","operationId":"get_parcel_at_coordinate_as_geojson_api_cadastral_parcel_at_get","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"lat","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Parcel latitude coordinate in EPSG 4326","title":"Lat"},"description":"Parcel latitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":51.9909653},"Berlin Dennewitzstraße 2":{"value":52.4996479},"München Isartalstraße 30":{"value":48.1206001},"Frankfurt Stralsunder Straße 10":{"value":50.1294342},"Hamburg Rothenbaumchaussee 199":{"value":53.5784523},"Kiel Lutherstraße 9":{"value":54.3151818},"Bad Sulza Gartenstraße 7":{"value":51.0860736},"Werdau Weißenbrunn 3a":{"value":50.7053124}}},{"name":"lng","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Parcel longitude coordinate in EPSG 4326","title":"Lng"},"description":"Parcel longitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":7.5918667},"Berlin Dennewitzstraße 2":{"value":13.3698984},"München Isartalstraße 30":{"value":11.5606595},"Frankfurt Stralsunder Straße 10":{"value":8.6702905},"Hamburg Rothenbaumchaussee 199":{"value":9.9883648},"Kiel Lutherstraße 9":{"value":10.1169388},"Bad Sulza Gartenstraße 7":{"value":11.6291221},"Werdau Weißenbrunn 3a":{"value":12.4199148}}},{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","description":"If set a download will be started for the requested resource","default":false,"title":"Download"},"description":"If set a download will be started for the requested resource","examples":{"True":{"value":true}}},{"name":"format","in":"query","required":false,"schema":{"enum":["geojson","dxf"],"type":"string","description":"The format of the download","default":"geojson","title":"Format"},"description":"The format of the download","examples":{"geojson":{"value":"geojson"},"dxf":{"value":"dxf"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcealedParcel"}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/cadastral/parcel-near-by":{"get":{"tags":["Cadastral","Partner API"],"summary":"Get a Parcel as GeoJSON near Lat/Lng","description":"Get details of a parcel within a specific radius of a coordinate","operationId":"get_parcel_nearby_as_geojson_api_cadastral_parcel_near_by_get","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"radius","in":"query","required":false,"schema":{"type":"integer","maximum":300,"minimum":0,"description":"Radius tolerance in meters to find entities within.","default":30,"title":"Radius"},"description":"Radius tolerance in meters to find entities within."},{"name":"filter","in":"query","required":false,"schema":{"enum":["only-streets","no-streets","all"],"type":"string","description":"Filter by streets","default":"all","title":"Filter"},"description":"Filter by streets"},{"name":"lat","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Parcel latitude coordinate in EPSG 4326","title":"Lat"},"description":"Parcel latitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":51.9909653},"Berlin Dennewitzstraße 2":{"value":52.4996479},"München Isartalstraße 30":{"value":48.1206001},"Frankfurt Stralsunder Straße 10":{"value":50.1294342},"Hamburg Rothenbaumchaussee 199":{"value":53.5784523},"Kiel Lutherstraße 9":{"value":54.3151818},"Bad Sulza Gartenstraße 7":{"value":51.0860736},"Werdau Weißenbrunn 3a":{"value":50.7053124}}},{"name":"lng","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Parcel longitude coordinate in EPSG 4326","title":"Lng"},"description":"Parcel longitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":7.5918667},"Berlin Dennewitzstraße 2":{"value":13.3698984},"München Isartalstraße 30":{"value":11.5606595},"Frankfurt Stralsunder Straße 10":{"value":8.6702905},"Hamburg Rothenbaumchaussee 199":{"value":9.9883648},"Kiel Lutherstraße 9":{"value":10.1169388},"Bad Sulza Gartenstraße 7":{"value":11.6291221},"Werdau Weißenbrunn 3a":{"value":12.4199148}}},{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","description":"If set a download will be started for the requested resource","default":false,"title":"Download"},"description":"If set a download will be started for the requested resource","examples":{"True":{"value":true}}},{"name":"format","in":"query","required":false,"schema":{"enum":["geojson","dxf"],"type":"string","description":"The format of the download","default":"geojson","title":"Format"},"description":"The format of the download","examples":{"geojson":{"value":"geojson"},"dxf":{"value":"dxf"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcealedParcel"}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/cadastral/property-parcels":{"get":{"tags":["Cadastral","Partner API"],"summary":"Get Parcels belonging to a property as GeoJSON","description":"Query parcels in a given property either by parcel or property identifier. Returns a GeoJSON feature collection if format is geojson, geometries only for other formats. Some metrics are concealed depending of your authentication and results out of the subscription areas are excluded.","operationId":"get_parcels_for_properties_api_cadastral_property_parcels_get","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"parcel_identifier","in":"query","required":true,"schema":{"type":"string","description":"Parcel identifier, property identifier or custom property identifier","title":"Parcel Identifier"},"description":"Parcel identifier, property identifier or custom property identifier","examples":{"Münster Fernholzstraße 33":{"value":"DENW49AL00009b0v"},"Berlin Dennewitzstraße 2":{"value":"DEBE01YYK0002NvW"},"München Isartalstraße 30":{"value":"DEBYvAAAAABTeGhf"},"Frankfurt Stralsunder Straße 10":{"value":"DEHE06200001eAaR"},"Hamburg Rothenbaumchaussee 199":{"value":"DEHHALKAV0000wN6"},"Kiel Lutherstraße 9":{"value":"DESHPDHK0001ub9p"},"Bad Sulza Gartenstraße 7":{"value":"DETHL51P00000i8T"},"Werdau Weißenbrunn 3a":{"value":"DESNALK0f0009giL"},"Custom Property":{"value":"CUSTOM-KLUv_SA9_QAAkAADAA0Ls2FXJbfjZH6l_zKOjwUAYCMoDGzhsmmBKw=="}}},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":90,"minimum":-90},{"type":"null"}],"description":"Parcel latitude coordinate in EPSG 4326","title":"Lat"},"description":"Parcel latitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":51.9909653},"Berlin Dennewitzstraße 2":{"value":52.4996479},"München Isartalstraße 30":{"value":48.1206001},"Frankfurt Stralsunder Straße 10":{"value":50.1294342},"Hamburg Rothenbaumchaussee 199":{"value":53.5784523},"Kiel Lutherstraße 9":{"value":54.3151818},"Bad Sulza Gartenstraße 7":{"value":51.0860736},"Werdau Weißenbrunn 3a":{"value":50.7053124}}},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":180,"minimum":-180},{"type":"null"}],"description":"Parcel longitude coordinate in EPSG 4326","title":"Lng"},"description":"Parcel longitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":7.5918667},"Berlin Dennewitzstraße 2":{"value":13.3698984},"München Isartalstraße 30":{"value":11.5606595},"Frankfurt Stralsunder Straße 10":{"value":8.6702905},"Hamburg Rothenbaumchaussee 199":{"value":9.9883648},"Kiel Lutherstraße 9":{"value":10.1169388},"Bad Sulza Gartenstraße 7":{"value":11.6291221},"Werdau Weißenbrunn 3a":{"value":12.4199148}}},{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","description":"If set a download will be started for the requested resource","default":false,"title":"Download"},"description":"If set a download will be started for the requested resource","examples":{"True":{"value":true}}},{"name":"format","in":"query","required":false,"schema":{"enum":["geojson","dxf"],"type":"string","description":"The format of the download","default":"geojson","title":"Format"},"description":"The format of the download","examples":{"geojson":{"value":"geojson"},"dxf":{"value":"dxf"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcealedParcelCollection"}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/cadastral/property":{"post":{"tags":["Cadastral","Partner API"],"summary":"Get a Property as GeoJSON","description":"Create a custom property by combining multiple parcels and buildings. Not all features are supported for the custom property. Some endpoints support the generated property identifier.","operationId":"create_custom_property_api_cadastral_property_post","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","description":"If set a download will be started for the requested resource","default":false,"title":"Download"},"description":"If set a download will be started for the requested resource","examples":{"True":{"value":true}}},{"name":"format","in":"query","required":false,"schema":{"enum":["geojson","dxf"],"type":"string","description":"The format of the download","default":"geojson","title":"Format"},"description":"The format of the download","examples":{"geojson":{"value":"geojson"},"dxf":{"value":"dxf"}}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomProperty","description":"Parcels and buildings to combine"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcealedProperty"}}}},"403":{"description":"You are not allowed to access this resource.","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Cadastral","Partner API"],"summary":"Get a Property as GeoJSON","description":"Get details of a property. Properties virtually bundle multiple parcels into one property if their buildings overlap. The property contains computed metrics for the density of build use. Returns a GeoJSON feature. Some metrics are concealed depending on your authentication and authorization state and results out of the subscription areas are not allowed.","operationId":"get_property_as_geojson_api_cadastral_property_get","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"parcel_identifier","in":"query","required":true,"schema":{"type":"string","description":"Parcel identifier, property identifier or custom property identifier","title":"Parcel Identifier"},"description":"Parcel identifier, property identifier or custom property identifier","examples":{"Münster Fernholzstraße 33":{"value":"DENW49AL00009b0v"},"Berlin Dennewitzstraße 2":{"value":"DEBE01YYK0002NvW"},"München Isartalstraße 30":{"value":"DEBYvAAAAABTeGhf"},"Frankfurt Stralsunder Straße 10":{"value":"DEHE06200001eAaR"},"Hamburg Rothenbaumchaussee 199":{"value":"DEHHALKAV0000wN6"},"Kiel Lutherstraße 9":{"value":"DESHPDHK0001ub9p"},"Bad Sulza Gartenstraße 7":{"value":"DETHL51P00000i8T"},"Werdau Weißenbrunn 3a":{"value":"DESNALK0f0009giL"},"Custom Property":{"value":"CUSTOM-KLUv_SA9_QAAkAADAA0Ls2FXJbfjZH6l_zKOjwUAYCMoDGzhsmmBKw=="}}},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":90,"minimum":-90},{"type":"null"}],"description":"Parcel latitude coordinate in EPSG 4326","title":"Lat"},"description":"Parcel latitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":51.9909653},"Berlin Dennewitzstraße 2":{"value":52.4996479},"München Isartalstraße 30":{"value":48.1206001},"Frankfurt Stralsunder Straße 10":{"value":50.1294342},"Hamburg Rothenbaumchaussee 199":{"value":53.5784523},"Kiel Lutherstraße 9":{"value":54.3151818},"Bad Sulza Gartenstraße 7":{"value":51.0860736},"Werdau Weißenbrunn 3a":{"value":50.7053124}}},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":180,"minimum":-180},{"type":"null"}],"description":"Parcel longitude coordinate in EPSG 4326","title":"Lng"},"description":"Parcel longitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":7.5918667},"Berlin Dennewitzstraße 2":{"value":13.3698984},"München Isartalstraße 30":{"value":11.5606595},"Frankfurt Stralsunder Straße 10":{"value":8.6702905},"Hamburg Rothenbaumchaussee 199":{"value":9.9883648},"Kiel Lutherstraße 9":{"value":10.1169388},"Bad Sulza Gartenstraße 7":{"value":11.6291221},"Werdau Weißenbrunn 3a":{"value":12.4199148}}},{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","description":"If set a download will be started for the requested resource","default":false,"title":"Download"},"description":"If set a download will be started for the requested resource","examples":{"True":{"value":true}}},{"name":"format","in":"query","required":false,"schema":{"enum":["geojson","dxf"],"type":"string","description":"The format of the download","default":"geojson","title":"Format"},"description":"The format of the download","examples":{"geojson":{"value":"geojson"},"dxf":{"value":"dxf"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcealedProperty"}}}},"403":{"description":"You are not allowed to access this resource.","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/cadastral/property-at":{"get":{"tags":["Cadastral","Partner API"],"summary":"Get a Property as GeoJSON by Lat/Lng","description":"Get details of a property at a specific coordinate. Properties virtually bundle multiple parcels into one property if their buildings overlap. The property contains computed metrics for the density of build use. Returns a GeoJSON feature. Some metrics are concealed depending on your authentication and authorization state and results out of the subscription areas are not allowed.","operationId":"get_property_at_coordinate_as_geojson_api_cadastral_property_at_get","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"lat","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Parcel latitude coordinate in EPSG 4326","title":"Lat"},"description":"Parcel latitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":51.9909653},"Berlin Dennewitzstraße 2":{"value":52.4996479},"München Isartalstraße 30":{"value":48.1206001},"Frankfurt Stralsunder Straße 10":{"value":50.1294342},"Hamburg Rothenbaumchaussee 199":{"value":53.5784523},"Kiel Lutherstraße 9":{"value":54.3151818},"Bad Sulza Gartenstraße 7":{"value":51.0860736},"Werdau Weißenbrunn 3a":{"value":50.7053124}}},{"name":"lng","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Parcel longitude coordinate in EPSG 4326","title":"Lng"},"description":"Parcel longitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":7.5918667},"Berlin Dennewitzstraße 2":{"value":13.3698984},"München Isartalstraße 30":{"value":11.5606595},"Frankfurt Stralsunder Straße 10":{"value":8.6702905},"Hamburg Rothenbaumchaussee 199":{"value":9.9883648},"Kiel Lutherstraße 9":{"value":10.1169388},"Bad Sulza Gartenstraße 7":{"value":11.6291221},"Werdau Weißenbrunn 3a":{"value":12.4199148}}},{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","description":"If set a download will be started for the requested resource","default":false,"title":"Download"},"description":"If set a download will be started for the requested resource","examples":{"True":{"value":true}}},{"name":"format","in":"query","required":false,"schema":{"enum":["geojson","dxf"],"type":"string","description":"The format of the download","default":"geojson","title":"Format"},"description":"The format of the download","examples":{"geojson":{"value":"geojson"},"dxf":{"value":"dxf"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcealedProperty"}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed, e.g. the provided download token is invalid or expired.","content":{"application/json":{"example":{"detail":"Invalid download token"}}}},"403":{"description":"You are not allowed to access this resource.","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/cadastral/property-near-by":{"get":{"tags":["Cadastral","Partner API"],"summary":"Get a Property as GeoJSON near Lat/Lng","description":"Get details of the closest property within a specific radius of a coordinate. Properties virtually bundle multiple parcels into one property if their buildings overlap. The property contains computed metrics for the density of build use. Returns a GeoJSON feature. Some metrics are concealed depending on your authentication and authorization state and results out of the subscription areas are not allowed.","operationId":"get_property_nearby_as_geojson_api_cadastral_property_near_by_get","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"radius","in":"query","required":false,"schema":{"type":"integer","maximum":300,"minimum":0,"description":"Radius tolerance in meters to find entities within.","default":30,"title":"Radius"},"description":"Radius tolerance in meters to find entities within."},{"name":"filter","in":"query","required":false,"schema":{"enum":["only-streets","no-streets","all"],"type":"string","description":"Filter by streets","default":"all","title":"Filter"},"description":"Filter by streets"},{"name":"lat","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Parcel latitude coordinate in EPSG 4326","title":"Lat"},"description":"Parcel latitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":51.9909653},"Berlin Dennewitzstraße 2":{"value":52.4996479},"München Isartalstraße 30":{"value":48.1206001},"Frankfurt Stralsunder Straße 10":{"value":50.1294342},"Hamburg Rothenbaumchaussee 199":{"value":53.5784523},"Kiel Lutherstraße 9":{"value":54.3151818},"Bad Sulza Gartenstraße 7":{"value":51.0860736},"Werdau Weißenbrunn 3a":{"value":50.7053124}}},{"name":"lng","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Parcel longitude coordinate in EPSG 4326","title":"Lng"},"description":"Parcel longitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":7.5918667},"Berlin Dennewitzstraße 2":{"value":13.3698984},"München Isartalstraße 30":{"value":11.5606595},"Frankfurt Stralsunder Straße 10":{"value":8.6702905},"Hamburg Rothenbaumchaussee 199":{"value":9.9883648},"Kiel Lutherstraße 9":{"value":10.1169388},"Bad Sulza Gartenstraße 7":{"value":11.6291221},"Werdau Weißenbrunn 3a":{"value":12.4199148}}},{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","description":"If set a download will be started for the requested resource","default":false,"title":"Download"},"description":"If set a download will be started for the requested resource","examples":{"True":{"value":true}}},{"name":"format","in":"query","required":false,"schema":{"enum":["geojson","dxf"],"type":"string","description":"The format of the download","default":"geojson","title":"Format"},"description":"The format of the download","examples":{"geojson":{"value":"geojson"},"dxf":{"value":"dxf"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcealedProperty"}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed, e.g. the provided download token is invalid or expired.","content":{"application/json":{"example":{"detail":"Invalid download token"}}}},"403":{"description":"You are not allowed to access this resource.","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/cadastral/properties":{"get":{"tags":["Cadastral","Partner API"],"summary":"Get Properties as GeoJSON","description":"Query properties in a given bounding box. Properties virtually bundle multiple parcels into one property if their buildings overlap. The property contains computed metrics for the density of build use. Returns a GeoJSON feature collection.","operationId":"get_properties_as_geojson_api_cadastral_properties_get","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"top","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Top bound latitude coordinate in EPSG 4326","title":"Top"},"description":"Top bound latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.991191}}},{"name":"left","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Left bound longitude coordinate in EPSG 4326","title":"Left"},"description":"Left bound longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.591723}}},{"name":"bottom","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Bottom bound latitude coordinate in EPSG 4326","title":"Bottom"},"description":"Bottom bound latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.990776}}},{"name":"right","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Right bound longitude coordinate in EPSG 4326","title":"Right"},"description":"Right bound longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.592227}}},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":90,"minimum":-90},{"type":"null"}],"description":"Center latitude coordinate in EPSG 4326","title":"Lat"},"description":"Center latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.9909653}}},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":180,"minimum":-180},{"type":"null"}],"description":"Center longitude coordinate in EPSG 4326","title":"Lng"},"description":"Center longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.5918667}}},{"name":"autoshrink","in":"query","required":false,"schema":{"type":"boolean","description":"If set the bounding box will be shrunk silently if too large. Otherwise a `bounding-box-too-large` error is responded.","default":false,"title":"Autoshrink"},"description":"If set the bounding box will be shrunk silently if too large. Otherwise a `bounding-box-too-large` error is responded."},{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","description":"If set a download will be started for the requested resource","default":false,"title":"Download"},"description":"If set a download will be started for the requested resource","examples":{"True":{"value":true}}},{"name":"format","in":"query","required":false,"schema":{"enum":["geojson","dxf"],"type":"string","description":"The format of the download","default":"geojson","title":"Format"},"description":"The format of the download","examples":{"geojson":{"value":"geojson"},"dxf":{"value":"dxf"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcealedPropertyCollection"}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/cadastral/property/{property_identifier}/zoning-plan":{"get":{"tags":["Cadastral","Partner API"],"summary":"Get Zoning Plan data for a Property","description":"Find minimum applicable zoning plan conditions to a given property. Returns aggregated zoning plan metrics including max GRZ, GFZ, BMZ, height limits, and references to source documents. Supports property identifiers, parcel identifiers, and custom property identifiers.","operationId":"get_property_zoning_plan_api_cadastral_property__property_identifier__zoning_plan_get","security":[{"bearer":[]}],"parameters":[{"name":"property_identifier","in":"path","required":true,"schema":{"type":"string","description":"The property identifier, parcel identifier, or custom property identifier","title":"Property Identifier"},"description":"The property identifier, parcel identifier, or custom property identifier","examples":{"Münster Fernholzstraße 33":{"value":"PROPERTY-DENW49AL00009b0v"},"Custom Property":{"value":"CUSTOM-KLUv_SA9_QAAkAADAA0Ls2FXJbfjZH6l_zKOjwUAYCMoDGzhsmmBKw=="}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyZoningPlanResponse"}}}},"403":{"description":"You are not allowed to access this resource.","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"The request contains invalid (user) data. Which fields are invalid is stored under `errors`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}}}}},"/api/cadastral/zoning-plans/{zoning_plan_identifier}":{"get":{"tags":["Cadastral","Partner API"],"summary":"Get Zoning Plan data by Plan Identifier","description":"Get aggregated zoning plan data for a specific zoning plan identifier. Returns minimum values from the plan and its partial areas including max GRZ, GFZ, BMZ, height limits, and references to source documents.","operationId":"get_zoning_plan_by_identifier_api_cadastral_zoning_plans__zoning_plan_identifier__get","security":[{"bearer":[]}],"parameters":[{"name":"zoning_plan_identifier","in":"path","required":true,"schema":{"type":"string","description":"The GML ID of the zoning plan","title":"Zoning Plan Identifier"},"description":"The GML ID of the zoning plan","examples":{"GML ID":{"value":"GML_bafdf3d9-984d-4e1b-b962-9e0ba08ce1b8"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoningPlanResponse"}}}},"403":{"description":"You are not allowed to access this resource.","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/3d/property":{"get":{"tags":["3D Building Models","Partner API"],"summary":"Get 3d export of Property","description":"Get details of a property. Properties virtually bundle multiple parcels into one property if their buildings overlap. Returns a .zip which includes the 3d files.","operationId":"get_property_3d_api_3d_property_get","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"parcel_identifier","in":"query","required":true,"schema":{"type":"string","description":"Parcel identifier, property identifier or custom property identifier","title":"Parcel Identifier"},"description":"Parcel identifier, property identifier or custom property identifier","examples":{"Münster Fernholzstraße 33":{"value":"DENW49AL00009b0v"},"Berlin Dennewitzstraße 2":{"value":"DEBE01YYK0002NvW"},"München Isartalstraße 30":{"value":"DEBYvAAAAABTeGhf"},"Frankfurt Stralsunder Straße 10":{"value":"DEHE06200001eAaR"},"Hamburg Rothenbaumchaussee 199":{"value":"DEHHALKAV0000wN6"},"Kiel Lutherstraße 9":{"value":"DESHPDHK0001ub9p"},"Bad Sulza Gartenstraße 7":{"value":"DETHL51P00000i8T"},"Werdau Weißenbrunn 3a":{"value":"DESNALK0f0009giL"},"Custom Property":{"value":"CUSTOM-KLUv_SA9_QAAkAADAA0Ls2FXJbfjZH6l_zKOjwUAYCMoDGzhsmmBKw=="}}},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":90,"minimum":-90},{"type":"null"}],"description":"Parcel latitude coordinate in EPSG 4326","title":"Lat"},"description":"Parcel latitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":51.9909653},"Berlin Dennewitzstraße 2":{"value":52.4996479},"München Isartalstraße 30":{"value":48.1206001},"Frankfurt Stralsunder Straße 10":{"value":50.1294342},"Hamburg Rothenbaumchaussee 199":{"value":53.5784523},"Kiel Lutherstraße 9":{"value":54.3151818},"Bad Sulza Gartenstraße 7":{"value":51.0860736},"Werdau Weißenbrunn 3a":{"value":50.7053124}}},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":180,"minimum":-180},{"type":"null"}],"description":"Parcel longitude coordinate in EPSG 4326","title":"Lng"},"description":"Parcel longitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":7.5918667},"Berlin Dennewitzstraße 2":{"value":13.3698984},"München Isartalstraße 30":{"value":11.5606595},"Frankfurt Stralsunder Straße 10":{"value":8.6702905},"Hamburg Rothenbaumchaussee 199":{"value":9.9883648},"Kiel Lutherstraße 9":{"value":10.1169388},"Bad Sulza Gartenstraße 7":{"value":11.6291221},"Werdau Weißenbrunn 3a":{"value":12.4199148}}},{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","description":"If set a download will be started for the requested resource","default":false,"title":"Download"},"description":"If set a download will be started for the requested resource"},{"name":"format","in":"query","required":false,"schema":{"enum":["obj","gltf","stl"],"type":"string","description":"The format of the download","default":"obj","title":"Format"},"description":"The format of the download","examples":{"obj":{"value":"obj"},"gltf":{"value":"gltf"},"stl":{"value":"stl"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"403":{"description":"You are not allowed to access this resource.","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/potential/building-potential":{"get":{"tags":["Building Potential","Partner API"],"summary":"AI Building Potential","description":"Get the building potential for new building (Neubau) predicted by the syte AI for a given property","operationId":"get_new_building_potential_api_potential_building_potential_get","security":[{"bearer":[]}],"parameters":[{"name":"usage_group","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Override the usage group (Nutzungsartengruppe) of the property to get the building potential for. If not given the biggest usage group of the property is used.","title":"Usage Group"},"description":"Override the usage group (Nutzungsartengruppe) of the property to get the building potential for. If not given the biggest usage group of the property is used.","examples":{"Usage Group":{"value":"Wohnbaufläche"}}},{"name":"model_version_key","in":"query","required":false,"schema":{"type":"string","description":"Override the model version that is used for the prediction. Supported values: 'SBP_v1.0_latest', 'SBP_v1.3_latest', and 'SBP_v1.4_latest'. The 1.4 model uses a runtime Schwarzplan-based geometry encoder for higher accuracy at significantly higher latency, and requires WKT property + building footprints (provided automatically by the backend).","default":"SBP_v1.4_latest","title":"Model Version Key"},"description":"Override the model version that is used for the prediction. Supported values: 'SBP_v1.0_latest', 'SBP_v1.3_latest', and 'SBP_v1.4_latest'. The 1.4 model uses a runtime Schwarzplan-based geometry encoder for higher accuracy at significantly higher latency, and requires WKT property + building footprints (provided automatically by the backend).","examples":{"Model Version Key":{"value":"SBP_v1.4_latest"}}},{"name":"parcel_identifier","in":"query","required":true,"schema":{"type":"string","description":"Parcel identifier, property identifier or custom property identifier","title":"Parcel Identifier"},"description":"Parcel identifier, property identifier or custom property identifier","examples":{"Münster Fernholzstraße 33":{"value":"DENW49AL00009b0v"},"Berlin Dennewitzstraße 2":{"value":"DEBE01YYK0002NvW"},"München Isartalstraße 30":{"value":"DEBYvAAAAABTeGhf"},"Frankfurt Stralsunder Straße 10":{"value":"DEHE06200001eAaR"},"Hamburg Rothenbaumchaussee 199":{"value":"DEHHALKAV0000wN6"},"Kiel Lutherstraße 9":{"value":"DESHPDHK0001ub9p"},"Bad Sulza Gartenstraße 7":{"value":"DETHL51P00000i8T"},"Werdau Weißenbrunn 3a":{"value":"DESNALK0f0009giL"},"Custom Property":{"value":"CUSTOM-KLUv_SA9_QAAkAADAA0Ls2FXJbfjZH6l_zKOjwUAYCMoDGzhsmmBKw=="}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildingPotential"}}}},"403":{"description":"You are not allowed to access this resource","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/PotentialUnavailableErrorResponse"}}}},"404":{"description":"Resource is either not available yet or not suitable","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"not_available_yet"},"schema":{"$ref":"#/components/schemas/PotentialUnavailableErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/potential/building-potential-at":{"get":{"tags":["Building Potential","Partner API"],"summary":"AI Building Potential by Lat/Lng","description":"Get the building potential for new building (Neubau) predicted by the syte AI for a given property","operationId":"get_new_building_potential_at_api_potential_building_potential_at_get","security":[{"bearer":[]}],"parameters":[{"name":"usage_group","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Override the usage group (Nutzungsartengruppe) of the property to get the building potential for. If not given the biggest usage group of the property is used.","title":"Usage Group"},"description":"Override the usage group (Nutzungsartengruppe) of the property to get the building potential for. If not given the biggest usage group of the property is used.","examples":{"Usage Group":{"value":"Wohnbaufläche"}}},{"name":"model_version_key","in":"query","required":false,"schema":{"type":"string","description":"Override the model version that is used for the prediction. Supported values: 'SBP_v1.0_latest', 'SBP_v1.3_latest', and 'SBP_v1.4_latest'. The 1.4 model uses a runtime Schwarzplan-based geometry encoder for higher accuracy at significantly higher latency, and requires WKT property + building footprints (provided automatically by the backend).","default":"SBP_v1.4_latest","title":"Model Version Key"},"description":"Override the model version that is used for the prediction. Supported values: 'SBP_v1.0_latest', 'SBP_v1.3_latest', and 'SBP_v1.4_latest'. The 1.4 model uses a runtime Schwarzplan-based geometry encoder for higher accuracy at significantly higher latency, and requires WKT property + building footprints (provided automatically by the backend).","examples":{"Model Version Key":{"value":"SBP_v1.4_latest"}}},{"name":"lat","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Parcel latitude coordinate in EPSG 4326","title":"Lat"},"description":"Parcel latitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":51.9909653},"Berlin Dennewitzstraße 2":{"value":52.4996479},"München Isartalstraße 30":{"value":48.1206001},"Frankfurt Stralsunder Straße 10":{"value":50.1294342},"Hamburg Rothenbaumchaussee 199":{"value":53.5784523},"Kiel Lutherstraße 9":{"value":54.3151818},"Bad Sulza Gartenstraße 7":{"value":51.0860736},"Werdau Weißenbrunn 3a":{"value":50.7053124}}},{"name":"lng","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Parcel longitude coordinate in EPSG 4326","title":"Lng"},"description":"Parcel longitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":7.5918667},"Berlin Dennewitzstraße 2":{"value":13.3698984},"München Isartalstraße 30":{"value":11.5606595},"Frankfurt Stralsunder Straße 10":{"value":8.6702905},"Hamburg Rothenbaumchaussee 199":{"value":9.9883648},"Kiel Lutherstraße 9":{"value":10.1169388},"Bad Sulza Gartenstraße 7":{"value":11.6291221},"Werdau Weißenbrunn 3a":{"value":12.4199148}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildingPotential"}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"You are not allowed to access this resource","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/PotentialUnavailableErrorResponse"}}}},"404":{"description":"Resource is either not available yet or not suitable","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"not_available_yet"},"schema":{"$ref":"#/components/schemas/PotentialUnavailableErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/potential/building-potential-parcel-neighbors":{"get":{"tags":["Building Potential","Partner API"],"summary":"AI building potential parcel neighbors","description":"Get neighboring parcels that where used to predict the AI building potential of a property","operationId":"get_building_potential_parcel_neighbors_api_potential_building_potential_parcel_neighbors_get","security":[{"bearer":[]}],"parameters":[{"name":"parcel_identifier","in":"query","required":true,"schema":{"type":"string","description":"Property or parcel identifier you want to get the building potential parcel neighbors for","title":"Parcel Identifier"},"description":"Property or parcel identifier you want to get the building potential parcel neighbors for","examples":{"Münster Fernholzstraße 33":{"value":"PROPERTY-DENW49AL00009b0v"}}},{"name":"model_version_key","in":"query","required":false,"schema":{"type":"string","description":"Override the model version that is used for the prediction. Supported values: 'SBP_v1.0_latest', 'SBP_v1.3_latest', and 'SBP_v1.4_latest'. The 1.4 model uses a runtime Schwarzplan-based geometry encoder for higher accuracy at significantly higher latency, and requires WKT property + building footprints (provided automatically by the backend).","default":"SBP_v1.4_latest","title":"Model Version Key"},"description":"Override the model version that is used for the prediction. Supported values: 'SBP_v1.0_latest', 'SBP_v1.3_latest', and 'SBP_v1.4_latest'. The 1.4 model uses a runtime Schwarzplan-based geometry encoder for higher accuracy at significantly higher latency, and requires WKT property + building footprints (provided automatically by the backend).","examples":{"Model Version Key":{"value":"SBP_v1.4_latest"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildingPotentialParcelNeighbors"}}}},"403":{"description":"You are not allowed to access this resource","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/PotentialUnavailableErrorResponse"}}}},"404":{"description":"Resource is either not available yet or not suitable","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"not_available_yet"},"schema":{"$ref":"#/components/schemas/PotentialUnavailableErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/potential/on-roof-building-pv":{"get":{"tags":["Photovoltaic Potential","Partner API"],"summary":"On-Roof Photovoltaic Potential","description":"Get the on-roof photovoltaic potential calculated with the LoD2 models for the requested building.","operationId":"get_building_roof_potential_api_potential_on_roof_building_pv_get","security":[{"bearer":[]}],"parameters":[{"name":"building_identifier","in":"query","required":true,"schema":{"type":"string","description":"The building or identifier to get the roof potential for","title":"Building Identifier"},"description":"The building or identifier to get the roof potential for","examples":{"Münster Fernholzstraße 33":{"value":"DENW49AL00009XTV"},"Berlin Dennewitzstraße 2":{"value":"DEBE01YYK0002Q3o"},"München Isartalstraße 30":{"value":"DEBYvAAAAABTeGiB"},"Frankfurt Stralsunder Straße 10":{"value":"DEHE06200001eBUl"},"Hamburg Rothenbaumchaussee 199":{"value":"DEHHALKAV0000yuD"},"Kiel Lutherstraße 9":{"value":"DESHPDHK0001ujRg"},"Bad Sulza Gartenstraße 7":{"value":"DETHL51P00000zjQ"},"Werdau Weißenbrunn 3a":{"value":"DESNALK0f000B70D"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnRoofBuildingPVPotential"}}}},"403":{"description":"You are not allowed to access this resource","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/PotentialUnavailableErrorResponse"}}}},"404":{"description":"Resource is either not available yet or not suitable","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"not_available_yet"},"schema":{"$ref":"#/components/schemas/PotentialUnavailableErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/potential/on-roof-building-pv-at":{"get":{"tags":["Photovoltaic Potential","Partner API"],"summary":"On-Roof Photovoltaic Potential by Lat/lng","description":"Get the on-roof photovoltaic potential calculated with the LoD2 models for the requested building","operationId":"get_building_roof_potential_at_api_potential_on_roof_building_pv_at_get","security":[{"bearer":[]}],"parameters":[{"name":"lat","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Parcel latitude coordinate in EPSG 4326","title":"Lat"},"description":"Parcel latitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":51.9909653},"Berlin Dennewitzstraße 2":{"value":52.4996479},"München Isartalstraße 30":{"value":48.1206001},"Frankfurt Stralsunder Straße 10":{"value":50.1294342},"Hamburg Rothenbaumchaussee 199":{"value":53.5784523},"Kiel Lutherstraße 9":{"value":54.3151818},"Bad Sulza Gartenstraße 7":{"value":51.0860736},"Werdau Weißenbrunn 3a":{"value":50.7053124}}},{"name":"lng","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Parcel longitude coordinate in EPSG 4326","title":"Lng"},"description":"Parcel longitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":7.5918667},"Berlin Dennewitzstraße 2":{"value":13.3698984},"München Isartalstraße 30":{"value":11.5606595},"Frankfurt Stralsunder Straße 10":{"value":8.6702905},"Hamburg Rothenbaumchaussee 199":{"value":9.9883648},"Kiel Lutherstraße 9":{"value":10.1169388},"Bad Sulza Gartenstraße 7":{"value":11.6291221},"Werdau Weißenbrunn 3a":{"value":12.4199148}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnRoofBuildingPVPotential"}}}},"403":{"description":"You are not allowed to access this resource","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/PotentialUnavailableErrorResponse"}}}},"404":{"description":"Resource is either not available yet or not suitable","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"not_available_yet"},"schema":{"$ref":"#/components/schemas/PotentialUnavailableErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/potential/on-roof-property-pv":{"get":{"tags":["Photovoltaic Potential","Partner API"],"summary":"On-Roof Photovoltaic Potential for a Property","description":"Get the on-roof photovoltaic potential calculated with the LoD2 models for all buildings on a property","operationId":"get_property_roof_potential_api_potential_on_roof_property_pv_get","security":[{"bearer":[]}],"parameters":[{"name":"parcel_identifier","in":"query","required":true,"schema":{"type":"string","description":"Parcel identifier, property identifier or custom property identifier","title":"Parcel Identifier"},"description":"Parcel identifier, property identifier or custom property identifier","examples":{"Münster Fernholzstraße 33":{"value":"DENW49AL00009b0v"},"Berlin Dennewitzstraße 2":{"value":"DEBE01YYK0002NvW"},"München Isartalstraße 30":{"value":"DEBYvAAAAABTeGhf"},"Frankfurt Stralsunder Straße 10":{"value":"DEHE06200001eAaR"},"Hamburg Rothenbaumchaussee 199":{"value":"DEHHALKAV0000wN6"},"Kiel Lutherstraße 9":{"value":"DESHPDHK0001ub9p"},"Bad Sulza Gartenstraße 7":{"value":"DETHL51P00000i8T"},"Werdau Weißenbrunn 3a":{"value":"DESNALK0f0009giL"},"Custom Property":{"value":"CUSTOM-KLUv_SA9_QAAkAADAA0Ls2FXJbfjZH6l_zKOjwUAYCMoDGzhsmmBKw=="}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnRoofPropertyPVPotential"}}}},"403":{"description":"You are not allowed to access this resource","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/PotentialUnavailableErrorResponse"}}}},"404":{"description":"Resource is either not available yet or not suitable","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"not_available_yet"},"schema":{"$ref":"#/components/schemas/PotentialUnavailableErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/potential/on-roof-property-pv-at":{"get":{"tags":["Photovoltaic Potential","Partner API"],"summary":"On-Roof Photovoltaic Potential for a Property by Lat/lng","description":"Get the on-roof photovoltaic potential calculated with the LoD2 models for all buildings on a property","operationId":"get_property_roof_potential_at_api_potential_on_roof_property_pv_at_get","security":[{"bearer":[]}],"parameters":[{"name":"lat","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Parcel latitude coordinate in EPSG 4326","title":"Lat"},"description":"Parcel latitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":51.9909653},"Berlin Dennewitzstraße 2":{"value":52.4996479},"München Isartalstraße 30":{"value":48.1206001},"Frankfurt Stralsunder Straße 10":{"value":50.1294342},"Hamburg Rothenbaumchaussee 199":{"value":53.5784523},"Kiel Lutherstraße 9":{"value":54.3151818},"Bad Sulza Gartenstraße 7":{"value":51.0860736},"Werdau Weißenbrunn 3a":{"value":50.7053124}}},{"name":"lng","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Parcel longitude coordinate in EPSG 4326","title":"Lng"},"description":"Parcel longitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":7.5918667},"Berlin Dennewitzstraße 2":{"value":13.3698984},"München Isartalstraße 30":{"value":11.5606595},"Frankfurt Stralsunder Straße 10":{"value":8.6702905},"Hamburg Rothenbaumchaussee 199":{"value":9.9883648},"Kiel Lutherstraße 9":{"value":10.1169388},"Bad Sulza Gartenstraße 7":{"value":11.6291221},"Werdau Weißenbrunn 3a":{"value":12.4199148}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnRoofPropertyPVPotential"}}}},"403":{"description":"You are not allowed to access this resource","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/PotentialUnavailableErrorResponse"}}}},"404":{"description":"Resource is either not available yet or not suitable","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"not_available_yet"},"schema":{"$ref":"#/components/schemas/PotentialUnavailableErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/potential/on-roof-roof-pv":{"get":{"tags":["Photovoltaic Potential","Partner API"],"summary":"On-Roof Photovoltaic Potential for Roof Surfaces as GeoJSON","description":"Query Roof Surfaces in a given bounding box. Returns a GeoJSON feature collection that includes Photovoltaic Potential information. Results out of the subscription areas are excluded.","operationId":"get_on_roof_pv_as_geojson_api_potential_on_roof_roof_pv_get","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"},{"name":"top","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Top bound latitude coordinate in EPSG 4326","title":"Top"},"description":"Top bound latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.991191}}},{"name":"left","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Left bound longitude coordinate in EPSG 4326","title":"Left"},"description":"Left bound longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.591723}}},{"name":"bottom","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Bottom bound latitude coordinate in EPSG 4326","title":"Bottom"},"description":"Bottom bound latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.990776}}},{"name":"right","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Right bound longitude coordinate in EPSG 4326","title":"Right"},"description":"Right bound longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.592227}}},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":90,"minimum":-90},{"type":"null"}],"description":"Center latitude coordinate in EPSG 4326","title":"Lat"},"description":"Center latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.9909653}}},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":180,"minimum":-180},{"type":"null"}],"description":"Center longitude coordinate in EPSG 4326","title":"Lng"},"description":"Center longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.5918667}}},{"name":"autoshrink","in":"query","required":false,"schema":{"type":"boolean","description":"If set the bounding box will be shrunk silently if too large. Otherwise a `bounding-box-too-large` error is responded.","default":false,"title":"Autoshrink"},"description":"If set the bounding box will be shrunk silently if too large. Otherwise a `bounding-box-too-large` error is responded."},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","description":"If set a download will be started for the requested resource","default":false,"title":"Download"},"description":"If set a download will be started for the requested resource","examples":{"True":{"value":true}}},{"name":"format","in":"query","required":false,"schema":{"enum":["geojson","dxf"],"type":"string","description":"The format of the download","default":"geojson","title":"Format"},"description":"The format of the download","examples":{"geojson":{"value":"geojson"},"dxf":{"value":"dxf"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnRoofPropertyPVPotential"}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"You are not allowed to access this resource.","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"The request contains invalid (user) data. Which fields are invalid is stored under `errors`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}}}}},"/api/cadastral/usage-clusters":{"get":{"tags":["Cadastral","Partner API"],"summary":"Get Actual Usage Clusters as GeoJSON","description":"Query actual usage clusters (DE tatsächliche Nutzung) in a given bounding box. Returns a GeoJSON feature collection. Results outside of the subscription state are excluded.","operationId":"get_usage_clusters_as_geojson_api_cadastral_usage_clusters_get","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"top","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Top bound latitude coordinate in EPSG 4326","title":"Top"},"description":"Top bound latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.991191}}},{"name":"left","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Left bound longitude coordinate in EPSG 4326","title":"Left"},"description":"Left bound longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.591723}}},{"name":"bottom","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Bottom bound latitude coordinate in EPSG 4326","title":"Bottom"},"description":"Bottom bound latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.990776}}},{"name":"right","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Right bound longitude coordinate in EPSG 4326","title":"Right"},"description":"Right bound longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.592227}}},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":90,"minimum":-90},{"type":"null"}],"description":"Center latitude coordinate in EPSG 4326","title":"Lat"},"description":"Center latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.9909653}}},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":180,"minimum":-180},{"type":"null"}],"description":"Center longitude coordinate in EPSG 4326","title":"Lng"},"description":"Center longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.5918667}}},{"name":"autoshrink","in":"query","required":false,"schema":{"type":"boolean","description":"If set the bounding box will be shrunk silently if too large. Otherwise a `bounding-box-too-large` error is responded.","default":false,"title":"Autoshrink"},"description":"If set the bounding box will be shrunk silently if too large. Otherwise a `bounding-box-too-large` error is responded."},{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","description":"If set a download will be started for the requested resource","default":false,"title":"Download"},"description":"If set a download will be started for the requested resource","examples":{"True":{"value":true}}},{"name":"format","in":"query","required":false,"schema":{"enum":["geojson","dxf"],"type":"string","description":"The format of the download","default":"geojson","title":"Format"},"description":"The format of the download","examples":{"geojson":{"value":"geojson"},"dxf":{"value":"dxf"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageCluster"}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/3d/surroundings":{"get":{"tags":["3D Building Models","Partner API"],"summary":"Get 3d export of surroundings","description":"Get 3d export of buildings inside the bounding box","operationId":"get_surroudings_3d_api_3d_surroundings_get","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"top","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Top bound latitude coordinate in EPSG 4326","title":"Top"},"description":"Top bound latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.991191}}},{"name":"left","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Left bound longitude coordinate in EPSG 4326","title":"Left"},"description":"Left bound longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.591723}}},{"name":"bottom","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Bottom bound latitude coordinate in EPSG 4326","title":"Bottom"},"description":"Bottom bound latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.990776}}},{"name":"right","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Right bound longitude coordinate in EPSG 4326","title":"Right"},"description":"Right bound longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.592227}}},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":90,"minimum":-90},{"type":"null"}],"description":"Center latitude coordinate in EPSG 4326","title":"Lat"},"description":"Center latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.9909653}}},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":180,"minimum":-180},{"type":"null"}],"description":"Center longitude coordinate in EPSG 4326","title":"Lng"},"description":"Center longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.5918667}}},{"name":"autoshrink","in":"query","required":false,"schema":{"type":"boolean","description":"If set the bounding box will be shrunk silently if too large. Otherwise a `bounding-box-too-large` error is responded.","default":false,"title":"Autoshrink"},"description":"If set the bounding box will be shrunk silently if too large. Otherwise a `bounding-box-too-large` error is responded."},{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","description":"If set a download will be started for the requested resource","default":false,"title":"Download"},"description":"If set a download will be started for the requested resource"},{"name":"format","in":"query","required":false,"schema":{"enum":["obj","gltf","stl"],"type":"string","description":"The format of the download","default":"obj","title":"Format"},"description":"The format of the download","examples":{"obj":{"value":"obj"},"gltf":{"value":"gltf"},"stl":{"value":"stl"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"432":{"description":"Number of objects exceeds the limit. Try to reduce the bounding box or lookup area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"head":{"tags":["3D Building Models","Partner API"],"summary":"Check if 3d export of surroundings for the given bounding box is possible","description":"Status code 432 is returned if the bounding box contains too many buildings to export.\n        200 is returned if the export is possible.\",","operationId":"head_surroundings_3d_api_3d_surroundings_head","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"top","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Top bound latitude coordinate in EPSG 4326","title":"Top"},"description":"Top bound latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.991191}}},{"name":"left","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Left bound longitude coordinate in EPSG 4326","title":"Left"},"description":"Left bound longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.591723}}},{"name":"bottom","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Bottom bound latitude coordinate in EPSG 4326","title":"Bottom"},"description":"Bottom bound latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.990776}}},{"name":"right","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Right bound longitude coordinate in EPSG 4326","title":"Right"},"description":"Right bound longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.592227}}},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":90,"minimum":-90},{"type":"null"}],"description":"Center latitude coordinate in EPSG 4326","title":"Lat"},"description":"Center latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.9909653}}},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":180,"minimum":-180},{"type":"null"}],"description":"Center longitude coordinate in EPSG 4326","title":"Lng"},"description":"Center longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.5918667}}},{"name":"autoshrink","in":"query","required":false,"schema":{"type":"boolean","description":"If set the bounding box will be shrunk silently if too large. Otherwise a `bounding-box-too-large` error is responded.","default":false,"title":"Autoshrink"},"description":"If set the bounding box will be shrunk silently if too large. Otherwise a `bounding-box-too-large` error is responded."},{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"432":{"description":"Number of objects exceeds the limit. Try to reduce the bounding box or lookup area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/search/properties/count":{"post":{"tags":["Search","Partner API"],"summary":"Count search results","description":"This API allows you to count the results for a search. You can search for real-estate properties in Germany with a variety of search filter parameters like the designated usage, the property area, the building potential and many more. This API searches in a database of 62M properties and buildings and returns the number of results matching your search request.","operationId":"properties_count_api_search_properties_count_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchCountResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"bearer":[]}]}},"/api/search/properties/results":{"post":{"tags":["Search","Partner API"],"summary":"Searches properties and buildings","description":"This API allows you to search for real-estate properties in Germany with a variety of search filter parameters like the designated usage, the property area, the building potential and many more. The API searches in a database of 62M properties and buildings and returns a paginated list of results matching your search request. It requires authentication with 'search' permission to get full result list, the free version only returns 10 results.","operationId":"properties_results_api_search_properties_results_post","security":[{"bearer":[]}],"parameters":[{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"exclusiveMinimum":0,"description":"The number of results per page","default":20,"title":"Page Size"},"description":"The number of results per page"},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The page to load, use next_page from response","title":"Page"},"description":"The page to load, use next_page from response"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchAnalysisPaginatedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/search/properties/result-points":{"post":{"tags":["Search","Partner API"],"summary":"Fetch coordinates for search results","description":"This API allows you to fetch the geo-coordinates for the results for a search. You can search for real-estate properties in Germany with a variety of search filter parameters like the designated usage, the property area, the building potential and many more. This API searches in a database of 25M properties and buildings and returns a list of points where each are in the following format: [lat, lng, short_potential_label, property_identifier].","operationId":"properties_points_api_search_properties_result_points_post","security":[{"bearer":[]}],"parameters":[{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":5000,"exclusiveMinimum":0,"description":"The number of results per page","default":20,"title":"Page Size"},"description":"The number of results per page"},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The page to load, use next_page from response","title":"Page"},"description":"The page to load, use next_page from response"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchAnalysisPotentialPointsPaginatedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/search/regions":{"get":{"tags":["Search","Partner API"],"summary":"Search for regions","description":"This API allows you to fetch a list of regions matching your search criteria. It returns a maximum of 20 results.","operationId":"regions_search_router_api_search_regions_get","security":[{"bearer":[]}],"parameters":[{"name":"region_type","in":"query","required":true,"schema":{"type":"array","items":{"enum":["state","administrative_district","administrative_region","county","municipal_association","municipality"],"type":"string"},"description":"The region's type in English","min_items":1,"title":"Region Type"},"description":"The region's type in English","examples":{"state":{"value":["state"]},"administrative_district":{"value":["administrative_district"]},"administrative_region":{"value":["administrative_region"]},"county":{"value":["county"]},"municipal_association":{"value":["municipal_association"]},"municipality":{"value":["municipality"]}}},{"name":"name","in":"query","required":true,"schema":{"type":"string","minLength":3,"description":"The regions name which is matched case insensitive as a substring","title":"Name"},"description":"The regions name which is matched case insensitive as a substring","examples":{"Berlin":{"value":"Berlin"},"North Rhine Whestphalia":{"value":"North Rhine Whestphalia"},"Münster":{"value":"Münster"}}},{"name":"filter_duplicates","in":"query","required":false,"schema":{"type":"boolean","description":"Set to True to avoid duplicated results of different types. If the name matches 2 or more results that are related (e.g.a municipality that belongs to a county), then only the smallest unit (e.g. the municipality) will be returned if this parameter is True.","default":true,"title":"Filter Duplicates"},"description":"Set to True to avoid duplicated results of different types. If the name matches 2 or more results that are related (e.g.a municipality that belongs to a county), then only the smallest unit (e.g. the municipality) will be returned if this parameter is True."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRegionPaginatedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/images/map/{map_style}":{"get":{"tags":["Map and Building Images","Partner API"],"summary":"Generate static map image","description":"Generate a static map image with optional property parcels and buildings overlay. Supports authentication via API Key, JWT, or Download Token (X-Download-Token header). If property_identifier or building_identifier is provided, the static-maps service will automatically fetch the geometries and overlay them on the map.","operationId":"generate_static_map_api_images_map__map_style__get","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"map_style","in":"path","required":true,"schema":{"enum":["dark","light","satellite","print","blackplan"],"type":"string","title":"Map Style"}},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":90,"minimum":-90},{"type":"null"}],"description":"Center latitude coordinate in EPSG 4326","title":"Lat"},"description":"Center latitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":51.9909653}}},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":180,"minimum":-180},{"type":"null"}],"description":"Center longitude coordinate in EPSG 4326","title":"Lng"},"description":"Center longitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":7.5918667}}},{"name":"zoom","in":"query","required":false,"schema":{"type":"number","maximum":22,"minimum":0,"description":"Map zoom level","default":18,"title":"Zoom"},"description":"Map zoom level","examples":{"18":{"value":18}}},{"name":"north","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":90,"minimum":-90},{"type":"null"}],"description":"North bound latitude coordinate in EPSG 4326","title":"North"},"description":"North bound latitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße":{"value":51.9915}}},{"name":"east","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":180,"minimum":-180},{"type":"null"}],"description":"East bound longitude coordinate in EPSG 4326","title":"East"},"description":"East bound longitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße":{"value":7.5928}}},{"name":"south","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":90,"minimum":-90},{"type":"null"}],"description":"South bound latitude coordinate in EPSG 4326","title":"South"},"description":"South bound latitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße":{"value":51.9903}}},{"name":"west","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":180,"minimum":-180},{"type":"null"}],"description":"West bound longitude coordinate in EPSG 4326","title":"West"},"description":"West bound longitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße":{"value":7.591}}},{"name":"width","in":"query","required":false,"schema":{"type":"integer","maximum":2160,"exclusiveMinimum":0,"description":"Image width in pixels","default":1200,"title":"Width"},"description":"Image width in pixels"},{"name":"height","in":"query","required":false,"schema":{"type":"integer","maximum":2160,"exclusiveMinimum":0,"description":"Image height in pixels","default":800,"title":"Height"},"description":"Image height in pixels"},{"name":"rotate","in":"query","required":false,"schema":{"type":"number","maximum":360,"minimum":-360,"description":"Clockwise rotation in degrees","default":0,"title":"Rotate"},"description":"Clockwise rotation in degrees"},{"name":"pitch","in":"query","required":false,"schema":{"type":"number","maximum":90,"minimum":0,"description":"Camera pitch in degrees","default":0,"title":"Pitch"},"description":"Camera pitch in degrees"},{"name":"property_identifier","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Parcel identifier to highlight on the map","title":"Property Identifier"},"description":"Parcel identifier to highlight on the map","examples":{"Münster Fernholzstraße 33":{"value":"DENW49AL00009b0v"}}},{"name":"building_identifier","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Building identifier(s) to highlight on the map","title":"Building Identifier"},"description":"Building identifier(s) to highlight on the map","examples":{"Münster Fernholzstraße 33":{"value":["DENW49AL00009XTV"]}}},{"name":"padding","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":0,"description":"Padding in pixels around the map content","default":50,"title":"Padding"},"description":"Padding in pixels around the map content"},{"name":"min_zoom","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":22,"minimum":1},{"type":"null"}],"description":"Minimum zoom level constraint","title":"Min Zoom"},"description":"Minimum zoom level constraint"},{"name":"max_zoom","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":22,"minimum":1},{"type":"null"}],"description":"Maximum zoom level constraint","title":"Max Zoom"},"description":"Maximum zoom level constraint"},{"name":"layer","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"enum":["actualusage","grz1","gfz","bmz","ai_potential","heights","origin","construction_year","on_roof_pv_potential","energy_demand"],"type":"string"}},{"type":"null"}],"description":"Data layer(s) to display on the map","title":"Layer"},"description":"Data layer(s) to display on the map","examples":{"heights":{"value":"heights"},"actualusage":{"value":"actualusage"}}}],"responses":{"200":{"description":"Static map image","content":{"application/json":{"schema":{}},"image/png":{}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"The request contains invalid (user) data. Which fields are invalid is stored under `errors`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}}}}},"/api/cadastral/regions":{"get":{"tags":["Cadastral","Partner API"],"summary":"Fetch High detailed regional geometries as GeoJSON","description":"Fetch selected regions with high level detail. If authentication is provided the response will contain a `is_subscribed` flag for each region. Output is not filtered by state subscription.","operationId":"get_cadastral_regions_api_cadastral_regions_get","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"top","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Top bound latitude coordinate in EPSG 4326","title":"Top"},"description":"Top bound latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.991191}}},{"name":"left","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Left bound longitude coordinate in EPSG 4326","title":"Left"},"description":"Left bound longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.591723}}},{"name":"bottom","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Bottom bound latitude coordinate in EPSG 4326","title":"Bottom"},"description":"Bottom bound latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.990776}}},{"name":"right","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Right bound longitude coordinate in EPSG 4326","title":"Right"},"description":"Right bound longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.592227}}},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":90,"minimum":-90},{"type":"null"}],"description":"Center latitude coordinate in EPSG 4326","title":"Lat"},"description":"Center latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.9909653}}},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":180,"minimum":-180},{"type":"null"}],"description":"Center longitude coordinate in EPSG 4326","title":"Lng"},"description":"Center longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.5918667}}},{"name":"autoshrink","in":"query","required":false,"schema":{"type":"boolean","description":"If set the bounding box will be shrunk silently if too large. Otherwise a `bounding-box-too-large` error is responded.","default":false,"title":"Autoshrink"},"description":"If set the bounding box will be shrunk silently if too large. Otherwise a `bounding-box-too-large` error is responded."},{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"},{"name":"region_type","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"enum":["state","administrative_district","administrative_region","county","municipal_association","municipality"],"type":"string"}},{"type":"null"}],"description":"The syte's internal translated region type","title":"Region Type"},"description":"The syte's internal translated region type","examples":{"state":{"value":["state"]},"administrative_district":{"value":["administrative_district"]},"administrative_region":{"value":["administrative_region"]},"county":{"value":["county"]},"municipal_association":{"value":["municipal_association"]},"municipality":{"value":["municipality"]}}},{"name":"region_identifier","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string","minLength":2,"maxLength":14}},{"type":"null"}],"description":"Region Identifier (ARS)","title":"Region Identifier"},"description":"Region Identifier (ARS)","examples":{"Münster":{"value":["055150000"]},"Berlin":{"value":["11"]}}},{"name":"population_min","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Filter regions by a minimum population","title":"Population Min"},"description":"Filter regions by a minimum population","examples":{"1000":{"value":1000}}},{"name":"population_max","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Filter regions by a maximum population","title":"Population Max"},"description":"Filter regions by a maximum population","examples":{"500000":{"value":500000}}},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","description":"If set a download will be started for the requested resource","default":false,"title":"Download"},"description":"If set a download will be started for the requested resource","examples":{"True":{"value":true}}},{"name":"format","in":"query","required":false,"schema":{"enum":["geojson","dxf"],"type":"string","description":"The format of the download","default":"geojson","title":"Format"},"description":"The format of the download","examples":{"geojson":{"value":"geojson"},"dxf":{"value":"dxf"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegionCollection"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/cadastral/region-bounding-box":{"get":{"tags":["Cadastral","Partner API"],"summary":"Fetch the bounding box for all matching regions","description":"Similar to /api/cadastral/regions and /api/vector-tiles/regions but only returns the bounding box of the matching regions.","operationId":"get_regions_bbox_api_cadastral_region_bounding_box_get","security":[{"bearer":[]}],"parameters":[{"name":"restrict_to_subscription","in":"query","required":false,"schema":{"type":"boolean","description":"If set to true only the bounding box for subscribed regions will be returned.","default":false,"title":"Restrict To Subscription"},"description":"If set to true only the bounding box for subscribed regions will be returned."},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","description":"If set a download will be started for the requested resource","default":false,"title":"Download"},"description":"If set a download will be started for the requested resource"},{"name":"region_type","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"enum":["state","administrative_district","administrative_region","county","municipal_association","municipality"],"type":"string"}},{"type":"null"}],"description":"The syte's internal translated region type","title":"Region Type"},"description":"The syte's internal translated region type","examples":{"state":{"value":["state"]},"administrative_district":{"value":["administrative_district"]},"administrative_region":{"value":["administrative_region"]},"county":{"value":["county"]},"municipal_association":{"value":["municipal_association"]},"municipality":{"value":["municipality"]}}},{"name":"region_identifier","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string","minLength":2,"maxLength":14}},{"type":"null"}],"description":"Region Identifier (ARS)","title":"Region Identifier"},"description":"Region Identifier (ARS)","examples":{"Münster":{"value":["055150000"]},"Berlin":{"value":["11"]}}},{"name":"population_min","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Filter regions by a minimum population","title":"Population Min"},"description":"Filter regions by a minimum population","examples":{"1000":{"value":1000}}},{"name":"population_max","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Filter regions by a maximum population","title":"Population Max"},"description":"Filter regions by a maximum population","examples":{"500000":{"value":500000}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegionBoundingBox"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/project-calculator/calculate":{"get":{"tags":["Project Calculator","Partner API"],"summary":"Retrieves a initialized project calculation for a property","description":"The calculation is initialized with the property's data, predictions, pricehubble api data. Not all fields are filled out. The calculation is not stored by this endpoint.","operationId":"get_initial_calculation_api_project_calculator_calculate_get","security":[{"bearer":[]}],"parameters":[{"name":"parcel_identifier","in":"query","required":true,"schema":{"type":"string","description":"Parcel identifier, property identifier or custom property identifier","title":"Parcel Identifier"},"description":"Parcel identifier, property identifier or custom property identifier","examples":{"Münster Fernholzstraße 33":{"value":"DENW49AL00009b0v"},"Berlin Dennewitzstraße 2":{"value":"DEBE01YYK0002NvW"},"München Isartalstraße 30":{"value":"DEBYvAAAAABTeGhf"},"Frankfurt Stralsunder Straße 10":{"value":"DEHE06200001eAaR"},"Hamburg Rothenbaumchaussee 199":{"value":"DEHHALKAV0000wN6"},"Kiel Lutherstraße 9":{"value":"DESHPDHK0001ub9p"},"Bad Sulza Gartenstraße 7":{"value":"DETHL51P00000i8T"},"Werdau Weißenbrunn 3a":{"value":"DESNALK0f0009giL"}}},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":90,"minimum":-90},{"type":"null"}],"description":"Parcel latitude coordinate in EPSG 4326","title":"Lat"},"description":"Parcel latitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":51.9909653},"Berlin Dennewitzstraße 2":{"value":52.4996479},"München Isartalstraße 30":{"value":48.1206001},"Frankfurt Stralsunder Straße 10":{"value":50.1294342},"Hamburg Rothenbaumchaussee 199":{"value":53.5784523},"Kiel Lutherstraße 9":{"value":54.3151818},"Bad Sulza Gartenstraße 7":{"value":51.0860736},"Werdau Weißenbrunn 3a":{"value":50.7053124}}},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":180,"minimum":-180},{"type":"null"}],"description":"Parcel longitude coordinate in EPSG 4326","title":"Lng"},"description":"Parcel longitude coordinate in EPSG 4326","examples":{"Münster Fernholzstraße 33":{"value":7.5918667},"Berlin Dennewitzstraße 2":{"value":13.3698984},"München Isartalstraße 30":{"value":11.5606595},"Frankfurt Stralsunder Straße 10":{"value":8.6702905},"Hamburg Rothenbaumchaussee 199":{"value":9.9883648},"Kiel Lutherstraße 9":{"value":10.1169388},"Bad Sulza Gartenstraße 7":{"value":11.6291221},"Werdau Weißenbrunn 3a":{"value":12.4199148}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoredProjectCalculationDetailedResponse"}}}},"400":{"description":"The stored calculation is invalid and cannot be processed or used as it is","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfitCalculatorError"}}}},"403":{"description":"You are not allowed to access this resource.","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"The stored calculation is invalid and cannot be processed or used as it is","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfitCalculatorError"}}}}}}},"/api/project-calculator/dossier/{uuid}":{"get":{"tags":["Project Calculator","Partner API"],"summary":"Creates a pricehubble dossier for an existing calculation","description":"Creates a pricehubble dossier that is valid for 3 months. The valuation for the property is added into it for the given method type. Responds with the dossier share url. The calculation needs to be linked to a property.","operationId":"get_pricehubble_dossier_url_api_project_calculator_dossier__uuid__get","security":[{"bearer":[]}],"parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The project calculation identifier to retrieve","title":"Uuid"},"description":"The project calculation identifier to retrieve","examples":{"uuid":{"value":"f3b5c2a0-4b1b-4b1b-8b1b-8b1b1b1b1b1b"}}},{"name":"calculation_method","in":"query","required":true,"schema":{"enum":["current_stock","redensification_and_refurbishment","new_building"],"type":"string","description":"One of current_stock, redensification_and_refurbishment, new_building","title":"Calculation Method"},"description":"One of current_stock, redensification_and_refurbishment, new_building"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DossierShareUrlResponse"}}}},"400":{"description":"Value is out of bounds for pricehubble API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceHubbleValueOutOfBounds"}}}},"403":{"description":"You are not allowed to access this resource.","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/project-calculator/property-dossier/{parcel_identifier}":{"get":{"tags":["Project Calculator","Partner API"],"summary":"Creates a pricehubble dossier for a property and calculation method","description":"Creates a pricehubble dossier that is valid for 3 months. The valuation for the property is added into it for the given method type. Responds with the dossier share url.","operationId":"get_property_dossier_url_api_project_calculator_property_dossier__parcel_identifier__get","security":[{"bearer":[]}],"parameters":[{"name":"parcel_identifier","in":"path","required":true,"schema":{"type":"string","description":"Parcel identifier, property identifier or custom property identifier","title":"Parcel Identifier"},"description":"Parcel identifier, property identifier or custom property identifier","examples":{"parcel_identifier":{"value":"DENW49AL00009b0v"}}},{"name":"calculation_method","in":"query","required":false,"schema":{"enum":["current_stock","redensification_and_refurbishment","new_building"],"type":"string","description":"One of current_stock, redensification_and_refurbishment, new_building","default":"current_stock","title":"Calculation Method"},"description":"One of current_stock, redensification_and_refurbishment, new_building"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DossierShareUrlResponse"}}}},"400":{"description":"Value is out of bounds for pricehubble API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceHubbleValueOutOfBounds"}}}},"403":{"description":"You are not allowed to access this resource.","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/project-calculator/prices":{"get":{"tags":["Project Calculator","Partner API"],"summary":"Reevaluate the pricehubble valuation for a given stored calculation","description":"Reevaluate the pricehubble valuation for a given stored calculation using pricehubble valuation api. This will not update the stored calculation. The response will contain the rent and sale prices for all calculation methods","operationId":"get_calculation_updated_prices_api_project_calculator_prices_get","security":[{"bearer":[]}],"parameters":[{"name":"calculation_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","description":"The project calculation identifier to retrieve","title":"Calculation Id"},"description":"The project calculation identifier to retrieve","examples":{"uuid":{"value":"f3b5c2a0-4b1b-4b1b-8b1b-8b1b1b1b1b1b"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceUpdateResponse"}}}},"400":{"description":"Value is out of bounds for pricehubble API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceHubbleValueOutOfBounds"}}}},"403":{"description":"You are not allowed to access this resource.","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/cadastral/zoning-plans":{"get":{"tags":["Cadastral","Partner API"],"summary":"Get Zoning Plan areas as GeoJSON","description":"Query Zoning Plans in a given bounding box. There are 3 types of geometries which can be `zoning_plan`, `buildable_area` and `partial_area`. Returns a GeoJSON feature collection with the 3 types of geometries mixed in the features attribute. Results outside of the subscription state are excluded. If the format is not 'geojson' only the geometries are returned.","operationId":"get_zoning_plan_as_geojson_api_cadastral_zoning_plans_get","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"top","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Top bound latitude coordinate in EPSG 4326","title":"Top"},"description":"Top bound latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.991191}}},{"name":"left","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Left bound longitude coordinate in EPSG 4326","title":"Left"},"description":"Left bound longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.591723}}},{"name":"bottom","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"description":"Bottom bound latitude coordinate in EPSG 4326","title":"Bottom"},"description":"Bottom bound latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.990776}}},{"name":"right","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"description":"Right bound longitude coordinate in EPSG 4326","title":"Right"},"description":"Right bound longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.592227}}},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":90,"minimum":-90},{"type":"null"}],"description":"Center latitude coordinate in EPSG 4326","title":"Lat"},"description":"Center latitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":51.9909653}}},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":180,"minimum":-180},{"type":"null"}],"description":"Center longitude coordinate in EPSG 4326","title":"Lng"},"description":"Center longitude coordinate in EPSG 4326","examples":{"Münster Nord":{"value":7.5918667}}},{"name":"autoshrink","in":"query","required":false,"schema":{"type":"boolean","description":"If set the bounding box will be shrunk silently if too large. Otherwise a `bounding-box-too-large` error is responded.","default":false,"title":"Autoshrink"},"description":"If set the bounding box will be shrunk silently if too large. Otherwise a `bounding-box-too-large` error is responded."},{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","description":"If set a download will be started for the requested resource","default":false,"title":"Download"},"description":"If set a download will be started for the requested resource","examples":{"True":{"value":true}}},{"name":"format","in":"query","required":false,"schema":{"enum":["geojson","dxf"],"type":"string","description":"The format of the download","default":"geojson","title":"Format"},"description":"The format of the download","examples":{"geojson":{"value":"geojson"},"dxf":{"value":"dxf"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoningPlanCollection"}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"You are not allowed to access this resource.","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/cadastral/parcel-zoning-plans":{"get":{"tags":["Cadastral","Partner API"],"summary":"Get Zoning Plans belonging to a parcel as GeoJSON","description":"Query zoning plans for the given parcels. The result will consist of all zoning plans where any parcel geometry intersects. There are 3 types of geometries which can be `zoning_plan`, `buildable_area` and `partial_area`. Returns a GeoJSON feature collection with the 3 types of geometries mixed in the features attribute. Results outside of the subscription state are excluded. If the format is not 'geojson' only the geometries are returned.","operationId":"get_parcel_zoning_plans_as_geojson_api_cadastral_parcel_zoning_plans_get","security":[{"bearer":[]},{"download_token":[]}],"parameters":[{"name":"parcel_identifier","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"},"maxItems":15,"description":"Parcel identifier. Can be given multiple times.","title":"Parcel Identifier"},"description":"Parcel identifier. Can be given multiple times.","examples":{"Münster Fernholzstraße 33 + 35":{"value":["DENW49AL00009b0v","DENW49AL00009aWv","DENW49AL00009aWw"]}}},{"name":"download_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The download token for signed URL downloads","title":"Download Token"},"description":"The download token for signed URL downloads"},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","description":"If set a download will be started for the requested resource","default":false,"title":"Download"},"description":"If set a download will be started for the requested resource","examples":{"True":{"value":true}}},{"name":"format","in":"query","required":false,"schema":{"enum":["geojson","dxf"],"type":"string","description":"The format of the download","default":"geojson","title":"Format"},"description":"The format of the download","examples":{"geojson":{"value":"geojson"},"dxf":{"value":"dxf"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoningPlanCollection"}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"You are not allowed to access this resource.","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/zoning-plan-search":{"post":{"tags":["Agentic Buildability Search","Partner API"],"summary":"Start a zoning plan search","description":"Starts a zoning plan search for a property in the states of the user's subscription. The search runs in the background for several minutes, poll `GET /api/zoning-plan-search/{zoning_plan_search_id}` for its status and result. Successful searches count toward the monthly quota of the user, see `GET /api/zoning-plan-search/quota`","operationId":"start_zoning_plan_search_api_zoning_plan_search_post","security":[{"bearer":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoningPlanSearchStartRequest","description":"The property to search the zoning plan for"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoningPlanSearchResponse"}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"You are not allowed to access this resource.","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"429":{"description":"The user reached a zoning plan search limit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoningPlanSearchLimitError"}}}},"502":{"description":"The agentic search service failed or could not be reached","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgenticSearchServiceError"}}}},"503":{"description":"The agentic search service is at capacity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgenticSearchServiceError"}}}}}},"get":{"tags":["Agentic Buildability Search","Partner API"],"summary":"List zoning plan searches","description":"Lists the zoning plan searches of the user, newest first, without their status and result","operationId":"list_zoning_plan_searches_api_zoning_plan_search_get","security":[{"bearer":[]}],"parameters":[{"name":"property_identifier","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The property, parcel or custom property identifier the zoning plan searches must relate to. `none` returns only the zoning plan searches of no project","title":"Property Identifier"},"description":"The property, parcel or custom property identifier the zoning plan searches must relate to. `none` returns only the zoning plan searches of no project","examples":{"PROPERTY-DENW16AL00000PnI":{"value":"PROPERTY-DENW16AL00000PnI"},"none":{"value":"none"}}},{"name":"project_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Return only the zoning plan searches belonging to this project","title":"Project Id"},"description":"Return only the zoning plan searches belonging to this project","examples":{"project_id":{"value":"0b6f0d4e-5f4a-4c43-9d55-3f1f6a1c2e7b"}}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","maximum":100000,"minimum":0,"description":"The page number to retrieve starting from 0","default":0,"title":"Page"},"description":"The page number to retrieve starting from 0","examples":{"0":{"value":0}}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"The number of results per page","default":20,"title":"Page Size"},"description":"The number of results per page","examples":{"20":{"value":20}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoningPlanSearchPaginatedResponse"}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/zoning-plan-search/quota":{"get":{"tags":["Agentic Buildability Search","Partner API"],"summary":"Get the zoning plan search quota","description":"Returns the monthly zoning plan search quota of the user. Searches with the status `succeeded` or `partial` count toward it, and `queued` or `running` searches count until they finish","operationId":"get_zoning_plan_search_quota_api_zoning_plan_search_quota_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoningPlanSearchQuota"}}}},"502":{"description":"The agentic search service failed or could not be reached","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgenticSearchServiceError"}}}},"503":{"description":"The agentic search service is at capacity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgenticSearchServiceError"}}}}},"security":[{"bearer":[]}]}},"/api/zoning-plan-search/{zoning_plan_search_id}":{"get":{"tags":["Agentic Buildability Search","Partner API"],"summary":"Get a zoning plan search","description":"Given the `zoning_plan_search_id`, returns the zoning plan search with its status while it runs and its result once it is done","operationId":"get_zoning_plan_search_api_zoning_plan_search__zoning_plan_search_id__get","security":[{"bearer":[]}],"parameters":[{"name":"zoning_plan_search_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The zoning plan search identifier","title":"Zoning Plan Search Id"},"description":"The zoning plan search identifier","examples":{"uuid":{"value":"4d2c8a0e-8f3b-4a8e-a1a5-2b7e9f0c6d11"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoningPlanSearchResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"502":{"description":"The agentic search service failed or could not be reached","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgenticSearchServiceError"}}}},"503":{"description":"The agentic search service is at capacity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgenticSearchServiceError"}}}}}}},"/api/zoning-plan-search/{zoning_plan_search_id}/push-subscription":{"put":{"tags":["Agentic Buildability Search","Partner API"],"summary":"Subscribe a browser to the end of a zoning plan search","description":"Stores a browser push subscription that gets one push when the search ends. Sending the same subscription again changes nothing. For a search that has already ended, we store nothing and answer 409","operationId":"subscribe_to_zoning_plan_search_api_zoning_plan_search__zoning_plan_search_id__push_subscription_put","security":[{"bearer":[]}],"parameters":[{"name":"zoning_plan_search_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The zoning plan search identifier","title":"Zoning Plan Search Id"},"description":"The zoning plan search identifier","examples":{"uuid":{"value":"4d2c8a0e-8f3b-4a8e-a1a5-2b7e9f0c6d11"}}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushSubscription","description":"The push subscription of the browser"}}}},"responses":{"204":{"description":"Successful Response"},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The zoning plan search has already ended"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/renovate/creation-inputs":{"post":{"tags":["Renovation Plans","Partner API"],"summary":"Get the default building config and existing measures for a renovation","description":"Loads the default building configuration and existing measures for a given property and group of buildings which can be used as an input in the renovation creation","operationId":"get_creation_inputs_api_renovate_creation_inputs_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenovationCreationInputsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenovationCreationInputsResponse"}}}},"400":{"description":"We cannot compute the renovation for the given buildings because they are missing either LoD2 data or a construction year","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenovateError"}}}},"403":{"description":"You are not allowed to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"bearer":[]}]}},"/api/renovate/":{"post":{"tags":["Renovation Plans","Partner API"],"summary":"Create and store a renovation","description":"Creates and calculates a renovation for a given property and group of buildings and stores it as a stored item","operationId":"create_renovation_stored_item_api_renovate__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenovationCreationRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenovationDetailedResponse"}}}},"400":{"description":"We cannot compute the renovation for the given buildings because they are missing either LoD2 data or a construction year","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenovateError"}}}},"403":{"description":"You are not allowed to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"bearer":[]}]}},"/api/renovate/{uuid}":{"put":{"tags":["Renovation Plans","Partner API"],"summary":"Update and recalculate a renovation","description":"Recalculate a renovation for a given property and group of buildings by changing input values.\n        The corresponding stored item with the given id will be updated. Returns the updated renovation.","operationId":"update_renovation_api_renovate__uuid__put","security":[{"bearer":[]}],"parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The Renovation identifier to retrieve","title":"Uuid"},"description":"The Renovation identifier to retrieve","examples":{"uuid":{"value":"f3b5c2a0-4b1b-4b1b-8b1b-8b1b1b1b1b1b"}}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenovationInputRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenovationDetailedResponse"}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"You are not allowed to access this resource.","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/renovate/{uuid}/valuation":{"get":{"tags":["Renovation Plans","Partner API"],"summary":"Get valuation selling prices for an existing stored renovation","description":"Get the valuation selling prices for an existing stored renovation. This endpoint uses the PriceHubble API\n        to get the selling prices for the building before and after the renovation.","operationId":"get_renovation_valuation_api_renovate__uuid__valuation_get","security":[{"bearer":[]}],"parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The Renovation identifier to valuate","title":"Uuid"},"description":"The Renovation identifier to valuate","examples":{"uuid":{"value":"f3b5c2a0-4b1b-4b1b-8b1b-8b1b1b1b1b1b"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenovationValuationResponse"}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"You are not allowed to access this resource.","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"429":{"description":"PriceHubble rejected the valuation request, e.g. quota exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"502":{"description":"PriceHubble returned no valuation for the property","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/renovate/recommended_measures":{"post":{"tags":["Renovation Plans","Partner API"],"summary":"Get measure recommendations with their costs and energy savings","description":"Get recommended measures for a property and one of its buildings combination. This endpoint will test all\n        possible renovation measure combinations and return the progressively best ones. The criteria for defining the\n        best is achieved by maximizing the ratio `end_energy_savings_percentage / investment_cost`. The results are\n        sorted by cost / savings ratio in ascending order. This endpoint does not persist any renovation.","operationId":"get_renovation_options_api_renovate_recommended_measures_post","security":[{"bearer":[]}],"parameters":[{"name":"include_subsidies","in":"query","required":false,"schema":{"type":"boolean","description":"If true the recommended measure choices will take the subsidies into consideration","default":true,"title":"Include Subsidies"},"description":"If true the recommended measure choices will take the subsidies into consideration"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenovationRecommendedMeasuresRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenovationRecommendedMeasuresResponse"}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"You are not allowed to access this resource.","content":{"application/json":{"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/renovate/energy_demand":{"post":{"tags":["Renovation Plans","Partner API"],"summary":"Get the energy demand for a given property and group of buildings","description":"Compute the existing energy demand details for a given property and group of buildings. Computes renovate's\n        energy demand details that is also accessible in the output.existing_state of a normal stored renovation.\n        This endpoint does not create or store any resources and can be used to get the energy demand for a\n        existing or custom building configuration.","operationId":"get_energy_demand_api_renovate_energy_demand_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenovationEnergyDemandRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenovationOutputState"}}}},"400":{"description":"The request cannot be processed because the request parameters are not supported, e.g. the requested bounding box area is too small or location is outside supported area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"You are not allowed to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"type":"authentication-error","message":"You are not allowed to access this resource","reason":"insufficient_permission"}}}},"404":{"description":"The requested resource cannot be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"type":"not-found-error","message":"The requested resource was not found","reason":"resource_not_found"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"bearer":[]}]}},"/api/download/token":{"get":{"tags":["Download","Partner API"],"summary":"Get Download Token","description":"Used to get the download token supported for some endpoints, mostly cadastral ones. The download token allow users to download files without submitting authentication headers. The issued token will be valid for 1:00:00 after the request. Use the URL parameter `download_token`.","operationId":"get_download_token_api_download_token_get","security":[{"bearer":[]}],"parameters":[{"name":"expiration_time","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expiration Time","description":"The expiration time in seconds."},"description":"The expiration time in seconds.","examples":{"180":{"value":180}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadRequestResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"ConcealedBuildingCollection":{"properties":{"type":{"type":"string","const":"FeatureCollection","title":"Type","default":"FeatureCollection"},"features":{"items":{"anyOf":[{"$ref":"#/components/schemas/ConcealedBuilding"},{"$ref":"#/components/schemas/Building"}]},"type":"array","title":"Features"}},"type":"object","required":["features"],"title":"ConcealedBuildingCollection"},"ErrorResponse":{"properties":{"type":{"type":"string","enum":["bounding-box-too-large","bounding-box-inverted","area-too-small","area-too-large","property-not-yet-processed","parcel-not-found","out-of-supported-area","intersecting-states-area","no-property-for-parcel","validation-error","authentication-error","not-found-error","pricehubble-value-out-of-bounds","pricehubble-unavailable","too-many-buildings-in-bbox","profit-calculator-error","profit-calculator-missing-potential-error","renovate-error","pdf-report-service-error","currently-unsupported-feature","unsupported-operation","empty-property-error","missing-residential-building-type","gemini-visualization-error","ai-visualization-rate-limit","agentic-search-service-error","zoning-plan-search-quota-exceeded","zoning-plan-search-quota-pending","zoning-plan-search-parallel-limit-exceeded"],"title":"Type","description":"Error type identifier.","examples":["out-of-supported-area"]},"message":{"type":"string","title":"Message","description":"Human-readable English description of the error.","examples":["The geometry is out of any supported area"]}},"type":"object","required":["type","message"],"title":"ErrorResponse","example":{"message":"The geometry is out of any supported area","type":"out-of-supported-area"}},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ConcealedBuilding":{"properties":{"type":{"type":"string","const":"Feature","title":"Type","default":"Feature"},"geometry":{"anyOf":[{"$ref":"#/components/schemas/Polygon"},{"$ref":"#/components/schemas/MultiPolygon"}],"title":"Geometry"},"properties":{"$ref":"#/components/schemas/ConcealedBuildingProperties"},"id":{"type":"string","title":"Id"}},"type":"object","required":["geometry","properties","id"],"title":"ConcealedBuilding"},"SurfaceTypeStr":{"type":"string","enum":["RoofSurface","WallSurface","GroundSurface","ClosureSurface"],"title":"SurfaceTypeStr","description":"Surface type as string for the API.\n\nThis is not the same as in the DB."},"CRSOption":{"type":"integer","enum":[25832,25833,4326,3857],"title":"CRSOption","description":"Coordinate reference codes available to set as parameter."},"BuildingSurfaceResponse":{"properties":{"type":{"type":"string","const":"FeatureCollection","title":"Type","default":"FeatureCollection"},"features":{"items":{"$ref":"#/components/schemas/BuildingSurface"},"type":"array","title":"Features"},"crs":{"anyOf":[{"$ref":"#/components/schemas/JsonCRS"},{"type":"null"}]}},"type":"object","required":["features","crs"],"title":"BuildingSurfaceResponse"},"ConcealedParcelCollection":{"properties":{"type":{"type":"string","const":"FeatureCollection","title":"Type","default":"FeatureCollection"},"features":{"items":{"$ref":"#/components/schemas/ConcealedParcel"},"type":"array","title":"Features"}},"type":"object","required":["features"],"title":"ConcealedParcelCollection"},"ConcealedParcel":{"properties":{"type":{"type":"string","const":"Feature","title":"Type","default":"Feature"},"geometry":{"anyOf":[{"$ref":"#/components/schemas/Polygon"},{"$ref":"#/components/schemas/MultiPolygon"}],"title":"Geometry"},"properties":{"$ref":"#/components/schemas/ConcealedParcelProperties"},"id":{"type":"string","title":"Id"}},"type":"object","required":["geometry","properties","id"],"title":"ConcealedParcel"},"CustomProperty":{"properties":{"parcel_identifiers":{"items":{"type":"string"},"type":"array","minItems":1,"title":"Parcel Identifiers","description":"List of parcel identifiers to combine into a property","examples":[["DENW49AL00009aXu","DENW49AL00009aYX","DENW49AL00009aZz"]]},"building_identifiers":{"items":{"type":"string"},"type":"array","minItems":0,"title":"Building Identifiers","description":"List of building identifiers to combine into a property","examples":[["DENW49AL00009XDi","DENW49AL00009XDj"]]}},"type":"object","required":["parcel_identifiers"],"title":"CustomProperty"},"ConcealedProperty":{"properties":{"type":{"type":"string","const":"Feature","title":"Type","default":"Feature"},"geometry":{"anyOf":[{"$ref":"#/components/schemas/Polygon"},{"$ref":"#/components/schemas/MultiPolygon"}],"title":"Geometry"},"properties":{"$ref":"#/components/schemas/ConcealedPropertyProperties"},"id":{"type":"string","title":"Id"}},"type":"object","required":["geometry","properties","id"],"title":"ConcealedProperty"},"ConcealedPropertyCollection":{"properties":{"type":{"type":"string","const":"FeatureCollection","title":"Type","default":"FeatureCollection"},"features":{"items":{"anyOf":[{"$ref":"#/components/schemas/ConcealedProperty"},{"$ref":"#/components/schemas/Property"}]},"type":"array","title":"Features"}},"type":"object","required":["features"],"title":"ConcealedPropertyCollection"},"PropertyZoningPlanResponse":{"properties":{"max_grz":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Grz","description":"Max allowed GRZ (Grundflaechenzahl) - site coverage ratio","examples":[0.4]},"max_gfz":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Gfz","description":"Max allowed GFZ (Geschossflaechenzahl) - floor area ratio","examples":[1.2]},"max_bmz":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Bmz","description":"Max allowed BMZ (Baumassenzahl) - building mass ratio (volume/area)","examples":[2]},"max_entire_floors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Entire Floors","description":"Max allowed entire floors","examples":[3]},"max_residential_units":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Residential Units","description":"Max allowed residential units","examples":[8]},"max_height":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Height","description":"Max allowed building height in meters","examples":[12.5]},"max_eaves_height":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Eaves Height","description":"Max allowed eaves height in meters","examples":[9]},"usage_allowed":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Usage Allowed","description":"Allowed usage type in the area","examples":["GE"]},"coverage_types":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Coverage Types","description":"List of allowed coverage types. Possible values: 'closed', 'open-adjoining-houses', 'open-detached-house', 'open-semi-detached-house'.","examples":[["open-detached-house"]]},"format":{"type":"string","enum":["xplan","document"],"title":"Format","description":"Format of the zoning plan data","default":"xplan","examples":["document"]},"min_entire_floors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Min Entire Floors","description":"Min required entire floors","examples":[1]},"zoning_plan_identifiers":{"items":{"type":"string"},"type":"array","title":"Zoning Plan Identifiers","description":"List of zoning plan identifiers that apply to the property","examples":[["GML_123","GML_456"]]},"references":{"items":{"$ref":"#/components/schemas/ZoningPlanReference"},"type":"array","title":"References","description":"References to zoning plan documents","examples":[[{"name":"Neue Schule Fruerlund","url":"https://www.flensburg.de/bebauungsplaene/307.pdf"}]]},"property_identifier":{"type":"string","title":"Property Identifier","description":"The property identifier this zoning plan information belongs to","examples":["PROPERTY-DENW49AL00009bJZ"]},"has_zoning_restrictions":{"type":"boolean","title":"Has Zoning Restrictions","description":"Whether zoning plan restrictions apply to this property. True if at least one zoning plan intersects the property. False if the municipality provides zoning plans but none intersect this property.","examples":[true]}},"type":"object","required":["property_identifier","has_zoning_restrictions"],"title":"PropertyZoningPlanResponse"},"ValidationErrorResponse":{"properties":{"type":{"type":"string","const":"validation-error","title":"Type","description":"Error type identifier.","examples":["validation-error"]},"message":{"type":"string","title":"Message","description":"Human-readable English description of the validation error.","examples":["Some entries are invalid"]},"errors":{"additionalProperties":true,"type":"object","title":"Errors","description":"Per-field validation error details, keyed by field name.","examples":[{"email":"Required field","property_deeplink":"Invalid URL schema"}]}},"type":"object","required":["type","message","errors"],"title":"ValidationErrorResponse","example":{"errors":{"email":"Required field","property_deeplink":"Invalid URL schema"},"message":"Some entries are invalid","type":"validation-error"}},"ZoningPlanResponse":{"properties":{"max_grz":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Grz","description":"Max allowed GRZ (Grundflaechenzahl) - site coverage ratio","examples":[0.4]},"max_gfz":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Gfz","description":"Max allowed GFZ (Geschossflaechenzahl) - floor area ratio","examples":[1.2]},"max_bmz":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Bmz","description":"Max allowed BMZ (Baumassenzahl) - building mass ratio (volume/area)","examples":[2]},"max_entire_floors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Entire Floors","description":"Max allowed entire floors","examples":[3]},"max_residential_units":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Residential Units","description":"Max allowed residential units","examples":[8]},"max_height":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Height","description":"Max allowed building height in meters","examples":[12.5]},"max_eaves_height":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Eaves Height","description":"Max allowed eaves height in meters","examples":[9]},"usage_allowed":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Usage Allowed","description":"Allowed usage type in the area","examples":["GE"]},"coverage_types":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Coverage Types","description":"List of allowed coverage types. Possible values: 'closed', 'open-adjoining-houses', 'open-detached-house', 'open-semi-detached-house'.","examples":[["open-detached-house"]]},"format":{"type":"string","enum":["xplan","document"],"title":"Format","description":"Format of the zoning plan data","default":"xplan","examples":["document"]},"min_entire_floors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Min Entire Floors","description":"Min required entire floors","examples":[1]},"zoning_plan_identifiers":{"items":{"type":"string"},"type":"array","title":"Zoning Plan Identifiers","description":"List of zoning plan identifiers that apply to the property","examples":[["GML_123","GML_456"]]},"references":{"items":{"$ref":"#/components/schemas/ZoningPlanReference"},"type":"array","title":"References","description":"References to zoning plan documents","examples":[[{"name":"Neue Schule Fruerlund","url":"https://www.flensburg.de/bebauungsplaene/307.pdf"}]]}},"type":"object","title":"ZoningPlanResponse"},"BuildingPotential":{"properties":{"property_identifier":{"type":"string","title":"Property Identifier","description":"Identifier of the property this building potential belongs to","examples":["PROPERTY-DENW49AL00009b0v"]},"target_usage_group":{"type":"string","title":"Target Usage Group","description":"Override the usage group (Nutzungsartengruppe) of the property to get the building potential for. If not given the biggest usage group of the property is used","examples":["Wohnbaufläche"]},"total_potential":{"type":"number","title":"Total potential predicted","description":"A value between zero and one, that is a linear combination of potential_grz, potential_floors, etc. High potential means the property's maximum building potential is significantly higher than the current utilization.","examples":[0.3]},"total_potential_label":{"type":"string","enum":["low","medium","high"],"title":"Total potential label","description":"Indicates high, medium or low building potential. High potential means the property's maximum building potential is significantly higher than the current utilization.","examples":["low"]},"grz1":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Site Occupancy Index 1 Predicted","description":"Prediction for allowed grz1 on the property","examples":[0.28908496391137856]},"grz1_min":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Site Occupancy Index 1 Predicted","description":"Minimum prediction for grz1","examples":[0.26]},"grz1_max":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Higher Site Occupancy Index 1 Predicted","description":"Maximum prediction for grz1","examples":[0.31]},"gfz":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Floor Space Index Predicted","description":"Prediction for allowed gfz on the property","examples":[0.24122308173345774]},"gfz_min":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower floor Space Index Predicted","description":"Minimum prediction for gfz","examples":[0.22]},"gfz_max":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper floor Space Index Predicted","description":"Maximum prediction for gfz","examples":[0.26]},"entire_floors":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Entire Floors Predicted","description":"Prediction for allowed entire_floors on the property","examples":[1]},"entire_floors_min":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower entire Floors Predicted","description":"Minimum prediction for entire_floors","examples":[0]},"entire_floors_max":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper entire Floors Predicted","description":"Maximum prediction for entire_floors","examples":[2]},"built_surface_area_primary_buildings":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Primary Built Surface Area Predicted","description":"Prediction for allowed built_surface_area_primary_buildings on the property","examples":[234.33153457067021]},"built_surface_area_primary_buildings_min":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower primary Built Surface Area Predicted","description":"Minimum prediction for built_surface_area_primary_buildings","examples":[205]},"built_surface_area_primary_buildings_max":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper primary Built Surface Area Predicted","description":"Maximum prediction for built_surface_area_primary_buildings","examples":[275]},"floorspace_primary_buildings":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Primary Floorspace Predicted","description":"Prediction for allowed floorspace_primary_buildings on the property","examples":[403.67191]},"floorspace_primary_buildings_min":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower primary Floorspace Predicted","description":"Minimum prediction for floorspace_primary_buildings","examples":[370]},"floorspace_primary_buildings_max":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper primary Floorspace Predicted","description":"Maximum prediction for floorspace_primary_buildings","examples":[430]},"floorspace_entire_floors_primary_buildings":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Primary Entire Floor Floorspace Predicted","description":"Prediction for allowed floorspace_entire_floors_primary_buildings on the property","examples":[403.67191]},"floorspace_entire_floors_primary_buildings_min":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Primary Entire Floor Floorspace Predicted","description":"Minimum prediction for floorspace_entire_floors_primary_buildings","examples":[370]},"floorspace_entire_floors_primary_buildings_max":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Primary Entire Floor Floorspace Predicted","description":"Maximum prediction for floorspace_entire_floors_primary_buildings","examples":[430]},"highest_primary_building_height":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Highest Primary Building Height Predicted","description":"Prediction for allowed highest_primary_building_height on the property","examples":[11.250003814697266]},"highest_primary_building_height_min":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower highest Primary Building Height Predicted","description":"Minimum prediction for highest_primary_building_height","examples":[10]},"highest_primary_building_height_max":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper highest Primary Building Height Predicted","description":"Maximum prediction for highest_primary_building_height","examples":[13]},"model_version":{"type":"string","title":"Model Version","description":"Version of the ML model that was used to generate this prediction","examples":["v0.0.1"]}},"type":"object","required":["property_identifier","target_usage_group","total_potential","total_potential_label","model_version"],"title":"BuildingPotential"},"PotentialUnavailableErrorResponse":{"properties":{"type":{"type":"string","enum":["authentication-error","not-found-error","unsupported-operation"],"title":"Type","description":"Error type identifier.","examples":["authentication-error"]},"message":{"type":"string","title":"Message","description":"Human-readable English description of why the potential is unavailable.","examples":["You are not allowed to access this resource"]},"reason":{"anyOf":[{"type":"string","enum":["unauthenticated","insufficient_permission","insufficient_permission_state_missing"]},{"type":"string","enum":["invalid_usage_group","not_suitable","not_available_yet","invalid_neighbor_selection","incomplete_neighbor_data"]}],"title":"Reason","description":"Reason code explaining why the potential is unavailable.","examples":["insufficient_permission"]}},"type":"object","required":["type","message","reason"],"title":"PotentialUnavailableErrorResponse","example":{"message":"You are not allowed to access this resource","reason":"insufficient_permission","type":"authentication-error"}},"BuildingPotentialParcelNeighbors":{"properties":{"property_identifier":{"type":"string","title":"Property identifier","description":"Property identifier of the root property","examples":["PROPERTY-DENW49AL00009b0v"]},"neighbors":{"items":{"$ref":"#/components/schemas/BuildingPotentialParcelNeighbor"},"type":"array","title":"Neighbors","description":"List of neighbors","examples":[[{"distance":50.32,"is_street":true,"parcel_identifier":"DENW49AL00009b0D"}]]}},"type":"object","required":["property_identifier","neighbors"],"title":"BuildingPotentialParcelNeighbors"},"OnRoofBuildingPVPotential":{"properties":{"building_identifier":{"type":"string","title":"Building Identifier","description":"Identifier of the building for which the on-roof photovoltaic potential is calculated for","examples":["DENW49AL00009XTV"]},"roof_area":{"type":"number","title":"Roof Area","description":"Total roof area in squared meters","examples":[130]},"solar_panel_area":{"type":"number","title":"Solar Panel Area","description":"Total panel area in squared meters assumed to be installable on the top of all roof surfaces","examples":[130]},"pv_peakpower":{"type":"number","title":"Pv Peakpower","description":"Peak power of the on-roof pv installation in kWp","examples":[8.534]},"yearly_pv_potential":{"$ref":"#/components/schemas/YearlyPVPotential","description":"Potential of the on-roof pv installation aggregated over the year","examples":[{"pv_potential":8.856,"pv_potential_max":9.856,"pv_potential_min":7.856,"solar_irradiation":1.534}]},"monthly_pv_potential":{"items":{"$ref":"#/components/schemas/MonthlyPVPotential"},"type":"array","title":"Monthly Pv Potential","description":"Potential of the on-roof pv installation for each month of the year","examples":[[{"month":1,"pv_potential":8.856,"pv_potential_max":9.856,"pv_potential_min":7.856,"solar_irradiation":1.534}]]}},"type":"object","required":["building_identifier","roof_area","solar_panel_area","pv_peakpower","yearly_pv_potential","monthly_pv_potential"],"title":"OnRoofBuildingPVPotential"},"OnRoofPropertyPVPotential":{"properties":{"property_identifier":{"type":"string","title":"Property Identifier","description":"Identifier of the property for which the on-roof photovoltaic potential is calculated for","examples":["PROPERTY-DENW49AL00009879"]},"roof_area":{"type":"number","title":"Roof Area","description":"Total roof area in squared meters","examples":[130]},"solar_panel_area":{"type":"number","title":"Solar Panel Area","description":"Total panel area in squared meters assumed to be installable on the top of all roof surfaces","examples":[130]},"pv_peakpower":{"type":"number","title":"Pv Peakpower","description":"Peak power of the on-roof pv installation in kWp","examples":[8.534]},"yearly_pv_potential":{"$ref":"#/components/schemas/YearlyPVPotential","description":"Potential of the on-roof pv installation aggregated over the year","examples":[{"pv_potential":8.856,"pv_potential_max":9.856,"pv_potential_min":7.856,"solar_irradiation":1.534}]},"monthly_pv_potential":{"items":{"$ref":"#/components/schemas/MonthlyPVPotential"},"type":"array","title":"Monthly Pv Potential","description":"Potential of the on-roof pv installation for each month of the year","examples":[[{"month":1,"pv_potential":8.856,"pv_potential_max":9.856,"pv_potential_min":7.856,"solar_irradiation":1.534}]]},"buildings":{"items":{"$ref":"#/components/schemas/OnRoofBuildingPVPotential"},"type":"array","title":"Buildings","description":"The on-roof pv potential of all the buildings on this property","examples":[[{"building_identifier":"DENW49AL00009XTV","monthly_pv_potential":[{"month":1,"pv_potential":8.856,"pv_potential_max":9.856,"pv_potential_min":7.856,"solar_irradiation":1.534}],"pv_peakpower":8.534,"roof_area":130,"solar_panel_area":130,"yearly_pv_potential":{"pv_potential":8.856,"pv_potential_max":9.856,"pv_potential_min":7.856,"solar_irradiation":1.534}}]]}},"type":"object","required":["property_identifier","roof_area","solar_panel_area","pv_peakpower","yearly_pv_potential","monthly_pv_potential","buildings"],"title":"OnRoofPropertyPVPotential"},"UsageCluster":{"properties":{"type":{"type":"string","const":"Feature","title":"Type","default":"Feature"},"geometry":{"anyOf":[{"$ref":"#/components/schemas/Polygon"},{"$ref":"#/components/schemas/MultiPolygon"}],"title":"Geometry"},"properties":{"$ref":"#/components/schemas/UsageClusterProperties"},"id":{"type":"string","title":"Id"}},"type":"object","required":["geometry","properties","id"],"title":"UsageCluster"},"SearchRequest":{"properties":{"usage":{"anyOf":[{"items":{"type":"string"},"type":"array","minItems":1},{"type":"null"}],"title":"Usage","description":"The list of accepted property usage types (must be given in German)","examples":[["Wohnbaufläche"]]},"usecase":{"anyOf":[{"type":"string","enum":["residential","commercial","industrial","logistic"]},{"type":"null"}],"title":"Usecase","description":"Specifies the use case which can be used to filter pre-defined usages. It overwrites the usage parameter using the mapping: {'residential': ['Wohnbaufläche', 'Fläche gemischter Nutzung', 'Fläche gemischter Nutzung / Gebäude- und Freifläche', 'Mischnutzung mit Wohnen'], 'commercial': ['Fläche gemischter Nutzung', 'Fläche gemischter Nutzung / Gebäude- und Freifläche, Mischnutzung mit Wohnen', 'Fläche gemischter Nutzung / Gewerbe und Industrie mit Wohnen', 'Fläche gemischter Nutzung / Handel und Dienstleistungen mit Wohnen', 'Fläche gemischter Nutzung / Wohnen mit Gewerbe und Industrie', 'Fläche gemischter Nutzung / Wohnen mit Handel und Dienstleistungen', 'Industrie- und Gewerbefläche', 'Industrie- und Gewerbefläche / Bank, Kredit', 'Industrie- und Gewerbefläche / Beherbergung', 'Industrie- und Gewerbefläche / Gebäude- und Freifläche Industrie und Gewerbe', 'Industrie- und Gewerbefläche / Gärtnerei', 'Industrie- und Gewerbefläche / Handel', 'Industrie- und Gewerbefläche / Handel und Dienstleistung', 'Industrie- und Gewerbefläche / Handwerk', 'Industrie- und Gewerbefläche / Lagerplatz', 'Industrie- und Gewerbefläche / Produktion', 'Industrie- und Gewerbefläche / Restauration', 'Industrie- und Gewerbefläche / Tankstelle', 'Industrie- und Gewerbefläche / Transport', 'Industrie- und Gewerbefläche / Vergnügung', 'Industrie- und Gewerbefläche / Versicherung', 'Industrie- und Gewerbefläche / Verwaltung, freie Berufe', 'Industrie- und Gewerbefläche / Werft'], 'industrial': ['Industrie- und Gewerbefläche', 'Industrie- und Gewerbefläche / Gebäude- und Freifläche Industrie und Gewerbe', 'Industrie- und Gewerbefläche / Industrie und Gewerbe', 'Industrie- und Gewerbefläche / Lagerplatz', 'Industrie- und Gewerbefläche / Produktion', 'Industrie- und Gewerbefläche / Transport', 'Industrie- und Gewerbefläche / Werft'], 'logistic': ['Industrie- und Gewerbefläche', 'Industrie- und Gewerbefläche / Gebäude- und Freifläche Industrie und Gewerbe', 'Industrie- und Gewerbefläche / Industrie und Gewerbe', 'Industrie- und Gewerbefläche / Lagerplatz', 'Industrie- und Gewerbefläche / Produktion', 'Industrie- und Gewerbefläche / Transport', 'Industrie- und Gewerbefläche / Werft']}","examples":["residential"]},"geometry":{"anyOf":[{"$ref":"#/components/schemas/MultiPolygon"},{"type":"null"}],"description":"GeoJSON MultiPolygon that defines the boundaries of the search area","examples":[{"coordinates":[[[[7.615685384402646,51.95920486357158],[7.615685384402646,51.96933810384669],[7.631241690453126,51.96933810384669],[7.631241690453126,51.95920486357158],[7.615685384402646,51.95920486357158]]],[[[7.642978936098415,51.9637132105063],[7.662532525372995,51.9675408440022],[7.65813577348499,51.95519229717718],[7.642978936098415,51.9637132105063]]]],"type":"MultiPolygon"}]},"area_min":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Area Min","description":"Minimum total area of the property","examples":[1000]},"area_max":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Area Max","description":"Maximum total area of the property","examples":[2000]},"width_min":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Width Min","description":"Minimum width of the property's envelope in meters - The width is the smallest dimension of the envelope","examples":[10]},"width_max":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Width Max","description":"Maximum width of the property's envelope in meters - The width is the smallest dimension of the envelope","examples":[50]},"length_min":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Length Min","description":"Minimum length of the property's envelope in meters - The length is the largest dimension of the envelope","examples":[10]},"length_max":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Length Max","description":"Maximum length of the property's envelope in meters - The length is the largest dimension of the envelope","examples":[100]},"origin_min":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Origin Min","description":"Minimum property origin year - the origin is an approximation of the building age","examples":[1900]},"origin_max":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Origin Max","description":"Maximum property origin year - the origin is an approximation of the building age","examples":[2015]},"construction_year_min":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Construction Year Min","description":"Minimum construction year of a building on the property - not all buildings have assigned a construction year","examples":[1965]},"construction_year_max":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Construction Year Max","description":"Maximum construction year of a building on the property - not all buildings have assigned a construction year","examples":[2015]},"gfz_min":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Gfz Min","description":"Minimum Floor Space Index - The Floor Space Index (Geschossflächenzahl or GFZ) is a measure of the density of built use (Maß der baulichen Nutzung) incorporating the amount of full floors (Vollgeschosse). The Floor Space Index is the quotient of the floorspace of all full floors over the property area.","examples":[0.1]},"gfz_max":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Gfz Max","description":"Maximum Floor Space Index - The Floor Space Index (Geschossflächenzahl or GFZ) is a measure of the density of built use (Maß der baulichen Nutzung) incorporating the amount of full floors (Vollgeschosse). The Floor Space Index is the quotient of the floorspace of all full floors over the property area.","examples":[1.6]},"grz_min":{"anyOf":[{"type":"number","maximum":1.2,"minimum":0},{"type":"null"}],"title":"Grz Min","description":"Minimum Site Occupancy Index - The Site Occupancy Index (Grundflächenzahl or GRZ) is a measure of the density of built use (Maß der baulichen Nutzung) incorporating the built surface area (Grundfläche). The Site Occupancy Index is the quotient of the built surface area over the property area.","examples":[0.1]},"grz_max":{"anyOf":[{"type":"number","maximum":1.2,"minimum":0},{"type":"null"}],"title":"Grz Max","description":"Maximum Site Occupancy Index - The Site Occupancy Index (Grundflächenzahl or GRZ) is a measure of the density of built use (Maß der baulichen Nutzung) incorporating the built surface area (Grundfläche). The Site Occupancy Index is the quotient of the built surface area over the property area.","examples":[0.9]},"grz1_min":{"anyOf":[{"type":"number","maximum":1.2,"minimum":0},{"type":"null"}],"title":"Grz1 Min","description":"Minimum Site Occupancy Index 1 (Grundflächenzahl 1 or GRZ 1) is a measure of the density of built use (Maß der baulichen Nutzung) incorporating the built surface area (Grundfläche) of primary buildings. The Site Occupancy Index 1 is the quotient of the built surface area of primary buildings (Hauptgebäude) over the property area.","examples":[0.1]},"grz1_max":{"anyOf":[{"type":"number","maximum":1.2,"minimum":0},{"type":"null"}],"title":"Grz1 Max","description":"Maximum Site Occupancy Index 1 (Grundflächenzahl 1 or GRZ 1) is a measure of the density of built use (Maß der baulichen Nutzung) incorporating the built surface area (Grundfläche) of primary buildings. The Site Occupancy Index 1 is the quotient of the built surface area of primary buildings (Hauptgebäude) over the property area.","examples":[0.9]},"entire_floors_min":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Entire Floors Min","description":"Minimum number of entire floors (Vollgeschosse)","examples":[1]},"entire_floors_max":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Entire Floors Max","description":"Maximum number of entire floors (Vollgeschosse)","examples":[4]},"floors_min":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Floors Min","description":"Minimum number of floors","examples":[1]},"floors_max":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Floors Max","description":"Maximum number of floors","examples":[5]},"built_surface_area_primary_buildings_min":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Built Surface Area Primary Buildings Min","description":"Minimum built surface area (Grundfläche) of the primary buildings (Hauptgebäude)","examples":[100]},"built_surface_area_primary_buildings_max":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Built Surface Area Primary Buildings Max","description":"Maximum built surface area (Grundfläche) of the primary buildings (Hauptgebäude)","examples":[1000]},"region_identifier":{"anyOf":[{"items":{"type":"string","maxLength":14,"minLength":2},"type":"array","maxItems":20,"minItems":1},{"type":"null"}],"title":"Region Identifier","description":"syte identifier of the regions to limit the search to","examples":[["DE055150000"]]},"population_min":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Population Min","description":"Minimum population of the municipality the search results must be located in","examples":[10000]},"population_max":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Population Max","description":"Maximum population of the municipality the search results must be located in","examples":[400000]},"floorspace_primary_buildings_min":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Floorspace Primary Buildings Min","description":"Minimum gross floorspace (Brutto-Grundfläche or BGF or Geschossfläche) of primary buildings (Hauptgebäude)","examples":[100]},"floorspace_primary_buildings_max":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Floorspace Primary Buildings Max","description":"Maximum gross floorspace (Brutto-Grundfläche or BGF or Geschossfläche) of primary buildings (Hauptgebäude)","examples":[1000]},"floorspace_primary_buildings_total_potential_min":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Floorspace Primary Buildings Total Potential Min","description":"Minimum total potential gross floorspace (potenzielle Brutto-Grundfläche or BGF or Geschossfläche) of primary buildings (Hauptgebäude)","examples":[300]},"floorspace_primary_buildings_total_potential_max":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Floorspace Primary Buildings Total Potential Max","description":"Maximum total potential gross floorspace (potenzielle Brutto-Grundfläche or BGF or Geschossfläche) of primary buildings (Hauptgebäude)","examples":[1000]},"floorspace_primary_buildings_additional_potential_min":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Floorspace Primary Buildings Additional Potential Min","description":"Minimum additional potential gross floorspace (potenzielle Brutto-Grundfläche or BGF or Geschossfläche) of primary buildings (Hauptgebäude)","examples":[100]},"floorspace_primary_buildings_additional_potential_max":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Floorspace Primary Buildings Additional Potential Max","description":"Maximum additional potential gross floorspace (potenzielle Brutto-Grundfläche or BGF or Geschossfläche) of primary buildings (Hauptgebäude)","examples":[500]},"grz1_total_potential_min":{"anyOf":[{"type":"number","maximum":1.2,"minimum":0},{"type":"null"}],"title":"Grz1 Total Potential Min","description":"Minimum total potential Site Occupancy Index 1 (Grundflächenzahl 1 or GRZ 1)","examples":[0.1]},"grz1_total_potential_max":{"anyOf":[{"type":"number","maximum":1.2,"minimum":0},{"type":"null"}],"title":"Grz1 Total Potential Max","description":"Maximum total potential Site Occupancy Index 1 (Grundflächenzahl 1 or GRZ 1)","examples":[0.9]},"grz1_additional_potential_min":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Grz1 Additional Potential Min","description":"Minimum additional potential Site Occupancy Index 1 (Grundflächenzahl 1 or GRZ 1)","examples":[0.1]},"grz1_additional_potential_max":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Grz1 Additional Potential Max","description":"Maximum additional potential Site Occupancy Index 1 (Grundflächenzahl 1 or GRZ 1)","examples":[0.9]},"entire_floors_total_potential_min":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Entire Floors Total Potential Min","description":"Minimum total potential number of entire floors (Vollgeschosse)","examples":[1]},"entire_floors_total_potential_max":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Entire Floors Total Potential Max","description":"Maximum total potential number of entire floors (Vollgeschosse)","examples":[4]},"entire_floors_additional_potential_min":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Entire Floors Additional Potential Min","description":"Minimum additional potential number of entire floors (Vollgeschosse)","examples":[1]},"entire_floors_additional_potential_max":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Entire Floors Additional Potential Max","description":"Maximum additional potential number of entire floors (Vollgeschosse)","examples":[4]},"gfz_total_potential_min":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Gfz Total Potential Min","description":"Minimum total potential Floor Space Index (Geschossflächenzahl or GFZ)","examples":[0.1]},"gfz_total_potential_max":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Gfz Total Potential Max","description":"Maximum total potential Floor Space Index (Geschossflächenzahl or GFZ)","examples":[1.6]},"gfz_additional_potential_min":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Gfz Additional Potential Min","description":"Minimum additional potential Floor Space Index (Geschossflächenzahl or GFZ)","examples":[0.1]},"gfz_additional_potential_max":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Gfz Additional Potential Max","description":"Maximum additional potential Floor Space Index (Geschossflächenzahl or GFZ)","examples":[1.6]},"built_surface_area_primary_buildings_total_potential_min":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Built Surface Area Primary Buildings Total Potential Min","description":"Minimum total potential built surface area (Grundfläche) of primary buildings","examples":[300]},"built_surface_area_primary_buildings_total_potential_max":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Built Surface Area Primary Buildings Total Potential Max","description":"Maximum total potential built surface area (Grundfläche) of primary buildings","examples":[1000]},"built_surface_area_primary_buildings_additional_potential_min":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Built Surface Area Primary Buildings Additional Potential Min","description":"Minimum additional potential  built surface area (Grundfläche) of primary buildings","examples":[100]},"built_surface_area_primary_buildings_additional_potential_max":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Built Surface Area Primary Buildings Additional Potential Max","description":"Maximum additional potential  built surface area (Grundfläche) of primary buildings","examples":[500]},"highest_primary_building_height_total_potential_min":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Highest Primary Building Height Total Potential Min","description":"Minimum total potential highest primary building height","examples":[10]},"highest_primary_building_height_total_potential_max":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Highest Primary Building Height Total Potential Max","description":"Maximum total potential highest primary building height","examples":[20]},"highest_primary_building_height_additional_potential_min":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Highest Primary Building Height Additional Potential Min","description":"Minimum additional potential highest primary building height","examples":[10]},"highest_primary_building_height_additional_potential_max":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Highest Primary Building Height Additional Potential Max","description":"Maximum additional potential highest primary building height","examples":[10]},"direct_neighbor_more_entire_floors_min":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Direct Neighbor More Entire Floors Min","description":"Minimum of more entire floors the direct neighbor with most entire floors of all direct neighbors in the same street has","examples":[1]},"direct_neighbor_more_entire_floors_max":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Direct Neighbor More Entire Floors Max","description":"Maximum of more entire floors the direct neighbor with most entire floors of all direct neighbors in the same street has","examples":[4]},"same_street_more_entire_floors_min":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Same Street More Entire Floors Min","description":"Minimum of more entire floors the neighbor on the same street with most entire floors of all neighbors on the street has","examples":[1]},"same_street_more_entire_floors_max":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Same Street More Entire Floors Max","description":"Maximum of more entire floors the neighbor on the same street with most entire floors of all neighbors on the street has","examples":[4]},"direct_neighbor_more_height_min":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Direct Neighbor More Height Min","description":"Minimum of more height the direct neighbor with most height of all direct neighbors in the same street has","examples":[1]},"direct_neighbor_more_height_max":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Direct Neighbor More Height Max","description":"Maximum of more height the direct neighbor with most height of all direct neighbors in the same street has","examples":[4]},"same_street_more_height_min":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Same Street More Height Min","description":"Minimum of more height the neighbor on the same street with most height of all neighbors on the street has","examples":[1]},"same_street_more_height_max":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Same Street More Height Max","description":"Maximum of more height the neighbor on the same street with most height of all neighbors on the street has","examples":[4]},"potential_reuse_usage":{"anyOf":[{"type":"string","enum":["Wohnbaufläche","Fläche gemischter Nutzung","Industrie- und Gewerbefläche"]},{"type":"null"}],"title":"Potential Reuse Usage","description":"A usage group (Nutzungsartengruppe) that neighbors of the searched property must have. The behaviour vary depending on the values of the parameters potential_reuse_direct_neighbor and potential_reuse_neighbor_count.","examples":["Wohnbaufläche"]},"potential_reuse_direct_neighbor":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Potential Reuse Direct Neighbor","description":"Indicates if the neighbors should be direct neighbors or not. Can only be used if potential_reuse_usage is provided.","default":false,"examples":[false]},"potential_reuse_neighbor_count":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Potential Reuse Neighbor Count","description":"Indicates the amount of neighbors that should have the desired usage. Can only be used if potential_reuse_usage is provided.","default":1,"examples":[1]},"street_access_required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Street Access Required","description":"If set to true only properties touching at least one street will be returned. If set to false the filter is not applied. The default behavior is to have the filter applied (true) if the parameter is either not provided or provided as null","examples":[true]},"property_energy_demand_label":{"anyOf":[{"items":{"type":"string","enum":["A+","A","B","C","D","E","F","G","H"]},"type":"array"},{"type":"null"}],"title":"Energy Efficiency Label of a Property","description":"The estimated average energy efficiency class of all buildings on this property","examples":[["A+","A","B","C","D","E","F","G","H"]]},"property_energy_demand_min":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Minimum Relative Energy Demand of a Property","description":"The minimum estimated average (relative) energy demand of the all buildings in this property in kWh/m²a","examples":[180]},"property_energy_demand_max":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Maximum Relative Energy Demand of a Property","description":"The maximum estimated average (relative) energy demand of the all buildings in this property in kWh/m²a","examples":[200]},"property_energy_demand_total_min":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Minimum Total Energy Demand of a Property","description":"The minimum estimated average total energy demand of the all buildings in this property in kWh/y","examples":[100]},"property_energy_demand_total_max":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Maximum Total Energy Demand of a Property","description":"The maximum estimated average total energy demand of the all buildings in this property in kWh/y","examples":[10000]},"building_energy_demand_label":{"anyOf":[{"items":{"type":"string","enum":["A+","A","B","C","D","E","F","G","H"]},"type":"array"},{"type":"null"}],"title":"Energy Efficiency Label of a Building","description":"The estimated energy efficiency class","examples":[["A+","A","B","C","D","E","F","G","H"]]},"building_energy_demand_min":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Minimum Relative Energy Demand of a Building","description":"The minimum estimated (relative) energy demand of the building in kWh/m²a","examples":[50]},"building_energy_demand_max":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Maximum Relative Energy Demand of a Building","description":"The maximum estimated (relative) energy demand of the building in kWh/m²a","examples":[200]},"building_energy_demand_total_min":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Minimum Total Energy Demand of a Building","description":"The minimum estimated total energy demand of the building in kWh/y","examples":[100]},"building_energy_demand_total_max":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Maximum Total Energy Demand of a Building","description":"The maximum estimated total energy demand of the building in kWh/y","examples":[10000]},"property_roof_pv_potential_min":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Minimum PV Potential of a Property","description":"The minimum of the average calculated on-roof photovoltaic potential in kWh/year","examples":[10]},"property_roof_pv_potential_max":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Maximum PV Potential of a Property","description":"The maximum of the average calculated on-roof photovoltaic potential in kWh/year","examples":[1000]},"property_roof_surface_area_min":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Minimum of the roof surface area of the buildings on a property","description":"The minimum of the total roof area of the buildings on the property in m2","examples":[100]},"property_roof_surface_area_max":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Maximum of the roof surface area of the buildings on a property","description":"The maximum of the total roof area of the buildings on the property in m2","examples":[1000]},"building_roof_pv_potential_min":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Minimum PV Potential of a Building","description":"The minimum of the average on-roof photovoltaic potential of the building in kWh/year","examples":[10]},"building_roof_pv_potential_max":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Maximum PV Potential of a Building","description":"The maximum of the average on-roof photovoltaic potential of the building in kWh/year","examples":[1000]},"building_roof_surface_area_min":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Minimum of the roof surface area of the building","description":"The minimum of the total roof area of the building in m2","examples":[100]},"building_roof_surface_area_max":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Maximum of the roof surface area of the building","description":"The maximum of the total roof area of the building in m2","examples":[1000]},"fertility_index_min":{"anyOf":[{"type":"number","maximum":100,"minimum":0},{"type":"null"}],"title":"Minimum Fertility Index (Bodenzahl) on the property","description":"Minimum Fertility Index (Bodenzahl) - The Fertility Index (Bodenzahl) classifies the fertility for all agriculture land in Germany, 0 is infertile, 100 very fertile. A value below 35 usually helps to get a permit for open-space PV.","examples":[50]},"fertility_index_max":{"anyOf":[{"type":"number","maximum":100,"minimum":0},{"type":"null"}],"title":"Maximum Fertility Index (Bodenzahl) on the property","description":"Maximum Fertility Index (Bodenzahl) - The Fertility Index (Bodenzahl) classifies the fertility for all agriculture land in Germany, 0 is infertile, 100 very fertile. A value below 35 usually helps to get a permit for open-space PV.","examples":[80]},"fertility_index_include_data_unavailable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Include properties where we do not have fertility index (Bodenzahl)","description":"Include properties where we do not have fertility index (Bodenzahl) data even when the other `fertilityindex{min,max}` filters are set.","examples":[true]},"protectorates_include":{"anyOf":[{"items":{"type":"string","enum":["protected_landscape_areas","national_monuments_of_nature","nature_reserve","national_park"]},"type":"array","minItems":1},{"type":"null"}],"title":"Protectorate types that should be included in the search","description":"This filter allows you to allow properties in certain protectorates (Schutzgebiete). Protectorates that can be filtered are Protected Landscape Areas (Landschaftschutzgebiete), National Monuments of Nature (Nationale Naturmonumente), Nature Reserve (Naturschutzgebiet) and National Park (Nationalpark)","examples":[["protected_landscape_areas","national_monuments_of_nature","nature_reserve","national_park"]]},"close_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/CloseByPoi"},"type":"array","minItems":1},{"type":"null"}],"title":"Close by features","description":"Filter for properties that have the specified Points of Interest within given distances. Multiple entries are combined as an OR condition.","examples":[[{"distance_max":500,"poi_type":"railway"}]]},"flood_risk_probability_max":{"anyOf":[{"type":"string","enum":["none","low","medium","high"]},{"type":"null"}],"title":"Maximum Flood Risk Probability","description":"This filter allows you to filter out properties with certain flood risks (Hochwassergefahr).You provide the maximal acceptable flood risk scenario.","examples":["medium"]},"flood_risk_water_depth":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Maximum Flood Risk Water Depth","description":"This filter allows you to filter out properties with certain water depths in flood risks (Hochwassergefahr).You provide the maximal acceptable water depths for any flood risk (low, medium, high).The water risk areas are categorized in the following buckets: up to 0.5 m, 0.5 m - 1 m, 1 m - 2 m, 2 m - 4 m, more than 4 m.","examples":[0.1]}},"additionalProperties":false,"type":"object","title":"SearchRequest"},"SearchCountResponse":{"properties":{"total_result_count":{"type":"integer","title":"Total Result Count","description":"Total number of results","examples":[1449]},"total_results_in_user_subscription":{"type":"integer","title":"Total Results In User Subscription","description":"Total number of results in states the user is subscribed to. 0 if authenticated","examples":[449]},"results_per_state":{"additionalProperties":{"type":"integer"},"propertyNames":{"enum":["debw","deby","debe","debb","dehb","dehh","dehe","demv","deni","denw","derp","desl","desn","dest","desh","deth","esan","esar","esas","esib","escn","escb","escl","escm","esct","esvc","esex","esga","esmd","esmc","esnc","espv","esri","esce","esml","gbeng","gbsct","gbwls","gbnir"]},"type":"object","title":"Results Per State","description":"Number of results per state","examples":[{"debe":500,"denw":500,"desh":449}]}},"type":"object","required":["total_result_count","total_results_in_user_subscription","results_per_state"],"title":"SearchCountResponse"},"SearchAnalysisPaginatedResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/SearchResult"},"type":"array","title":"Results","description":"List of search results","examples":[[{"address":"Fernholzstraße 33","area":100,"center":[7.6,51.9],"county":"Münster","identifier":"PROPERTY-DENW49AL00009b0v","label":"427","municipality":"Münster","postcode":"48155","state":"NRW","total_potential_label":"medium"}]]},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page","description":"Use this for the next page request","examples":["eyJvZmZzZXQiOjUwfQ=="]}},"type":"object","required":["results"],"title":"SearchAnalysisPaginatedResponse"},"SearchAnalysisPotentialPointsPaginatedResponse":{"properties":{"results":{"items":{"prefixItems":[{"type":"number"},{"type":"number"},{"type":"integer","enum":[0,1,2,3]},{"type":"string"}],"type":"array","maxItems":4,"minItems":4},"type":"array","title":"Results","description":"List of search potential points","examples":[[[51.9,7.6,1,"PROPERTY-DENW49AL00009b0v"]]]},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page","description":"Use this for the next page request","examples":["eyJvZmZzZXQiOjUwfQ=="]}},"type":"object","required":["results"],"title":"SearchAnalysisPotentialPointsPaginatedResponse"},"SearchRegionPaginatedResponse":{"properties":{"results_count":{"type":"integer","title":"Results Count","description":"Number of results in this response","examples":[1449]},"results":{"items":{"$ref":"#/components/schemas/RegionProperties"},"type":"array","title":"Results","description":"List of search results","examples":[[{"area":34112.56,"available":true,"center":[7.55413954972517,51.4778909628134],"children":["DE051110000000","DE051120000000"],"density":533,"identifier":"DE05","is_subscribed":true,"name":"Nordrhein-Westfalen","population":18190422,"state":"denw","type":"state","type_local":"Bundesland","urbanization":"high"}]]}},"type":"object","required":["results_count","results"],"title":"SearchRegionPaginatedResponse"},"RegionCollection":{"properties":{"type":{"type":"string","const":"FeatureCollection","title":"Type","default":"FeatureCollection"},"features":{"items":{"$ref":"#/components/schemas/Region"},"type":"array","title":"Features"}},"type":"object","required":["features"],"title":"RegionCollection"},"RegionBoundingBox":{"properties":{"north":{"type":"number","title":"North","description":"The northernmost latitude","examples":[51.99093121769435]},"east":{"type":"number","title":"East","description":"The easternmost longitude","examples":[7.59182819311803]},"south":{"type":"number","title":"South","description":"The southernmost latitude","examples":[51.99093121769435]},"west":{"type":"number","title":"West","description":"The westernmost longitude","examples":[7.59182819311803]}},"type":"object","required":["north","east","south","west"],"title":"RegionBoundingBox"},"StoredProjectCalculationDetailedResponse":{"properties":{"date_added":{"type":"string","title":"Date Added","description":"The date when the resource was added","examples":["2023-05-11T09:31:00.117Z"]},"date_modified":{"type":"string","title":"Date Modified","description":"The date when the resource was last modified","examples":["2023-05-11T09:31:00.117Z"]},"id":{"type":"string","format":"uuid","title":"Id","description":"The project calculation id","examples":["f3b5c2a0-4b1b-4b1b-8b1b-8b1b1b1b1b1b"]},"project_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Project Id","description":"Optional identifier of the project this item belongs to. The project must be owned by the user and bound to the same property as this item","examples":["f3b5c2a0-4b1b-4b1b-8b1b-8b1b1b1b1b1b"]},"name":{"type":"string","maxLength":1024,"minLength":3,"title":"Name","description":"The name given to the project calculation","examples":["My project"]},"parcel_identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parcel Identifier","description":"Optional parcel, property or custom property identifier corresponding to the property that the calculation is based on","examples":["DENW01AL10000AgI"]},"state":{"anyOf":[{"type":"string","enum":["debw","deby","debe","debb","dehb","dehh","dehe","demv","deni","denw","derp","desl","desn","dest","desh","deth","esan","esar","esas","esib","escn","escb","escl","escm","esct","esvc","esex","esga","esmd","esmc","esnc","espv","esri","esce","esml","gbeng","gbsct","gbwls","gbnir"]},{"type":"null"}],"title":"State","description":"The country-prefixed state code that the calculation is based on","examples":["denw"]},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Municipality","description":"The name of the municipality (Gemeindeverband) that the calculation is based on","examples":["Münster, Stadt"]},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"Address of the property that the calculation is based on","examples":["Schanzenberg  39"]},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postcode","description":"The postcode that the calculation is based on","examples":["48143"]},"property_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Type","description":"The type of the property, e.g. 'syte' for stock properties, 'custom' for custom properties created with /api/custom-properties","examples":["syte"]},"center":{"anyOf":[{"$ref":"#/components/schemas/Position2D"},{"type":"null"}],"description":"The center coordinate that the calculation is based on","examples":[[7.59182819311803,51.99093121769435]]},"current_stock":{"$ref":"#/components/schemas/ProjectCalculationCurrentStock","description":"Existing-stock parameters (areas, units, year built) used as the baseline for all scenarios","examples":[{"area":811.4423156897531,"built_surface_area_primary_buildings":403.67191,"energy_demand_label":"A+","floorspace_primary_buildings":403.67191,"floorspace_rentalspace_factor":0.72,"gfz":0.24122308173345774,"grz1":0.24147450379043955,"linked":true,"origin_year":1956,"rentalunit_size":70,"volume":1492.1089901322962}]},"costs":{"$ref":"#/components/schemas/ProjectCalculationCosts","description":"Project-level cost inputs (acquisition, financing, ancillary) shared across all scenarios","examples":[{"land_additional_costs_factor":0.7,"property":830000}]},"calculations":{"items":{"$ref":"#/components/schemas/ProjectCalculationMethod"},"type":"array","title":"Calculations","description":"Exactly 3 development scenarios, one per `ProjectCalculationMethodType` (`current_stock`, `redensification_and_refurbishment`, `new_building`), each with its own costs, rents, subsidies and computed results","examples":[[{"calculation_results":{"rental_yield":0.104,"residual_value_property_cost":723000},"costs":{"construction_by_sqm":1800,"deconstruction_by_cbm":30,"financing_duration_years":3,"incidental_building_costs_factor":0.26,"interest_rate_on_debt":0.04,"other_costs_factor":0.1,"outdoor_facilities_by_sqm":132.5,"overground_parkingspace_by_unit":4500,"prepare_and_develop_by_sqm":20,"refurbishment_by_sqm":1500,"underground_parkingspaces_by_unit":27500},"new_building":{"built_surface_area_potential":300,"floorspace_potential":600,"floorspace_rentalspace_factor":0.72,"floorspace_volume_factor":3,"overground_parkingspace_count":6,"rentalunit_size":70,"underground_parkingspace_count":6},"rent":{"new_or_refurbished_net_cold_rent_by_sqm":11,"overground_parkingspace_by_unit":50,"stock_net_cold_rent_by_sqm":11,"underground_parkingspaces_by_unit":100},"selling_price_by_sqm":6549,"subsidies":{"kfw_target_usage_type":"residential","other":0},"target_return_factor":0.24,"type":"current_stock"},{"calculation_results":{"rental_yield":0.104,"residual_value_property_cost":723000},"costs":{"construction_by_sqm":1800,"deconstruction_by_cbm":30,"financing_duration_years":3,"incidental_building_costs_factor":0.26,"interest_rate_on_debt":0.04,"other_costs_factor":0.1,"outdoor_facilities_by_sqm":132.5,"overground_parkingspace_by_unit":4500,"prepare_and_develop_by_sqm":20,"refurbishment_by_sqm":1500,"underground_parkingspaces_by_unit":27500},"new_building":{"built_surface_area_potential":300,"floorspace_potential":600,"floorspace_rentalspace_factor":0.72,"floorspace_volume_factor":3,"overground_parkingspace_count":6,"rentalunit_size":70,"underground_parkingspace_count":6},"rent":{"new_or_refurbished_net_cold_rent_by_sqm":11,"overground_parkingspace_by_unit":50,"stock_net_cold_rent_by_sqm":11,"underground_parkingspaces_by_unit":100},"selling_price_by_sqm":6549,"subsidies":{"kfw_target_usage_type":"residential","other":0},"target_return_factor":0.24,"type":"redensification_and_refurbishment"},{"calculation_results":{"rental_yield":0.104,"residual_value_property_cost":723000},"costs":{"construction_by_sqm":1800,"deconstruction_by_cbm":30,"financing_duration_years":3,"incidental_building_costs_factor":0.26,"interest_rate_on_debt":0.04,"other_costs_factor":0.1,"outdoor_facilities_by_sqm":132.5,"overground_parkingspace_by_unit":4500,"prepare_and_develop_by_sqm":20,"refurbishment_by_sqm":1500,"underground_parkingspaces_by_unit":27500},"new_building":{"built_surface_area_potential":300,"floorspace_potential":600,"floorspace_rentalspace_factor":0.72,"floorspace_volume_factor":3,"overground_parkingspace_count":6,"rentalunit_size":70,"underground_parkingspace_count":6},"rent":{"new_or_refurbished_net_cold_rent_by_sqm":11,"overground_parkingspace_by_unit":50,"stock_net_cold_rent_by_sqm":11,"underground_parkingspaces_by_unit":100},"selling_price_by_sqm":6549,"subsidies":{"kfw_target_usage_type":"residential","other":0},"target_return_factor":0.24,"type":"new_building"}]]},"version":{"type":"integer","title":"Version","description":"Version the stored results were computed with; 0 for calculations stored before versioning was introduced","default":1,"examples":[1]}},"type":"object","required":["date_added","date_modified","id","name","current_stock","costs","calculations"],"title":"StoredProjectCalculationDetailedResponse"},"ProfitCalculatorError":{"properties":{"type":{"type":"string","enum":["profit-calculator-error","profit-calculator-missing-potential-error"],"title":"Type","description":"Error type identifier.","examples":["profit-calculator-error"]},"message":{"type":"string","title":"Message","description":"Human-readable English description of the profit calculation error.","examples":["Invalid calculation: The rental unit size must be greater than 0"]}},"type":"object","required":["type","message"],"title":"ProfitCalculatorError","example":{"message":"Invalid calculation: The rental unit size must be greater than 0","type":"profit-calculator-error"}},"DossierShareUrlResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Calculation identifier","examples":["f3b5c2a0-4b1b-4b1b-8b1b-8b1b1b1b1b1b"]},"url":{"type":"string","title":"Url","description":"URL to the pricehubble dossier","examples":["https://dossier.pricehubble.com/de/f3b5c2a0-4b1b-4b1b-8b1b-8b1b1b1b1b1b"]}},"type":"object","required":["id","url"],"title":"DossierShareUrlResponse"},"PriceHubbleValueOutOfBounds":{"properties":{"type":{"type":"string","const":"pricehubble-value-out-of-bounds","title":"Type","description":"Error type identifier.","examples":["pricehubble-value-out-of-bounds"]},"message":{"type":"string","title":"Message","description":"Human-readable English description of the out-of-bounds value error.","examples":["The value for building_year is too small"]},"attribute":{"type":"string","enum":["rental_units","living_area","building_year"],"title":"Attribute","description":"The input attribute whose value was out of the permitted range.","examples":["building_year"]},"value":{"type":"number","title":"Value","description":"The rejected value that fell outside the permitted range.","examples":[1700]},"allowed_min":{"type":"number","title":"Allowed Min","description":"The minimum permitted value for `attribute`.","examples":[1800]},"allowed_max":{"type":"number","title":"Allowed Max","description":"The maximum permitted value for `attribute`.","examples":[2024]}},"type":"object","required":["type","message","attribute","value","allowed_min","allowed_max"],"title":"PriceHubbleValueOutOfBounds","example":{"allowed_max":25,"allowed_min":2,"attribute":"rental_units","message":"The value for rental_units is too large","type":"pricehubble-value-out-of-bounds","value":26}},"PriceUpdateResponse":{"properties":{"calculation_id":{"type":"string","title":"Calculation Id","description":"Calculation identifier","examples":["f3b5c2a0-4b1b-4b1b-8b1b-8b1b1b1b1b1b"]},"calculations":{"items":{"$ref":"#/components/schemas/PriceUpdateCalculationMethod"},"type":"array","title":"Calculations","description":"List of calculations methods price updates","examples":[[{"new_or_refurbished_net_cold_rent_by_sqm":11,"selling_price_by_sqm":6549,"stock_net_cold_rent_by_sqm":11,"type":"current_stock"}]]}},"type":"object","required":["calculation_id","calculations"],"title":"PriceUpdateResponse"},"ZoningPlanCollection":{"properties":{"type":{"type":"string","const":"FeatureCollection","title":"Type","default":"FeatureCollection"},"features":{"items":{"$ref":"#/components/schemas/PlanArea"},"type":"array","title":"Features"}},"type":"object","required":["features"],"title":"ZoningPlanCollection"},"ZoningPlanSearchStartRequest":{"properties":{"property_identifier":{"type":"string","title":"Property Identifier","description":"The stock (`PROPERTY-…`), custom (`CUSTOM-…`) or parcel identifier of the property to search the zoning plan for. A parcel identifier is resolved to the property it belongs to","examples":["PROPERTY-DENW16AL00000PnI"]},"project_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Project Id","description":"Optional identifier of the project this search belongs to. The project must be owned by the user and bound to the same property as this search","examples":["0b6f0d4e-5f4a-4c43-9d55-3f1f6a1c2e7b"]}},"type":"object","required":["property_identifier"],"title":"ZoningPlanSearchStartRequest"},"ZoningPlanSearchResponse":{"properties":{"date_added":{"type":"string","title":"Date Added","description":"The date when the resource was added","examples":["2023-05-11T09:31:00.117Z"]},"date_modified":{"type":"string","title":"Date Modified","description":"The date when the resource was last modified","examples":["2023-05-11T09:31:00.117Z"]},"zoning_plan_search_id":{"type":"string","format":"uuid","title":"Zoning Plan Search Id","description":"Zoning plan search identifier","examples":["4d2c8a0e-8f3b-4a8e-a1a5-2b7e9f0c6d11"]},"research_id":{"type":"string","title":"Research Id","description":"The identifier of the research in the agentic search service","examples":["rsr_01K5XJ8Q2W3E4R5T6Y7U8I9O0P"]},"property_identifier":{"type":"string","title":"Property Identifier","description":"The identifier of the property the zoning plan was searched for","examples":["PROPERTY-DENW16AL00000PnI"]},"project_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Project Id","description":"Identifier of the project this search belongs to, if any","examples":["0b6f0d4e-5f4a-4c43-9d55-3f1f6a1c2e7b"]},"status":{"$ref":"#/components/schemas/ProductionStatus","description":"The status of the search","examples":["running"]},"phase":{"anyOf":[{"$ref":"#/components/schemas/ProductionPhase"},{"type":"null"}],"description":"The current step of the search when `status` is `running`","examples":["searching_plans"]},"result":{"anyOf":[{"$ref":"#/components/schemas/ProductionResearchResult"},{"type":"null"}],"description":"The result of the search when `status` is `succeeded` or `partial`","examples":[{"extraction_status":"complete","key_information":[],"legal_basis":"section_30","outcome":"plan_found","plans":[],"summary_markdown":"## Design-relevant provisions","warnings":[]}]},"error":{"anyOf":[{"$ref":"#/components/schemas/ProductionError"},{"type":"null"}],"description":"The error of the search when `status` is `failed`","examples":[{"code":"analysis_timeout","message":"Could not finish the analysis in the available time."}]}},"type":"object","required":["date_added","date_modified","zoning_plan_search_id","research_id","property_identifier","status"],"title":"ZoningPlanSearchResponse"},"ZoningPlanSearchLimitError":{"properties":{"type":{"type":"string","enum":["zoning-plan-search-quota-exceeded","zoning-plan-search-quota-pending","zoning-plan-search-parallel-limit-exceeded"],"title":"Type","description":"Error type identifier: `zoning-plan-search-quota-exceeded` when the user used up the monthly limit, `zoning-plan-search-quota-pending` when the queued and running searches use it up if they succeed, and `zoning-plan-search-parallel-limit-exceeded` when the user has the maximum number of queued and running searches","examples":["zoning-plan-search-quota-exceeded"]},"message":{"type":"string","title":"Message","description":"Human-readable English description of the limit that was hit.","examples":["Monthly zoning plan search limit reached. Try again on November 1, 2026."]},"limit":{"type":"integer","title":"Limit","description":"The monthly limit of successful searches, or the limit of queued and running searches for `zoning-plan-search-parallel-limit-exceeded`","examples":[100]},"retry_after_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Retry After Seconds","description":"How long to wait before searching again, set for `zoning-plan-search-quota-exceeded`.","examples":[1692000]}},"type":"object","required":["type","message","limit"],"title":"ZoningPlanSearchLimitError","example":{"limit":100,"message":"Monthly zoning plan search limit reached. Try again on November 1, 2026.","retry_after_seconds":1692000,"type":"zoning-plan-search-quota-exceeded"}},"AgenticSearchServiceError":{"properties":{"type":{"type":"string","const":"agentic-search-service-error","title":"Type","description":"Error type identifier.","examples":["agentic-search-service-error"]},"message":{"type":"string","title":"Message","description":"Human-readable English description of the error.","examples":["The geometry is out of any supported area"]},"code":{"type":"string","title":"Code","description":"`upstream_at_capacity` when the agentic search service is at capacity, `upstream_error` when it failed or could not be reached","examples":["upstream_error"]}},"type":"object","required":["type","message","code"],"title":"AgenticSearchServiceError","example":{"message":"The geometry is out of any supported area","type":"out-of-supported-area"}},"ZoningPlanSearchPaginatedResponse":{"properties":{"has_more":{"type":"boolean","title":"Has More","description":"If this is the last page then this is false, otherwise true","examples":[true]},"results":{"items":{"$ref":"#/components/schemas/StoredZoningPlanSearchResult"},"type":"array","title":"Results","description":"The list of zoning plan searches, without their status and result","examples":[[{"date_added":"2023-05-11T09:31:00.117Z","date_modified":"2023-05-11T09:31:00.117Z","project_id":"0b6f0d4e-5f4a-4c43-9d55-3f1f6a1c2e7b","property_identifier":"PROPERTY-DENW16AL00000PnI","research_id":"rsr_01K5XJ8Q2W3E4R5T6Y7U8I9O0P","zoning_plan_search_id":"4d2c8a0e-8f3b-4a8e-a1a5-2b7e9f0c6d11"}]]}},"type":"object","required":["has_more","results"],"title":"ZoningPlanSearchPaginatedResponse"},"ZoningPlanSearchQuota":{"properties":{"limit":{"type":"integer","title":"Limit","description":"The number of successful zoning plan searches a user can start per month","examples":[100]},"remaining":{"type":"integer","title":"Remaining","description":"The number of zoning plan searches the user can still start this month, with the `queued` and `running` searches counted as successful","examples":[3]},"queued":{"type":"integer","title":"Queued","description":"The number of zoning plan searches of the user waiting to start","examples":[1]},"running":{"type":"integer","title":"Running","description":"The number of zoning plan searches of the user in progress","examples":[0]},"renews_at":{"type":"string","format":"date-time","title":"Renews At","description":"When the quota renews, at the start of the next month in Europe/Berlin","examples":["2026-11-01T00:00:00+01:00"]}},"type":"object","required":["limit","remaining","queued","running","renews_at"],"title":"ZoningPlanSearchQuota"},"PushSubscription":{"properties":{"endpoint":{"type":"string","maxLength":2048,"pattern":"^https://","title":"Endpoint","description":"The `https` push service URL of the browser subscription, on the push service of Chrome, Firefox, Edge or Safari","examples":["https://fcm.googleapis.com/fcm/send/dpH5lCsTSSM:APA91bHqjZxM0VImWWqDRN7U0a3AycjUf4O-byuxb_wJsKRaKvV"]},"keys":{"$ref":"#/components/schemas/PushSubscriptionKeys","description":"The keys we encrypt the push for the browser with","examples":[{"auth":"tBHItJI5svbpez7KI4CCXg","p256dh":"BNcRdreALRFXTkOOUHK1EtK2wtaz5Ry4YfYCA_0QTpQtUbVlUls0VJXg7A8u-Ts1XbjhazAkj7I99e8QcYP7DkM"}]}},"type":"object","required":["endpoint","keys"],"title":"PushSubscription","description":"A browser push subscription in the shape of `PushSubscription.toJSON()`."},"RenovationCreationInputsRequest":{"properties":{"property_identifier":{"type":"string","title":"Property Identifier","description":"Property or custom property that is renovated","examples":["PROPERTY-DENW49AL00009b0v"]},"building_identifiers":{"items":{"type":"string"},"type":"array","title":"Building Identifiers","description":"Buildings that are renovated. Can comprise multiple building entities but the renovation will regard them as one building","examples":[["DENW49AL00009XTV","DENW49AL00009XAR"]]},"building_config":{"anyOf":[{"$ref":"#/components/schemas/RenovationBuildingDefaults"},{"type":"null"}],"description":"Building configuration for creation inuts","examples":[{"attic_conversion":"heated","basement":"heated","construction_year":1960,"rental_units":4,"roof_type":"Schrägdach","usable_area":1510,"volume":1845.3,"window_coverage":"medium"}]}},"type":"object","required":["property_identifier","building_identifiers"],"title":"RenovationCreationInputsRequest"},"RenovationCreationInputsResponse":{"properties":{"property_identifier":{"type":"string","title":"Property Identifier","description":"Property or custom property that is renovated","examples":["PROPERTY-DENW49AL00009b0v"]},"building_identifiers":{"items":{"type":"string"},"type":"array","title":"Building Identifiers","description":"Buildings that are renovated. Can comprise multiple building entities but the renovation will regard them as one building","examples":[["DENW49AL00009XTV","DENW49AL00009XAR"]]},"name":{"type":"string","title":"Name","description":"Name of the renovation. If not provided, the address will be set by default.","examples":["Fernholzstraße 33"]},"building_defaults":{"$ref":"#/components/schemas/RenovationBuildingDefaults","description":"Default building that can be used to restore input.building_config","examples":[{"attic_conversion":"heated","basement":"heated","construction_year":1960,"rental_units":4,"roof_type":"Schrägdach","usable_area":1510,"volume":1845.3,"window_coverage":"medium"}]},"existing_measures":{"$ref":"#/components/schemas/FlatRenovationMeasures","description":"Renovation measures that have already been applied","examples":[{"basement_wall_insulation":"kfw40","energy_storage":"balanced","heating_system":"heat_pump_air_to_water","roof_insulation":"kfw40","roof_pv":"balanced","ventilation_system":"standard","wall_insulation":"kfw40","windows":"kfw40"}]}},"type":"object","required":["property_identifier","building_identifiers","name","building_defaults","existing_measures"],"title":"RenovationCreationInputsResponse"},"RenovateError":{"properties":{"type":{"type":"string","const":"renovate-error","title":"Type","description":"Error type identifier.","examples":["renovate-error"]},"message":{"type":"string","title":"Message","description":"Human-readable English description of the renovation error.","examples":["Building is missing required data for input state"]},"errors":{"additionalProperties":true,"type":"object","title":"Errors","description":"Renovation error details keyed by error category (e.g. `missing_properties`, `invalid_measures`).","examples":[{"missing_properties":["volume","construction_year"]}]}},"type":"object","required":["type","message","errors"],"title":"RenovateError","example":{"errors":{"missing_properties":["volume","construction_year"]},"message":"Building is missing required data for input state","type":"renovate-error"}},"RenovationCreationRequest":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"UUID of the renovation. If not provided, a custom UUID will be generated","examples":["123e4567-e89b-12d3-a456-426614174000"]},"property_identifier":{"type":"string","title":"Property Identifier","description":"Property or custom property that is renovated","examples":["PROPERTY-DENW49AL00009b0v"]},"building_identifiers":{"items":{"type":"string"},"type":"array","title":"Building Identifiers","description":"Buildings that are renovated. Can comprise multiple building entities but the renovation will regard them as one building","examples":[["DENW49AL00009XTV","DENW49AL00009XAR"]]},"name":{"anyOf":[{"type":"string","description":"Name of the renovation. If not provided, the address will be set by default.","examples":["Fernholzstraße 33"]},{"type":"null"}],"title":"Name","description":"User-facing label for the renovation scenario. Falls back to the property address when omitted","examples":["Fernholzstraße 33"]},"project_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Project Id","description":"Optional identifier of the project this renovation belongs to. The project must be owned by the user and bound to the same property as this renovation","examples":["f3b5c2a0-4b1b-4b1b-8b1b-8b1b1b1b1b1b"]},"building_config":{"anyOf":[{"$ref":"#/components/schemas/RenovationBuildingConfig","description":"Config for building parameters used to simulate heat demand and simulate renovation measures","examples":[{"attic_conversion":"heated","basement":"heated","construction_year":1960,"rental_units":4,"roof_type":"Schrägdach","usable_area":1510,"volume":1845.3,"window_coverage":"medium"}]},{"type":"null"}],"description":"Overrides the building parameters used for the simulation. Defaults derived from cadastral and LoD2 data are used when omitted","examples":[{"attic_conversion":"heated","basement":"heated","construction_year":1960,"rental_units":4,"roof_type":"Schrägdach","usable_area":1510,"volume":1845.3,"window_coverage":"medium"}]},"existing_measures":{"anyOf":[{"$ref":"#/components/schemas/FlatRenovationMeasures","description":"Renovation measures that have already been applied","examples":[{"basement_wall_insulation":"kfw40","energy_storage":"balanced","heating_system":"heat_pump_air_to_water","roof_insulation":"kfw40","roof_pv":"balanced","ventilation_system":"standard","wall_insulation":"kfw40","windows":"kfw40"}]},{"type":"null"}],"description":"Renovation measures already applied to the building. Defaults inferred from `construction_year` are used when omitted","examples":[{"basement_wall_insulation":"kfw40","energy_storage":"balanced","heating_system":"heat_pump_air_to_water","roof_insulation":"kfw40","roof_pv":"balanced","ventilation_system":"standard","wall_insulation":"kfw40","windows":"kfw40"}]}},"type":"object","required":["property_identifier","building_identifiers"],"title":"RenovationCreationRequest"},"RenovationDetailedResponse":{"properties":{"property_identifier":{"type":"string","title":"Property Identifier","description":"Property or custom property that is renovated","examples":["PROPERTY-DENW49AL00009b0v"]},"building_identifiers":{"items":{"type":"string"},"type":"array","title":"Building Identifiers","description":"Buildings that are renovated. Can comprise multiple building entities but the renovation will regard them as one building","examples":[["DENW49AL00009XTV","DENW49AL00009XAR"]]},"id":{"type":"string","format":"uuid","title":"Id","description":"Renovation identifier","examples":["123e4567-e89b-12d3-a456-426614174000"]},"defaults":{"$ref":"#/components/schemas/RenovationDefaults","description":"Default values for the renovation","examples":[{"building_config":{"attic_conversion":"heated","basement":"heated","construction_year":1960,"rental_units":4,"roof_type":"Schrägdach","usable_area":1510,"volume":1845.3,"window_coverage":"medium"},"utility_costs":{"coal_per_kwh":0.05,"district_heating_per_kwh":0.05,"electricity_per_kwh":0.05,"gas_per_kwh":0.05,"oil_per_kwh":0.05,"pellets_per_kwh":0.05}}]},"available_renovation_measures":{"$ref":"#/components/schemas/RenovationAvailableMeasures","description":"All possible renovation measure that can be used in input.planned_measures","examples":[{"basement_ceiling_insulation":[{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw55"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw70"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw85"}],"basement_wall_insulation":[{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw55"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw70"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw85"}],"energy_storage":[{"config":{"cost":34000},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"balanced"}],"foundation_slab_insulation":[{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw55"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw70"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw85"}],"heating_system":[{"config":{"co2_emissions":0.28,"cost":34000,"cost_base":11716.25,"cost_per_kw":140.9019231,"efficiency":0.99,"primary_energy_factor":0.9},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{"power":4},"type":"heat_pump_air_to_water"},{"config":{"co2_emissions":0.28,"cost":34000,"cost_base":11716.25,"cost_per_kw":140.9019231,"efficiency":0.99,"primary_energy_factor":0.9},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{"power":4},"type":"pellet"},{"config":{"co2_emissions":0.28,"cost":34000,"cost_base":11716.25,"cost_per_kw":140.9019231,"efficiency":0.99,"primary_energy_factor":0.9},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{"power":4},"type":"district_heating"}],"roof_insulation":[{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw55"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw70"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw85"}],"roof_pv":[{"config":{"cost":34000},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"balanced"}],"ventilation_system":[{"config":{"cost":15000,"cost_per_sqm":100,"efficiency":0.8,"electricity_consumption_kwh_per_sqm":2.5},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{"efficiency":3.4},"type":"standard"}],"wall_insulation":[{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw55"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw70"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw85"}],"windows":[{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw55"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw70"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw85"}]}]},"output":{"$ref":"#/components/schemas/RenovationOutput","description":"The calculated renovation output","examples":[{"existing_state":{"energy_demand_label":"A+","energy_flow_graph":{"edges":[{"energy":500,"source":"pv_yield","target":"hot_water"}],"nodes":[{"energy":500,"id":"pv_yield","type":"production"}]},"kfw_efficiency_house":"70EE","primary_energy_factor":0.15,"transmission_loss_factor":0.15,"yearly_earnings_from_electricity_sold_total":350,"yearly_emissions_co2_kg_by_sqm":0.5,"yearly_emissions_co2_kg_total":1500,"yearly_end_energy_demand_kwh_by_sqm":121,"yearly_end_energy_demand_kwh_total":121,"yearly_heating_demand_kwh_by_sqm":125.5,"yearly_heating_demand_kwh_total":12500.5,"yearly_net_energy_hot_water_by_sqm":15.5,"yearly_net_energy_hot_water_total":1550.5,"yearly_primary_energy_demand_kwh_by_sqm":140,"yearly_primary_energy_demand_kwh_total":14000,"yearly_transmission_loss_kwh_by_sqm":137.5,"yearly_transmission_loss_kwh_total":13700.5,"yearly_utility_costs_timeline":[1000,2000,3000]},"planned_measures":{"basement_ceiling_insulation":{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},"basement_wall_insulation":{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},"energy_storage":{"config":{"cost":34000},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"balanced"},"foundation_slab_insulation":{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},"heating_system":{"config":{"co2_emissions":0.28,"cost":34000,"cost_base":11716.25,"cost_per_kw":140.9019231,"efficiency":0.99,"primary_energy_factor":0.9},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{"power":4},"type":"heat_pump_air_to_water"},"roof_insulation":{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},"roof_pv":{"config":{"cost":34000},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"balanced"},"ventilation_system":{"config":{"cost":15000,"cost_per_sqm":100,"efficiency":0.8,"electricity_consumption_kwh_per_sqm":2.5},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{"efficiency":3.4},"type":"standard"},"wall_insulation":{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},"windows":{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"}},"renovated_state":{"energy_demand_label":"A+","energy_flow_graph":{"edges":[{"energy":500,"source":"pv_yield","target":"hot_water"}],"nodes":[{"energy":500,"id":"pv_yield","type":"production"}]},"kfw_efficiency_house":"70EE","primary_energy_factor":0.15,"transmission_loss_factor":0.15,"yearly_earnings_from_electricity_sold_total":350,"yearly_emissions_co2_kg_by_sqm":0.5,"yearly_emissions_co2_kg_total":1500,"yearly_end_energy_demand_kwh_by_sqm":121,"yearly_end_energy_demand_kwh_total":121,"yearly_heating_demand_kwh_by_sqm":125.5,"yearly_heating_demand_kwh_total":12500.5,"yearly_net_energy_hot_water_by_sqm":15.5,"yearly_net_energy_hot_water_total":1550.5,"yearly_primary_energy_demand_kwh_by_sqm":140,"yearly_primary_energy_demand_kwh_total":14000,"yearly_transmission_loss_kwh_by_sqm":137.5,"yearly_transmission_loss_kwh_total":13700.5,"yearly_utility_costs_timeline":[1000,2000,3000]},"renovation_summary":{"amortisation_time":10,"costs_total":73350,"end_energy_savings_factor":0.59,"savings_from_electricity_sold_factor":0.15,"subsidies":[{"admission_method":"grant","conveyor_name":"KfW","details":{"base_percent":0.15,"ee_bonus_percent":0,"investment_cost":200000,"max_possible_credit":120000,"max_possible_subsidy":120000,"wpb_bonus_percent":0.1},"measures":["roof_insulation","wall_insulation","basement_ceiling_insulation","windows"],"subsidy_amount":20000,"subsidy_type":"efficiency_house","type":"efficiency_house_measures"}],"subsidies_kind_preference":"efficiency_house","subsidies_total":1400,"utility_costs_savings_factor":0.59,"yearly_earnings_from_electricity_sold_savings_total":350,"yearly_emissions_savings_co2_kg_by_sqm":0.25,"yearly_emissions_savings_co2_kg_total":12001,"yearly_end_energy_savings_kwh_by_sqm":12001,"yearly_end_energy_savings_kwh_total":12001,"yearly_utility_costs_savings_total":12001}}]},"version":{"type":"integer","title":"Version","description":"Version the stored results were computed with; 0 for renovations stored before versioning was introduced","default":1,"examples":[1]},"input":{"$ref":"#/components/schemas/RenovationInputRequest","description":"The renovation input provided as the request body","examples":[{"amortisation_interest":0.035,"building_config":{"attic_conversion":"heated","basement":"heated","construction_year":1960,"rental_units":4,"roof_type":"Schrägdach","usable_area":1510,"volume":1845.3,"window_coverage":"medium"},"custom_subsidies":[{"program_name":"local PV","subsidy_amount":20000}],"existing_measures":{"basement_wall_insulation":"kfw40","energy_storage":"balanced","heating_system":"heat_pump_air_to_water","roof_insulation":"kfw40","roof_pv":"balanced","ventilation_system":"standard","wall_insulation":"kfw40","windows":"kfw40"},"included_subsidies":"all","name":"Fernholzstraße 33","planned_measures":{"basement_wall_insulation":{"config":{"cost_by_sqm":139},"type":"kfw70"},"energy_storage":{"config":{"cost":34000},"type":"balanced"},"heating_system":{"type":"heat_pump_air_to_water"},"roof_insulation":{"config":{"cost_by_sqm":439},"type":"kfw70"},"roof_pv":{"config":{"cost":34000},"type":"balanced"},"ventilation_system":{"type":"standard"},"wall_insulation":{"config":{"cost_by_sqm":198},"type":"kfw70"},"windows":{"config":{"cost_by_sqm":1098},"type":"kfw70"}},"project_id":"f3b5c2a0-4b1b-4b1b-8b1b-8b1b1b1b1b1b","utility_costs":{"coal_per_kwh":0.05,"district_heating_per_kwh":0.05,"electricity_per_kwh":0.05,"gas_per_kwh":0.05,"oil_per_kwh":0.05,"pellets_per_kwh":0.05},"valuation":{"existing_state":{"selling_price_total":600000},"renovated_state":{"selling_price_total":600000}}}]}},"type":"object","required":["property_identifier","building_identifiers","id","defaults","available_renovation_measures","output","input"],"title":"RenovationDetailedResponse","description":"Full response for a renovation meant for detailed views."},"RenovationInputRequest":{"properties":{"project_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Project Id","description":"Optional identifier of the project this renovation belongs to. The project must be owned by the user and bound to the same property as this renovation","examples":["f3b5c2a0-4b1b-4b1b-8b1b-8b1b1b1b1b1b"]},"name":{"anyOf":[{"type":"string","description":"Name of the renovation. If not provided, the address will be set by default.","examples":["Fernholzstraße 33"]},{"type":"null"}],"title":"Name","description":"User-facing label for the renovation scenario. Falls back to the property address when omitted","examples":["Fernholzstraße 33"]},"existing_measures":{"$ref":"#/components/schemas/FlatRenovationMeasures","description":"Renovation measures that have already been applied","examples":[{"basement_wall_insulation":"kfw40","energy_storage":"balanced","heating_system":"heat_pump_air_to_water","roof_insulation":"kfw40","roof_pv":"balanced","ventilation_system":"standard","wall_insulation":"kfw40","windows":"kfw40"}]},"planned_measures":{"$ref":"#/components/schemas/PlannedRenovationMeasures","description":"Renovation measures to be applied in the renovation. In the response body `available_measures` contains details about all available measure","examples":[{"basement_wall_insulation":{"config":{"cost_by_sqm":139},"type":"kfw70"},"energy_storage":{"config":{"cost":34000},"type":"balanced"},"heating_system":{"type":"heat_pump_air_to_water"},"roof_insulation":{"config":{"cost_by_sqm":439},"type":"kfw70"},"roof_pv":{"config":{"cost":34000},"type":"balanced"},"ventilation_system":{"type":"standard"},"wall_insulation":{"config":{"cost_by_sqm":198},"type":"kfw70"},"windows":{"config":{"cost_by_sqm":1098},"type":"kfw70"}}]},"included_subsidies":{"type":"string","enum":["all","no","only_custom"],"title":"Included Subsidies","description":"`all` -> Compute all subsidy possibilities and add the total with the provided `custom_subsidies`; `no`: Skip subsidies computation and ignore `custom_subsidies`; `only_custom`: Skip subsidies computation and use provided subsidies only from `custom_subsidies`","default":"all","examples":["all"]},"custom_subsidies":{"items":{"$ref":"#/components/schemas/RenovationCustomSubsidy"},"type":"array","maxItems":6,"title":"Custom Subsidies","description":"User custom subsidies to be stored","examples":[[{"program_name":"local PV","subsidy_amount":20000}]]},"valuation":{"anyOf":[{"$ref":"#/components/schemas/RenovationValuationConfigStates"},{"type":"null"}],"description":"Config for the valuation of the building","examples":[{"existing_state":{"selling_price_total":600000},"renovated_state":{"selling_price_total":600000}}]},"amortisation_interest":{"type":"number","maximum":1,"minimum":0,"title":"Amortisation Interest","description":"Interest rate for the amortisation calculation","default":0.035,"examples":[0.035]},"building_config":{"$ref":"#/components/schemas/RenovationBuildingConfig","description":"Config for building parameters used to simulate heat demand and simulate renovation measures","examples":[{"attic_conversion":"heated","basement":"heated","construction_year":1960,"rental_units":4,"roof_type":"Schrägdach","usable_area":1510,"volume":1845.3,"window_coverage":"medium"}]},"utility_costs":{"$ref":"#/components/schemas/RenovationUtilityCosts","description":"Config for current utility costs per kWh for each type of energy source","examples":[{"coal_per_kwh":0.05,"district_heating_per_kwh":0.05,"electricity_per_kwh":0.05,"gas_per_kwh":0.05,"oil_per_kwh":0.05,"pellets_per_kwh":0.05}]}},"type":"object","required":["existing_measures","planned_measures","building_config","utility_costs"],"title":"RenovationInputRequest","description":"Attributes that a user can change."},"RenovationValuationResponse":{"properties":{"existing_state":{"$ref":"#/components/schemas/RenovationValuation","description":"Valuation of the building in the existing state (before renovation)","examples":[{"selling_price_by_sqm":4000,"selling_price_total":600000}]},"renovated_state":{"$ref":"#/components/schemas/RenovationValuation","description":"Valuation of the building in the renovated state (after renovation)","examples":[{"selling_price_by_sqm":4000,"selling_price_total":600000}]},"existing_state_overridden":{"anyOf":[{"$ref":"#/components/schemas/RenovationValuation"},{"type":"null"}],"description":"Custom valuation of the building in the existing state (before renovation)","examples":[{"selling_price_by_sqm":4000,"selling_price_total":600000}]},"renovated_state_overridden":{"anyOf":[{"$ref":"#/components/schemas/RenovationValuation"},{"type":"null"}],"description":"Custom valuation of the building in the renovated state (after renovation)","examples":[{"selling_price_by_sqm":4000,"selling_price_total":600000}]}},"type":"object","required":["existing_state","renovated_state"],"title":"RenovationValuationResponse"},"RenovationRecommendedMeasuresRequest":{"properties":{"property_identifier":{"type":"string","title":"Property Identifier","description":"Property or custom property that is renovated","examples":["PROPERTY-DENW49AL00009b0v"]},"building_identifiers":{"items":{"type":"string"},"type":"array","title":"Building Identifiers","description":"Buildings that are renovated. Can comprise multiple building entities but the renovation will regard them as one building","examples":[["DENW49AL00009XTV","DENW49AL00009XAR"]]},"existing_measures":{"anyOf":[{"$ref":"#/components/schemas/FlatRenovationMeasures","description":"Renovation measures that have already been applied","examples":[{"basement_wall_insulation":"kfw40","energy_storage":"balanced","heating_system":"heat_pump_air_to_water","roof_insulation":"kfw40","roof_pv":"balanced","ventilation_system":"standard","wall_insulation":"kfw40","windows":"kfw40"}]},{"type":"null"}],"description":"Renovation measures already applied to the building. Excluded from the recommendation search and treated as the starting point. Defaults inferred from `construction_year` are used when omitted","examples":[{"basement_wall_insulation":"kfw40","energy_storage":"balanced","heating_system":"heat_pump_air_to_water","roof_insulation":"kfw40","roof_pv":"balanced","ventilation_system":"standard","wall_insulation":"kfw40","windows":"kfw40"}]},"building_config":{"anyOf":[{"$ref":"#/components/schemas/RenovationBuildingConfig","description":"Config for building parameters used to simulate heat demand and simulate renovation measures","examples":[{"attic_conversion":"heated","basement":"heated","construction_year":1960,"rental_units":4,"roof_type":"Schrägdach","usable_area":1510,"volume":1845.3,"window_coverage":"medium"}]},{"type":"null"}],"description":"Overrides the building parameters used to evaluate measure combinations. Defaults derived from cadastral and LoD2 data are used when omitted","examples":[{"attic_conversion":"heated","basement":"heated","construction_year":1960,"rental_units":4,"roof_type":"Schrägdach","usable_area":1510,"volume":1845.3,"window_coverage":"medium"}]}},"type":"object","required":["property_identifier","building_identifiers"],"title":"RenovationRecommendedMeasuresRequest"},"RenovationRecommendedMeasuresResponse":{"properties":{"property_identifier":{"type":"string","title":"Property Identifier","description":"Property or custom property that is renovated","examples":["PROPERTY-DENW49AL00009b0v"]},"building_identifiers":{"items":{"type":"string"},"type":"array","title":"Building Identifiers","description":"Buildings that are renovated. Can comprise multiple building entities but the renovation will regard them as one building","examples":[["DENW49AL00009XTV","DENW49AL00009XAR"]]},"recommended_measures":{"items":{"$ref":"#/components/schemas/RenovationRecommendedMeasureCombination"},"type":"array","title":"Recommended Measures","description":"Progressively best measure combinations sorted ascending by investment cost over end-energy savings ratio","examples":[[{"cost":73350,"measures":{"basement_wall_insulation":{"config":{"cost_by_sqm":139},"type":"kfw70"},"energy_storage":{"config":{"cost":34000},"type":"balanced"},"heating_system":{"type":"heat_pump_air_to_water"},"roof_insulation":{"config":{"cost_by_sqm":439},"type":"kfw70"},"roof_pv":{"config":{"cost":34000},"type":"balanced"},"ventilation_system":{"type":"standard"},"wall_insulation":{"config":{"cost_by_sqm":198},"type":"kfw70"},"windows":{"config":{"cost_by_sqm":1098},"type":"kfw70"}},"subsidies_kind_preference":"efficiency_house","subsidies_total":1400,"yearly_end_energy_demand_kwh_by_sqm":121}]]}},"type":"object","required":["property_identifier","building_identifiers","recommended_measures"],"title":"RenovationRecommendedMeasuresResponse"},"RenovationEnergyDemandRequest":{"properties":{"property_identifier":{"type":"string","title":"Property Identifier","description":"Property or custom property that is renovated","examples":["PROPERTY-DENW49AL00009b0v"]},"building_identifiers":{"items":{"type":"string"},"type":"array","title":"Building Identifiers","description":"Buildings that are renovated. Can comprise multiple building entities but the renovation will regard them as one building","examples":[["DENW49AL00009XTV","DENW49AL00009XAR"]]},"building_config":{"anyOf":[{"$ref":"#/components/schemas/RenovationBuildingConfig","description":"Config for building parameters used to simulate heat demand and simulate renovation measures","examples":[{"attic_conversion":"heated","basement":"heated","construction_year":1960,"rental_units":4,"roof_type":"Schrägdach","usable_area":1510,"volume":1845.3,"window_coverage":"medium"}]},{"type":"null"}],"description":"Overrides the building parameters used to compute the energy demand. Defaults derived from cadastral and LoD2 data are used when omitted","examples":[{"attic_conversion":"heated","basement":"heated","construction_year":1960,"rental_units":4,"roof_type":"Schrägdach","usable_area":1510,"volume":1845.3,"window_coverage":"medium"}]},"existing_measures":{"anyOf":[{"$ref":"#/components/schemas/FlatRenovationMeasures","description":"Renovation measures that have already been applied","examples":[{"basement_wall_insulation":"kfw40","energy_storage":"balanced","heating_system":"heat_pump_air_to_water","roof_insulation":"kfw40","roof_pv":"balanced","ventilation_system":"standard","wall_insulation":"kfw40","windows":"kfw40"}]},{"type":"null"}],"description":"Renovation measures already applied to the building. Defaults inferred from `construction_year` are used when omitted","examples":[{"basement_wall_insulation":"kfw40","energy_storage":"balanced","heating_system":"heat_pump_air_to_water","roof_insulation":"kfw40","roof_pv":"balanced","ventilation_system":"standard","wall_insulation":"kfw40","windows":"kfw40"}]}},"type":"object","required":["property_identifier","building_identifiers"],"title":"RenovationEnergyDemandRequest"},"RenovationOutputState":{"properties":{"transmission_loss_factor":{"type":"number","title":"Transmission Loss Factor","description":"Percentage of transmission loss in relation to the reference building","examples":[0.15]},"yearly_transmission_loss_kwh_by_sqm":{"type":"number","title":"Yearly Transmission Loss Kwh By Sqm","description":"Transmission loss per square meter (Transmissionswärmeverlust). Determines the KfW class label together with primary energy demand","examples":[137.5]},"yearly_transmission_loss_kwh_total":{"type":"number","title":"Yearly Transmission Loss Kwh Total","description":"Total transmission loss (Transmissionswärmeverlust). Determines the KfW class label together with primary energy demand","examples":[13700.5]},"yearly_heating_demand_kwh_by_sqm":{"type":"number","title":"Yearly Heating Demand Kwh By Sqm","description":"Energy demand per square meter needed for heating after taking heat gains into account (Heizwärmebedarf)","examples":[125.5]},"yearly_heating_demand_kwh_total":{"type":"number","title":"Yearly Heating Demand Kwh Total","description":"Total energy demand needed for heating after taking heat gains into account (Heizwärmebedarf)","examples":[12500.5]},"primary_energy_factor":{"type":"number","title":"Primary Energy Factor","description":"Percentage of primary energy demand in relation to the reference building","examples":[0.15]},"yearly_primary_energy_demand_kwh_by_sqm":{"type":"number","title":"Yearly Primary Energy Demand Kwh By Sqm","description":"Primary energy demand per square meter (Primärenergiebedarf). Determines the KfW class label together with transmission loss","examples":[140]},"yearly_primary_energy_demand_kwh_total":{"type":"number","title":"Yearly Primary Energy Demand Kwh Total","description":"Total primary energy demand (Primärenergiebedarf). Determines the KfW class label together with transmission loss","examples":[14000]},"yearly_end_energy_demand_kwh_by_sqm":{"type":"number","title":"Yearly End Energy Demand Kwh By Sqm","description":"End energy demand per square meter (Endenergiebedarf). Determines the energy efficiency label. Includes demands for heating and hot water.","examples":[121]},"yearly_end_energy_demand_kwh_total":{"type":"number","title":"Yearly End Energy Demand Kwh Total","description":"Total end energy demand (Endenergiebedarf). Determines the energy efficiency label. Includes demands for heating and hot water","examples":[121]},"yearly_emissions_co2_kg_by_sqm":{"type":"number","title":"Yearly Emissions Co2 Kg By Sqm","description":"Co2 emissions per square meter","examples":[0.5]},"yearly_emissions_co2_kg_total":{"type":"number","title":"Yearly Emissions Co2 Kg Total","description":"Total co2 emissions","examples":[1500]},"yearly_net_energy_hot_water_by_sqm":{"type":"number","title":"Yearly Net Energy Hot Water By Sqm","description":"Hot water demand per square meter","examples":[15.5]},"yearly_net_energy_hot_water_total":{"type":"number","title":"Yearly Net Energy Hot Water Total","description":"Total hot water demand","examples":[1550.5]},"yearly_earnings_from_electricity_sold_total":{"type":"number","title":"Yearly Earnings From Electricity Sold Total","description":"Annual EUR earnings from excess PV electricity sold to grid using feed-in tariffs","examples":[350]},"energy_demand_label":{"type":"string","enum":["A+","A","B","C","D","E","F","G","H"],"title":"Energy Demand Label","description":"Energy efficiency class","examples":["A+"]},"kfw_efficiency_house":{"anyOf":[{"$ref":"#/components/schemas/KfwEfficiencyHouseType","description":"KfW efficiency house type.","examples":["40","55","70","85","100","115","160"]},{"type":"null"}],"description":"KfW efficiency standard","examples":["70EE"]},"yearly_utility_costs_timeline":{"items":{"type":"number"},"type":"array","title":"Yearly Utility Costs Timeline","description":"Predicted utility cost for each year in EUR (20 elements)","examples":[[1000,2000,3000]]},"energy_flow_graph":{"$ref":"#/components/schemas/SankeyDiagramGraph","description":"The Sankey-style energy flow graph for this state","examples":[{"edges":[{"energy":500,"source":"pv_yield","target":"hot_water"}],"nodes":[{"energy":500,"id":"pv_yield","type":"production"}]}]}},"type":"object","required":["transmission_loss_factor","yearly_transmission_loss_kwh_by_sqm","yearly_transmission_loss_kwh_total","yearly_heating_demand_kwh_by_sqm","yearly_heating_demand_kwh_total","primary_energy_factor","yearly_primary_energy_demand_kwh_by_sqm","yearly_primary_energy_demand_kwh_total","yearly_end_energy_demand_kwh_by_sqm","yearly_end_energy_demand_kwh_total","yearly_emissions_co2_kg_by_sqm","yearly_emissions_co2_kg_total","yearly_net_energy_hot_water_by_sqm","yearly_net_energy_hot_water_total","yearly_earnings_from_electricity_sold_total","energy_demand_label","kfw_efficiency_house","energy_flow_graph"],"title":"RenovationOutputState"},"DownloadRequestResponse":{"properties":{"status":{"type":"string","const":"success","title":"Status","description":"Status of the download request","default":"success","examples":["success"]},"download_token":{"type":"string","title":"Download Token","description":"The download token that can be used as a url param for a cadastral endpoint.","examples":["eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9"]}},"type":"object","required":["download_token"],"title":"DownloadRequestResponse"},"KfwEfficiencyHouseType":{"type":"string","enum":["40","55","70","85","100","115","160","40EE","55EE","70EE","85EE","100EE","115EE","160EE","40NH","55NH","70NH","85NH","100NH","115NH","160NH","wpb"],"title":"KfwEfficiencyHouseType"},"SankeyDiagramGraph":{"properties":{"nodes":{"items":{"$ref":"#/components/schemas/SankeyDiagramNode"},"type":"array","title":"Nodes","description":"Array of objects describing an energy node and it's consumption or supply in kWh","examples":[[{"energy":500,"id":"pv_yield","type":"production"}]]},"edges":{"items":{"$ref":"#/components/schemas/SankeyDiagramEdge"},"type":"array","title":"Edges","description":"Array of objects linking two nodes each. Only edges for the available nodes are present but they are always the same","examples":[[{"energy":500,"source":"pv_yield","target":"hot_water"}]]}},"type":"object","title":"SankeyDiagramGraph"},"SankeyDiagramNode":{"properties":{"id":{"$ref":"#/components/schemas/NodeIds","description":"Unique energy node identifier from NodeIds enum","examples":["pv_yield"]},"type":{"$ref":"#/components/schemas/NodeTypes","description":"Energy node type: production, grid, or consumption","examples":["production"]},"energy":{"type":"number","title":"Energy","description":"Energy generated or consumed by the node in kWh","examples":[500]}},"type":"object","required":["id","type","energy"],"title":"SankeyDiagramNode"},"SankeyDiagramEdge":{"properties":{"source":{"type":"string","title":"Source","description":"Source energy node id (where energy is coming from)","examples":["pv_yield"]},"target":{"type":"string","title":"Target","description":"Target energy node id (where the energy is consumed)","examples":["hot_water"]},"energy":{"type":"number","title":"Energy","description":"Amount of energy transferred by the link in kWh","examples":[500]}},"type":"object","required":["source","target","energy"],"title":"SankeyDiagramEdge"},"NodeIds":{"type":"string","enum":["pv_yield","battery_charge","grid_feed_in","grid_electricity_supply","heating","hot_water","household_electricity","ventilation_consumption","direct_electricity_consumption","direct_other_consumption","grid_gas_supply","district_heating_supply","coal_supply","pellets_supply","oil_supply"],"title":"NodeIds"},"NodeTypes":{"type":"string","enum":["consumption","production","grid"],"title":"NodeTypes"},"RenovationBuildingConfig":{"properties":{"usable_area":{"type":"number","minimum":0,"title":"Usable Area","description":"The usable area - initialized depending on attic_conversion and basement values","examples":[1510]},"rental_units":{"type":"integer","minimum":0,"title":"Rental Units","description":"Number of rental units - initialized by assuming 70 square meters per unit","examples":[4]},"volume":{"type":"number","minimum":0,"title":"Volume","description":"Total volume of the building in cubic meters","examples":[1845.3]},"roof_type":{"$ref":"#/components/schemas/RoofType","description":"Roof type - initial value is 'Schrägdach' for all types of of roof_type_lod2 except for 'Flachdach","examples":["Schrägdach"]},"window_coverage":{"$ref":"#/components/schemas/WindowCoverageType","description":"Category for the percentage of how much uncovered facade area is assumed as window area. Possible values are: small: 22%, medium: 30%, big: 45%","examples":["medium"]},"attic_conversion":{"$ref":"#/components/schemas/HeatingType","description":"Indicates if the attic is converted and heated","default":"heated","examples":["heated"]},"basement":{"$ref":"#/components/schemas/HeatingType","description":"Indicates if there is a basement and it is heated","default":"heated","examples":["heated"]},"construction_year":{"type":"integer","exclusiveMinimum":0,"title":"Construction Year","description":"Construction year of the building - initial value is the mean of construction year class of the largest building and the origin as a fallback","examples":[1960]}},"type":"object","required":["usable_area","rental_units","volume","roof_type","window_coverage","construction_year"],"title":"RenovationBuildingConfig"},"FlatRenovationMeasures":{"properties":{"heating_system":{"$ref":"#/components/schemas/HeatingSystemType","description":"Installed heating system","default":"gas","examples":["heat_pump_air_to_water","pellet","district_heating"]},"roof_insulation":{"anyOf":[{"$ref":"#/components/schemas/InsulationType"},{"type":"null"}],"description":"Installed roof insulation","examples":[null,"kfw40","kfw55","kfw70","kfw85"]},"wall_insulation":{"anyOf":[{"$ref":"#/components/schemas/InsulationType"},{"type":"null"}],"description":"Installed wall insulation according to a KfW standard","examples":[null,"kfw40","kfw55","kfw70","kfw85"]},"basement_ceiling_insulation":{"anyOf":[{"$ref":"#/components/schemas/InsulationType"},{"type":"null"}],"description":"Installed basement ceiling insulation according to a KfW standard","examples":[null,"kfw40","kfw55","kfw70","kfw85"]},"basement_wall_insulation":{"anyOf":[{"$ref":"#/components/schemas/InsulationType"},{"type":"null"}],"description":"Installed basement wall insulation according to a KfW standard","examples":[null,"kfw40","kfw55","kfw70","kfw85"]},"foundation_slab_insulation":{"anyOf":[{"$ref":"#/components/schemas/InsulationType"},{"type":"null"}],"description":"Installed foundation slab insulation according to a KfW standard","examples":[null,"kfw40","kfw55","kfw70","kfw85"]},"windows":{"anyOf":[{"$ref":"#/components/schemas/InsulationType"},{"type":"null"}],"description":"Installed windows according to a KfW standard","examples":[null,"kfw40","kfw55","kfw70","kfw85"]},"roof_pv":{"anyOf":[{"$ref":"#/components/schemas/RoofPVType"},{"type":"null"}],"description":"Installed photovoltaic system","examples":[null,"balanced"]},"energy_storage":{"anyOf":[{"$ref":"#/components/schemas/EnergyStorageType"},{"type":"null"}],"description":"Installed energy storage","examples":[null,"balanced"]},"ventilation_system":{"anyOf":[{"$ref":"#/components/schemas/VentilationSystemType"},{"type":"null"}],"description":"Installed ventilation system","examples":[null,"standard"]}},"type":"object","title":"FlatRenovationMeasures"},"HeatingSystemType":{"type":"string","enum":["coal","oil","gas","heat_pump_air_to_water","pellet","district_heating","electricity"],"title":"HeatingSystemType"},"InsulationType":{"type":"string","enum":["kfw40","kfw55","kfw70","kfw85","kfw100","kfw115","kfw160"],"title":"InsulationType"},"RoofPVType":{"type":"string","enum":["balanced"],"title":"RoofPVType"},"EnergyStorageType":{"type":"string","enum":["balanced"],"title":"EnergyStorageType"},"VentilationSystemType":{"type":"string","enum":["standard"],"title":"VentilationSystemType"},"RoofType":{"type":"string","enum":["Schrägdach","Flachdach"]},"WindowCoverageType":{"type":"string","enum":["small","medium","large"],"title":"WindowCoverageType"},"HeatingType":{"type":"string","enum":["heated","unheated","no"],"title":"HeatingType"},"RenovationRecommendedMeasureCombination":{"properties":{"subsidies_total":{"type":"integer","minimum":0,"title":"Subsidies Total","description":"Subsidies in EUR","examples":[1400]},"subsidies_kind_preference":{"anyOf":[{"type":"string","enum":["efficiency_house","individual","only_custom","none"],"description":"Preferred subsidy kind based on the highest return value","examples":["efficiency_house","individual","only_custom","none"]},{"type":"null"}],"title":"Subsidies Kind Preference","description":"Subsidy kind selected as the highest-yielding option for this measure combination. `None` when no subsidies apply or when subsidies are disabled","examples":["efficiency_house"]},"cost":{"type":"integer","minimum":0,"title":"Cost","description":"Total cost for all renovation measures without the subsidies deduction (in EUR)","examples":[73350]},"yearly_end_energy_demand_kwh_by_sqm":{"type":"number","title":"Yearly End Energy Demand Kwh By Sqm","description":"End energy demand per square meter (Endenergiebedarf). Determines the energy efficiency label. Includes demands for heating and hot water.","examples":[121]},"measures":{"$ref":"#/components/schemas/PlannedRenovationMeasures","description":"The recommended combination of renovation measures","examples":[{"basement_wall_insulation":{"config":{"cost_by_sqm":139},"type":"kfw70"},"energy_storage":{"config":{"cost":34000},"type":"balanced"},"heating_system":{"type":"heat_pump_air_to_water"},"roof_insulation":{"config":{"cost_by_sqm":439},"type":"kfw70"},"roof_pv":{"config":{"cost":34000},"type":"balanced"},"ventilation_system":{"type":"standard"},"wall_insulation":{"config":{"cost_by_sqm":198},"type":"kfw70"},"windows":{"config":{"cost_by_sqm":1098},"type":"kfw70"}}]}},"type":"object","required":["subsidies_total","subsidies_kind_preference","cost","yearly_end_energy_demand_kwh_by_sqm","measures"],"title":"RenovationRecommendedMeasureCombination"},"PlannedRenovationMeasures":{"properties":{"heating_system":{"anyOf":[{"$ref":"#/components/schemas/HeatingSystemRenovationMeasure_HeatingSystemType_"},{"type":"null"}],"description":"New heating system to be installed","examples":[{"type":"heat_pump_air_to_water"},{"type":"pellet"},{"type":"district_heating"}]},"roof_insulation":{"anyOf":[{"$ref":"#/components/schemas/InsulationRenovationMeasure_InsulationType_"},{"type":"null"}],"description":"New roof insulation to be installed","examples":[{"config":{"cost_by_sqm":439},"type":"kfw70"}]},"wall_insulation":{"anyOf":[{"$ref":"#/components/schemas/InsulationRenovationMeasure_InsulationType_"},{"type":"null"}],"description":"New wall insulation according to a KfW standard to be installed","examples":[{"config":{"cost_by_sqm":198},"type":"kfw70"}]},"basement_ceiling_insulation":{"anyOf":[{"$ref":"#/components/schemas/InsulationRenovationMeasure_InsulationType_"},{"type":"null"}],"description":"New basement ceiling insulation according to a KfW standard to be installed","examples":[null]},"basement_wall_insulation":{"anyOf":[{"$ref":"#/components/schemas/InsulationRenovationMeasure_InsulationType_"},{"type":"null"}],"description":"New basement wall insulation according to a KfW standard to be installed","examples":[{"config":{"cost_by_sqm":139},"type":"kfw70"}]},"foundation_slab_insulation":{"anyOf":[{"$ref":"#/components/schemas/InsulationRenovationMeasure_InsulationType_"},{"type":"null"}],"description":"New foundation slab insulation according to a KfW standard to be installed","examples":[null]},"windows":{"anyOf":[{"$ref":"#/components/schemas/InsulationRenovationMeasure_InsulationType_"},{"type":"null"}],"description":"New windows according to a KfW standard to be installed","examples":[{"config":{"cost_by_sqm":1098},"type":"kfw70"}]},"roof_pv":{"anyOf":[{"$ref":"#/components/schemas/TechnicalRenovationMeasure_RoofPVType_"},{"type":"null"}],"description":"New photovoltaic system to be installed","examples":[{"config":{"cost":34000},"type":"balanced"}]},"energy_storage":{"anyOf":[{"$ref":"#/components/schemas/TechnicalRenovationMeasure_EnergyStorageType_"},{"type":"null"}],"description":"New energy storage to be installed","examples":[{"config":{"cost":34000},"type":"balanced"}]},"ventilation_system":{"anyOf":[{"$ref":"#/components/schemas/VentilationSystemRenovationMeasure_VentilationSystemType_"},{"type":"null"}],"description":"New ventilation system to be installed","examples":[{"type":"standard"}]}},"type":"object","title":"PlannedRenovationMeasures"},"HeatingSystemRenovationMeasure_HeatingSystemType_":{"properties":{"type":{"$ref":"#/components/schemas/HeatingSystemType","description":"Type of the renovation measure"},"config":{"anyOf":[{"$ref":"#/components/schemas/HeatingSystemConfig"},{"type":"null"}],"description":"Additional configuration of the heating system renovation measure "}},"type":"object","required":["type"],"title":"HeatingSystemRenovationMeasure[HeatingSystemType]"},"InsulationRenovationMeasure_InsulationType_":{"properties":{"type":{"$ref":"#/components/schemas/InsulationType","description":"Type of the renovation measure"},"config":{"anyOf":[{"$ref":"#/components/schemas/InsulationMeasureConfig"},{"type":"null"}],"description":"Additional configuration of the renovation measure ","examples":[{"cost_by_sqm":439}]}},"type":"object","required":["type"],"title":"InsulationRenovationMeasure[InsulationType]"},"TechnicalRenovationMeasure_RoofPVType_":{"properties":{"type":{"$ref":"#/components/schemas/RoofPVType","description":"Type of the renovation measure"},"config":{"anyOf":[{"$ref":"#/components/schemas/CostConfig"},{"type":"null"}],"description":"Additional configuration of the renovation measure ","examples":[{"cost":34000}]}},"type":"object","required":["type"],"title":"TechnicalRenovationMeasure[RoofPVType]"},"TechnicalRenovationMeasure_EnergyStorageType_":{"properties":{"type":{"$ref":"#/components/schemas/EnergyStorageType","description":"Type of the renovation measure"},"config":{"anyOf":[{"$ref":"#/components/schemas/CostConfig"},{"type":"null"}],"description":"Additional configuration of the renovation measure ","examples":[{"cost":34000}]}},"type":"object","required":["type"],"title":"TechnicalRenovationMeasure[EnergyStorageType]"},"VentilationSystemRenovationMeasure_VentilationSystemType_":{"properties":{"type":{"$ref":"#/components/schemas/VentilationSystemType","description":"Type of the renovation measure"},"config":{"anyOf":[{"$ref":"#/components/schemas/VentilationSystemConfig"},{"type":"null"}],"description":"Additional configuration of the ventilation system renovation measure "}},"type":"object","required":["type"],"title":"VentilationSystemRenovationMeasure[VentilationSystemType]"},"VentilationSystemConfig":{"properties":{"cost":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Cost","description":"Custom cost for the measure in EUR","examples":[15000]},"efficiency":{"anyOf":[{"type":"number","maximum":1,"exclusiveMinimum":0},{"type":"null"}],"title":"Efficiency","description":"Heat recovery efficiency of the ventilation system as a ratio (e.g., 0.80 = 80% efficient)","examples":[0.8]},"electricity_consumption_kwh_per_sqm":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Electricity Consumption Kwh Per Sqm","description":"Annual electricity consumption per square meter of usable area in kWh/m²","examples":[2.5]},"cost_per_sqm":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Cost Per Sqm","description":"Installation cost per square meter in EUR/m²","examples":[100]}},"type":"object","title":"VentilationSystemConfig"},"CostConfig":{"properties":{"cost":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Cost","description":"Custom cost for the measure in EUR","examples":[34000]}},"type":"object","required":["cost"],"title":"CostConfig"},"InsulationMeasureConfig":{"properties":{"cost_by_sqm":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Cost By Sqm","description":"Custom cost in EUR per square meter","examples":[439]}},"type":"object","title":"InsulationMeasureConfig"},"HeatingSystemConfig":{"properties":{"cost":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Cost","description":"Custom cost for the measure in EUR","examples":[34000]},"primary_energy_factor":{"anyOf":[{"type":"number","exclusiveMinimum":0},{"type":"null"}],"title":"Primary Energy Factor","description":"Primary energy factor indicating the ratio of primary to delivered energy. Lower values represent more efficient energy sources.","examples":[0.9]},"cost_per_kw":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Cost Per Kw","description":"Operating cost per kilowatt for the heating system in EUR/kW. Note: For heat_pump_air_to_water, this is combined with cost_per_kw using a non-linear formula to create a better cost estimate.","examples":[140.9019231]},"cost_base":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Cost Base","description":"Base installation cost for the heating system in EUR. Note: For heat_pump_air_to_water, this is combined with cost_per_kw using a non-linear formula to create a better cost estimate.","examples":[11716.25]},"efficiency":{"anyOf":[{"type":"number","exclusiveMinimum":0},{"type":"null"}],"title":"Efficiency","description":"Energy efficiency of the heating system as a ratio (e.g., 0.90 = 90% efficient)","examples":[0.99]},"co2_emissions":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Co2 Emissions","description":"CO2 emission factor per kilowatt-hour in kg CO2/kWh","examples":[0.28]}},"type":"object","title":"HeatingSystemConfig"},"RenovationValuation":{"properties":{"selling_price_by_sqm":{"type":"integer","title":"Selling Price By Sqm","description":"Selling price per square meter rental space (Verkaufspreis)","examples":[4000]},"selling_price_total":{"type":"integer","title":"Selling Price Total","description":"Total selling price (Verkaufspreis)","examples":[600000]}},"type":"object","required":["selling_price_by_sqm","selling_price_total"],"title":"RenovationValuation"},"RenovationCustomSubsidy":{"properties":{"program_name":{"type":"string","title":"Program Name","description":"Custom name for the subsidy program","examples":["local PV"]},"subsidy_amount":{"type":"integer","minimum":0,"title":"Subsidy Amount","description":"Subsidy amount in euros","examples":[20000]}},"type":"object","required":["program_name","subsidy_amount"],"title":"RenovationCustomSubsidy"},"RenovationValuationConfigStates":{"properties":{"existing_state":{"$ref":"#/components/schemas/RenovationValuationConfig","description":"Valuation of the building in the existing state (before renovation)","examples":[{"selling_price_total":600000}]},"renovated_state":{"$ref":"#/components/schemas/RenovationValuationConfig","description":"Valuation of the building in the renovated state (after renovation)","examples":[{"selling_price_total":600000}]}},"type":"object","required":["existing_state","renovated_state"],"title":"RenovationValuationConfigStates"},"RenovationUtilityCosts":{"properties":{"gas_per_kwh":{"type":"number","title":"Gas Per Kwh","description":"Current cost of gas as a heating source in EUR per kWh","examples":[0.05]},"coal_per_kwh":{"type":"number","title":"Coal Per Kwh","description":"Current cost of coal as a heating source in EUR per kWh","examples":[0.05]},"electricity_per_kwh":{"type":"number","title":"Electricity Per Kwh","description":"Current cost of electricity as a heating source in EUR per kWh","examples":[0.05]},"pellets_per_kwh":{"type":"number","title":"Pellets Per Kwh","description":"Current cost of pellet as a heating source in EUR per kWh","examples":[0.05]},"district_heating_per_kwh":{"type":"number","title":"District Heating Per Kwh","description":"Current cost of district heating as a heating source in EUR per kWh","examples":[0.05]},"oil_per_kwh":{"type":"number","title":"Oil Per Kwh","description":"Current cost of oil as a heating source in EUR per kWh","examples":[0.05]}},"type":"object","required":["gas_per_kwh","coal_per_kwh","electricity_per_kwh","pellets_per_kwh","district_heating_per_kwh","oil_per_kwh"],"title":"RenovationUtilityCosts"},"RenovationValuationConfig":{"properties":{"selling_price_total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Selling Price Total","description":"Override the valuation total selling price (Verkaufspreis) in EUR.","examples":[600000]}},"type":"object","required":["selling_price_total"],"title":"RenovationValuationConfig"},"RenovationDefaults":{"properties":{"building_config":{"$ref":"#/components/schemas/RenovationBuildingDefaults","description":"Default building that can be used to restore input.building_config","examples":[{"attic_conversion":"heated","basement":"heated","construction_year":1960,"rental_units":4,"roof_type":"Schrägdach","usable_area":1510,"volume":1845.3,"window_coverage":"medium"}]},"utility_costs":{"$ref":"#/components/schemas/RenovationUtilityCosts","description":"Config for current utility costs per kWh for each type of energy source","examples":[{"coal_per_kwh":0.05,"district_heating_per_kwh":0.05,"electricity_per_kwh":0.05,"gas_per_kwh":0.05,"oil_per_kwh":0.05,"pellets_per_kwh":0.05}]}},"type":"object","required":["building_config","utility_costs"],"title":"RenovationDefaults"},"RenovationAvailableMeasures":{"properties":{"heating_system":{"items":{"$ref":"#/components/schemas/AvailableTechnicalMeasureHeatingSystem"},"type":"array","title":"Heating System","description":"Possible heating systems","examples":[[{"config":{"co2_emissions":0.28,"cost":34000,"cost_base":11716.25,"cost_per_kw":140.9019231,"efficiency":0.99,"primary_energy_factor":0.9},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{"power":4},"type":"heat_pump_air_to_water"},{"config":{"co2_emissions":0.28,"cost":34000,"cost_base":11716.25,"cost_per_kw":140.9019231,"efficiency":0.99,"primary_energy_factor":0.9},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{"power":4},"type":"pellet"},{"config":{"co2_emissions":0.28,"cost":34000,"cost_base":11716.25,"cost_per_kw":140.9019231,"efficiency":0.99,"primary_energy_factor":0.9},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{"power":4},"type":"district_heating"}]]},"roof_insulation":{"items":{"$ref":"#/components/schemas/AvailableInsulationMeasure"},"type":"array","title":"Roof Insulation","description":"Possible roof insulation","examples":[[{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw55"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw70"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw85"}]]},"wall_insulation":{"items":{"$ref":"#/components/schemas/AvailableInsulationMeasure"},"type":"array","title":"Wall Insulation","description":"Possible wall insulation","examples":[[{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw55"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw70"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw85"}]]},"basement_ceiling_insulation":{"items":{"$ref":"#/components/schemas/AvailableInsulationMeasure"},"type":"array","title":"Basement Ceiling Insulation","description":"Possible basement ceiling insulation","examples":[[{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw55"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw70"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw85"}]]},"basement_wall_insulation":{"items":{"$ref":"#/components/schemas/AvailableInsulationMeasure"},"type":"array","title":"Basement Wall Insulation","description":"Possible basement wall insulation","examples":[[{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw55"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw70"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw85"}]]},"foundation_slab_insulation":{"items":{"$ref":"#/components/schemas/AvailableInsulationMeasure"},"type":"array","title":"Foundation Slab Insulation","description":"Possible foundation slab insulation","examples":[[{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw55"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw70"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw85"}]]},"windows":{"items":{"$ref":"#/components/schemas/AvailableInsulationMeasure"},"type":"array","title":"Windows","description":"Possible new windows","examples":[[{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw55"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw70"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw85"}]]},"roof_pv":{"items":{"$ref":"#/components/schemas/AvailableTechnicalMeasureRoofPV"},"type":"array","title":"Roof Pv","description":"Possible pv installation","examples":[[{"config":{"cost":34000},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"balanced"}]]},"energy_storage":{"items":{"$ref":"#/components/schemas/AvailableTechnicalMeasureEnergyStorage"},"type":"array","title":"Energy Storage","description":"Possible energy storage installation","examples":[[{"config":{"cost":34000},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"balanced"}]]},"ventilation_system":{"items":{"$ref":"#/components/schemas/AvailableTechnicalMeasureVentilationSystem"},"type":"array","title":"Ventilation System","description":"Possible ventilation system installation","examples":[[{"config":{"cost":15000,"cost_per_sqm":100,"efficiency":0.8,"electricity_consumption_kwh_per_sqm":2.5},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{"efficiency":3.4},"type":"standard"}]]}},"type":"object","required":["heating_system","roof_insulation","wall_insulation","basement_ceiling_insulation","basement_wall_insulation","foundation_slab_insulation","windows","roof_pv","energy_storage","ventilation_system"],"title":"RenovationAvailableMeasures"},"RenovationOutput":{"properties":{"planned_measures":{"$ref":"#/components/schemas/RenovationOutputPlannedMeasures","description":"A summary of the planned measures for the renovation including calculated costs and subsidies","examples":[{"basement_ceiling_insulation":{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},"basement_wall_insulation":{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},"energy_storage":{"config":{"cost":34000},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"balanced"},"foundation_slab_insulation":{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},"heating_system":{"config":{"co2_emissions":0.28,"cost":34000,"cost_base":11716.25,"cost_per_kw":140.9019231,"efficiency":0.99,"primary_energy_factor":0.9},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{"power":4},"type":"heat_pump_air_to_water"},"roof_insulation":{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},"roof_pv":{"config":{"cost":34000},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"balanced"},"ventilation_system":{"config":{"cost":15000,"cost_per_sqm":100,"efficiency":0.8,"electricity_consumption_kwh_per_sqm":2.5},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{"efficiency":3.4},"type":"standard"},"wall_insulation":{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},"windows":{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"}}]},"existing_state":{"$ref":"#/components/schemas/RenovationOutputState","description":"Calculated outputs of the existing state (before renovation)","examples":[{"energy_demand_label":"A+","energy_flow_graph":{"edges":[{"energy":500,"source":"pv_yield","target":"hot_water"}],"nodes":[{"energy":500,"id":"pv_yield","type":"production"}]},"kfw_efficiency_house":"70EE","primary_energy_factor":0.15,"transmission_loss_factor":0.15,"yearly_earnings_from_electricity_sold_total":350,"yearly_emissions_co2_kg_by_sqm":0.5,"yearly_emissions_co2_kg_total":1500,"yearly_end_energy_demand_kwh_by_sqm":121,"yearly_end_energy_demand_kwh_total":121,"yearly_heating_demand_kwh_by_sqm":125.5,"yearly_heating_demand_kwh_total":12500.5,"yearly_net_energy_hot_water_by_sqm":15.5,"yearly_net_energy_hot_water_total":1550.5,"yearly_primary_energy_demand_kwh_by_sqm":140,"yearly_primary_energy_demand_kwh_total":14000,"yearly_transmission_loss_kwh_by_sqm":137.5,"yearly_transmission_loss_kwh_total":13700.5,"yearly_utility_costs_timeline":[1000,2000,3000]}]},"renovated_state":{"$ref":"#/components/schemas/RenovationOutputState","description":"Calculated outputs of the renovated state (after renovation)","examples":[{"energy_demand_label":"A+","energy_flow_graph":{"edges":[{"energy":500,"source":"pv_yield","target":"hot_water"}],"nodes":[{"energy":500,"id":"pv_yield","type":"production"}]},"kfw_efficiency_house":"70EE","primary_energy_factor":0.15,"transmission_loss_factor":0.15,"yearly_earnings_from_electricity_sold_total":350,"yearly_emissions_co2_kg_by_sqm":0.5,"yearly_emissions_co2_kg_total":1500,"yearly_end_energy_demand_kwh_by_sqm":121,"yearly_end_energy_demand_kwh_total":121,"yearly_heating_demand_kwh_by_sqm":125.5,"yearly_heating_demand_kwh_total":12500.5,"yearly_net_energy_hot_water_by_sqm":15.5,"yearly_net_energy_hot_water_total":1550.5,"yearly_primary_energy_demand_kwh_by_sqm":140,"yearly_primary_energy_demand_kwh_total":14000,"yearly_transmission_loss_kwh_by_sqm":137.5,"yearly_transmission_loss_kwh_total":13700.5,"yearly_utility_costs_timeline":[1000,2000,3000]}]},"renovation_summary":{"$ref":"#/components/schemas/RenovationSummary","description":"A summary of the planned measures for the renovation including calculated costs and subsidies","examples":[{"amortisation_time":10,"costs_total":73350,"end_energy_savings_factor":0.59,"savings_from_electricity_sold_factor":0.15,"subsidies":[{"admission_method":"grant","conveyor_name":"KfW","details":{"base_percent":0.15,"ee_bonus_percent":0,"investment_cost":200000,"max_possible_credit":120000,"max_possible_subsidy":120000,"wpb_bonus_percent":0.1},"measures":["roof_insulation","wall_insulation","basement_ceiling_insulation","windows"],"subsidy_amount":20000,"subsidy_type":"efficiency_house","type":"efficiency_house_measures"}],"subsidies_kind_preference":"efficiency_house","subsidies_total":1400,"utility_costs_savings_factor":0.59,"yearly_earnings_from_electricity_sold_savings_total":350,"yearly_emissions_savings_co2_kg_by_sqm":0.25,"yearly_emissions_savings_co2_kg_total":12001,"yearly_end_energy_savings_kwh_by_sqm":12001,"yearly_end_energy_savings_kwh_total":12001,"yearly_utility_costs_savings_total":12001}]}},"type":"object","required":["planned_measures","existing_state","renovated_state","renovation_summary"],"title":"RenovationOutput"},"RenovationOutputPlannedMeasures":{"properties":{"heating_system":{"anyOf":[{"$ref":"#/components/schemas/AvailableTechnicalMeasureHeatingSystem"},{"type":"null"}],"description":"New heating system to be installed","examples":[[{"config":{"co2_emissions":0.28,"cost":34000,"cost_base":11716.25,"cost_per_kw":140.9019231,"efficiency":0.99,"primary_energy_factor":0.9},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{"power":4},"type":"heat_pump_air_to_water"},{"config":{"co2_emissions":0.28,"cost":34000,"cost_base":11716.25,"cost_per_kw":140.9019231,"efficiency":0.99,"primary_energy_factor":0.9},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{"power":4},"type":"pellet"},{"config":{"co2_emissions":0.28,"cost":34000,"cost_base":11716.25,"cost_per_kw":140.9019231,"efficiency":0.99,"primary_energy_factor":0.9},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{"power":4},"type":"district_heating"}]]},"roof_insulation":{"anyOf":[{"$ref":"#/components/schemas/AvailableInsulationMeasure"},{"type":"null"}],"description":"New roof insulation to be installed","examples":[{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw55"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw70"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw85"}]},"wall_insulation":{"anyOf":[{"$ref":"#/components/schemas/AvailableInsulationMeasure"},{"type":"null"}],"description":"New wall insulation to be installed","examples":[{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw55"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw70"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw85"}]},"basement_ceiling_insulation":{"anyOf":[{"$ref":"#/components/schemas/AvailableInsulationMeasure"},{"type":"null"}],"description":"New basement ceiling insulation to be installed","examples":[{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw55"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw70"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw85"}]},"basement_wall_insulation":{"anyOf":[{"$ref":"#/components/schemas/AvailableInsulationMeasure"},{"type":"null"}],"description":"New basement wall insulation to be installed","examples":[{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw55"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw70"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw85"}]},"foundation_slab_insulation":{"anyOf":[{"$ref":"#/components/schemas/AvailableInsulationMeasure"},{"type":"null"}],"description":"New foundation slab insulation to be installed","examples":[{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw55"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw70"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw85"}]},"windows":{"anyOf":[{"$ref":"#/components/schemas/AvailableInsulationMeasure"},{"type":"null"}],"description":"New windows to be installed","examples":[{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw40"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw55"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw70"},{"config":{"cost_by_sqm":439},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"kfw85"}]},"roof_pv":{"anyOf":[{"$ref":"#/components/schemas/AvailableTechnicalMeasureRoofPV"},{"type":"null"}],"description":"Photovoltaic system to be installed on the roof","examples":[{"config":{"cost":34000},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"balanced"}]},"energy_storage":{"anyOf":[{"$ref":"#/components/schemas/AvailableTechnicalMeasureEnergyStorage"},{"type":"null"}],"description":"Energy storage to be installed","examples":[{"config":{"cost":34000},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{},"type":"balanced"}]},"ventilation_system":{"anyOf":[{"$ref":"#/components/schemas/AvailableTechnicalMeasureVentilationSystem"},{"type":"null"}],"description":"Ventilation system to be installed","examples":[{"config":{"cost":15000,"cost_per_sqm":100,"efficiency":0.8,"electricity_consumption_kwh_per_sqm":2.5},"cost":34000,"end_energy_savings_percentage":0.55,"metadata":{"efficiency":3.4},"type":"standard"}]}},"type":"object","title":"RenovationOutputPlannedMeasures"},"RenovationSummary":{"properties":{"costs_total":{"type":"integer","minimum":0,"title":"Costs Total","description":"Total cost for all renovation measures without the subsidies deduction (in EUR)","examples":[73350]},"subsidies_total":{"type":"integer","minimum":0,"title":"Subsidies Total","description":"Subsidies in EUR","examples":[1400]},"subsidies_kind_preference":{"anyOf":[{"type":"string","enum":["efficiency_house","individual","only_custom","none"],"description":"Preferred subsidy kind based on the highest return value","examples":["efficiency_house","individual","only_custom","none"]},{"type":"null"}],"title":"Subsidies Kind Preference","description":"Subsidy kind selected by the solver as the highest-yielding option across the available `subsidies`. `None` when no subsidies apply or when subsidies are disabled via `included_subsidies`","examples":["efficiency_house"]},"subsidies":{"items":{"$ref":"#/components/schemas/RenovationSubsidy"},"type":"array","title":"Subsidies","description":"Breakdown of the subsidies grouped by source and kinds. Currently KfW and BAFA sources are used","examples":[[{"admission_method":"grant","conveyor_name":"KfW","details":{"base_percent":0.15,"ee_bonus_percent":0,"investment_cost":200000,"max_possible_credit":120000,"max_possible_subsidy":120000,"wpb_bonus_percent":0.1},"measures":["roof_insulation","wall_insulation","basement_ceiling_insulation","windows"],"subsidy_amount":20000,"subsidy_type":"efficiency_house","type":"efficiency_house_measures"}]]},"yearly_emissions_savings_co2_kg_by_sqm":{"type":"number","title":"Yearly Emissions Savings Co2 Kg By Sqm","description":"Co2 emissions savings per square meter","examples":[0.25]},"yearly_emissions_savings_co2_kg_total":{"type":"number","title":"Yearly Emissions Savings Co2 Kg Total","description":"Total co2 emissions savings","examples":[12001]},"yearly_end_energy_savings_kwh_by_sqm":{"type":"number","title":"Yearly End Energy Savings Kwh By Sqm","description":"End energy savings per square meter","examples":[12001]},"yearly_end_energy_savings_kwh_total":{"type":"number","title":"Yearly End Energy Savings Kwh Total","description":"Total end energy savings","examples":[12001]},"end_energy_savings_factor":{"type":"number","title":"End Energy Savings Factor","description":"Relative end energy savings","examples":[0.59]},"yearly_utility_costs_savings_total":{"type":"number","title":"Yearly Utility Costs Savings Total","description":"Total heating costs savings in EUR for the current year","examples":[12001]},"utility_costs_savings_factor":{"type":"number","title":"Utility Costs Savings Factor","description":"Relative heating costs savings for the current year","examples":[0.59]},"yearly_earnings_from_electricity_sold_savings_total":{"type":"number","title":"Yearly Earnings From Electricity Sold Savings Total","description":"Total savings in EUR from the sold electricity","examples":[350]},"savings_from_electricity_sold_factor":{"type":"number","title":"Savings From Electricity Sold Factor","description":"Sold electricity savings factor of the first year relative to existing utility costs","examples":[0.15]},"amortisation_time":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amortisation Time","description":"Time in years when the investment costs for the renovation would equal or be larger than the utility cost savings taking into account the amortisation interest rate and future predicted development of utility costs and the savings from sold electricity”","examples":[10]}},"type":"object","required":["costs_total","subsidies_total","subsidies_kind_preference","subsidies","yearly_emissions_savings_co2_kg_by_sqm","yearly_emissions_savings_co2_kg_total","yearly_end_energy_savings_kwh_by_sqm","yearly_end_energy_savings_kwh_total","end_energy_savings_factor","yearly_utility_costs_savings_total","utility_costs_savings_factor","yearly_earnings_from_electricity_sold_savings_total","savings_from_electricity_sold_factor","amortisation_time"],"title":"RenovationSummary"},"RenovationSubsidy":{"properties":{"type":{"$ref":"#/components/schemas/RenovationSubsidyType","description":"Subsidy program type. Unique identifier.","examples":["efficiency_house_measures"]},"subsidy_type":{"type":"string","enum":["efficiency_house","individual","only_custom","none"],"title":"Subsidy Type","description":"Kind of subsidy that can be matched with 'subsidies_kind_preference' in the renovation summary.","examples":["efficiency_house"]},"conveyor_name":{"type":"string","enum":["KfW","BAFA"],"title":"Conveyor Name","description":"Conveyor Name","examples":["KfW"]},"admission_method":{"type":"string","enum":["loan","grant"],"title":"Admission Method","description":"Method of admission of the subsidy.","examples":["grant"]},"subsidy_amount":{"type":"integer","minimum":0,"title":"Subsidy Amount","description":"Subsidy amount in euros","examples":[20000]},"measures":{"items":{"anyOf":[{"type":"string","enum":["heating_system","roof_pv","energy_storage","ventilation_system"]},{"type":"string","enum":["roof_insulation","wall_insulation","basement_ceiling_insulation","basement_wall_insulation","foundation_slab_insulation","windows"]}]},"type":"array","title":"Measures","description":"Measure attribute names that quality for this subsidy","examples":[["roof_insulation","wall_insulation","basement_ceiling_insulation","windows"]]},"details":{"$ref":"#/components/schemas/RenovationSubsidyDetails","description":"Individual subsidy information containing computation details","examples":[{"base_percent":0.15,"ee_bonus_percent":0,"investment_cost":200000,"max_possible_credit":120000,"max_possible_subsidy":120000,"wpb_bonus_percent":0.1}]}},"type":"object","required":["type","subsidy_type","conveyor_name","admission_method","subsidy_amount","measures","details"],"title":"RenovationSubsidy"},"RenovationSubsidyType":{"type":"string","enum":["efficiency_house_measures","kfw_technical_measures","bafa_building_measures"],"title":"RenovationSubsidyType"},"RenovationSubsidyDetails":{"properties":{"base_percent":{"type":"number","maximum":1,"minimum":0,"title":"Base Percent","description":"Base factor over applied measures costs that the subsidy is computed from","examples":[0.15]},"ee_bonus_percent":{"anyOf":[{"type":"number","maximum":1,"minimum":0},{"type":"null"}],"title":"Ee Bonus Percent","description":"Bonus for the `Erneuerbare-Energien` class. Always 0 since the 21.07.2026 BEG reform: a renewable heat source is a baseline requirement for every efficiency-house subsidy, not a rewarded extra. Kept for API compatibility.","examples":[0]},"wpb_bonus_percent":{"anyOf":[{"type":"number","maximum":1,"minimum":0},{"type":"null"}],"title":"Wpb Bonus Percent","description":"Additional bonus for the efficiency house that is applicable, when the unrenovated building has energy class H (`Worst-Performing-Building`). Not granted for `EH-85`.","examples":[0.1]},"investment_cost":{"type":"integer","minimum":0,"title":"Investment Cost","description":"Total investment cost of the renovation","examples":[200000]},"max_possible_subsidy":{"type":"integer","minimum":0,"title":"Max Possible Subsidy","description":"Pre-determined max amounts that the final subsidy cannot exceed","examples":[120000]},"max_possible_credit":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Max Possible Credit","description":"Pre-determined max credit amount. Only for KFW subsidies","examples":[120000]}},"type":"object","required":["base_percent","investment_cost","max_possible_subsidy"],"title":"RenovationSubsidyDetails"},"AvailableTechnicalMeasureHeatingSystem":{"properties":{"type":{"$ref":"#/components/schemas/HeatingSystemType","description":"Type of the heating system renovation measure","examples":["heat_pump_air_to_water"]},"cost":{"type":"integer","minimum":0,"title":"Cost","description":"Investment cost for the measure in EUR","examples":[34000]},"config":{"anyOf":[{"$ref":"#/components/schemas/HeatingSystemConfig"},{"type":"null"}],"description":"Additional configuration of the renovation measure","examples":[{"co2_emissions":0.28,"cost":34000,"cost_base":11716.25,"cost_per_kw":140.9019231,"efficiency":0.99,"primary_energy_factor":0.9}]},"end_energy_savings_percentage":{"type":"number","title":"End Energy Savings Percentage","description":"Relative end energy savings","examples":[0.55]},"metadata":{"$ref":"#/components/schemas/AvailableTechnicalMeasureHeatingSystemMetadata","description":"Additional metadata","examples":[{"efficiency":3.4,"power":4}]}},"type":"object","required":["type","cost","end_energy_savings_percentage","metadata"],"title":"AvailableTechnicalMeasureHeatingSystem"},"AvailableInsulationMeasure":{"properties":{"type":{"$ref":"#/components/schemas/InsulationType","description":"Type of the insulation renovation measure","examples":["kfw70"]},"cost":{"type":"integer","minimum":0,"title":"Cost","description":"Investment cost for the measure in EUR","examples":[34000]},"config":{"anyOf":[{"$ref":"#/components/schemas/InsulationMeasureConfig"},{"type":"null"}],"description":"Additional configuration of the renovation measure","examples":[{"cost_by_sqm":439}]},"end_energy_savings_percentage":{"type":"number","title":"End Energy Savings Percentage","description":"Relative end energy savings","examples":[0.55]},"metadata":{"$ref":"#/components/schemas/AvailableInsulationMeasureMetadata","description":"Additional metadata","examples":[{"efficiency":3.4,"power":4}]}},"type":"object","required":["type","cost","end_energy_savings_percentage","metadata"],"title":"AvailableInsulationMeasure"},"AvailableTechnicalMeasureRoofPV":{"properties":{"type":{"$ref":"#/components/schemas/RoofPVType","description":"Type of the roof photovoltaic renovation measure","examples":["balanced"]},"cost":{"type":"integer","minimum":0,"title":"Cost","description":"Investment cost for the measure in EUR","examples":[34000]},"config":{"anyOf":[{"$ref":"#/components/schemas/CostConfig"},{"type":"null"}],"description":"Additional configuration of the renovation measure","examples":[{"cost":34000}]},"end_energy_savings_percentage":{"type":"number","title":"End Energy Savings Percentage","description":"Relative end energy savings","examples":[0.55]},"metadata":{"$ref":"#/components/schemas/AvailableTechnicalMeasureRoofPVMetadata","description":"Additional metadata","examples":[{"efficiency":3.4,"power":4}]}},"type":"object","required":["type","cost","end_energy_savings_percentage","metadata"],"title":"AvailableTechnicalMeasureRoofPV"},"AvailableTechnicalMeasureEnergyStorage":{"properties":{"type":{"$ref":"#/components/schemas/EnergyStorageType","description":"Type of the energy storage renovation measure","examples":["balanced"]},"cost":{"type":"integer","minimum":0,"title":"Cost","description":"Investment cost for the measure in EUR","examples":[34000]},"config":{"anyOf":[{"$ref":"#/components/schemas/CostConfig"},{"type":"null"}],"description":"Additional configuration of the renovation measure","examples":[{"cost":34000}]},"end_energy_savings_percentage":{"type":"number","title":"End Energy Savings Percentage","description":"Relative end energy savings","examples":[0.55]},"metadata":{"$ref":"#/components/schemas/AvailableTechnicalMeasureEnergyStorageMetadata","description":"Additional metadata","examples":[{"efficiency":3.4,"power":4}]}},"type":"object","required":["type","cost","end_energy_savings_percentage","metadata"],"title":"AvailableTechnicalMeasureEnergyStorage"},"AvailableTechnicalMeasureVentilationSystem":{"properties":{"type":{"$ref":"#/components/schemas/VentilationSystemType","description":"Type of the ventilation system renovation measure","examples":["standard"]},"cost":{"type":"integer","minimum":0,"title":"Cost","description":"Investment cost for the measure in EUR","examples":[34000]},"config":{"anyOf":[{"$ref":"#/components/schemas/VentilationSystemConfig"},{"type":"null"}],"description":"Additional configuration of the renovation measure","examples":[{"cost":15000,"cost_per_sqm":100,"efficiency":0.8,"electricity_consumption_kwh_per_sqm":2.5}]},"end_energy_savings_percentage":{"type":"number","title":"End Energy Savings Percentage","description":"Relative end energy savings","examples":[0.55]},"metadata":{"$ref":"#/components/schemas/AvailableTechnicalMeasureVentilationSystemMetadata","description":"Additional metadata","examples":[{"efficiency":3.4,"power":4}]}},"type":"object","required":["type","cost","end_energy_savings_percentage","metadata"],"title":"AvailableTechnicalMeasureVentilationSystem"},"AvailableTechnicalMeasureVentilationSystemMetadata":{"properties":{"efficiency":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Efficiency","description":"Heat recovery efficiency of the ventilation system","examples":[0.8]},"electricity_consumption_kwh_per_sqm":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Electricity Consumption Kwh Per Sqm","description":"Annual electricity consumption per square meter in kWh/m²","examples":[2.5]}},"type":"object","title":"AvailableTechnicalMeasureVentilationSystemMetadata"},"AvailableTechnicalMeasureEnergyStorageMetadata":{"properties":{"energy_capacity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Energy Capacity","description":"Additional energy capacity metadata in kWh","examples":[15]}},"type":"object","title":"AvailableTechnicalMeasureEnergyStorageMetadata"},"AvailableTechnicalMeasureRoofPVMetadata":{"properties":{"pv_peakpower":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Pv Peakpower","description":"Peak power of the photovoltaic system in kWp","examples":[4]}},"type":"object","title":"AvailableTechnicalMeasureRoofPVMetadata"},"AvailableInsulationMeasureMetadata":{"properties":{"uncovered_area":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Uncovered Area","description":"Additional uncovered area metadata in square meters","examples":[3.4]},"u_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"U Value","description":"Additional u value metadata","examples":[555]}},"type":"object","title":"AvailableInsulationMeasureMetadata"},"AvailableTechnicalMeasureHeatingSystemMetadata":{"properties":{"power":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Power","description":"Additional power metadata in kW","examples":[4]},"yearly_cop":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Yearly Cop","description":"Yearly weighted average coefficient of performance (COP) for the heatpump","examples":[3.65]},"flow_temperature":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Flow Temperature","description":"Heatpump flow temperature (Vorlauftemperatur) depending on energy demand of input building in Degree Celsius","examples":[60]}},"type":"object","title":"AvailableTechnicalMeasureHeatingSystemMetadata"},"RenovationBuildingDefaults":{"properties":{"usable_area":{"type":"number","minimum":0,"title":"Usable Area","description":"The usable area - initialized depending on attic_conversion and basement values","examples":[1510]},"rental_units":{"type":"integer","minimum":0,"title":"Rental Units","description":"Number of rental units - initialized by assuming 70 square meters per unit","examples":[4]},"volume":{"type":"number","minimum":0,"title":"Volume","description":"Total volume of the building in cubic meters","examples":[1845.3]},"roof_type":{"$ref":"#/components/schemas/RoofType","description":"Roof type - initial value is 'Schrägdach' for all types of of roof_type_lod2 except for 'Flachdach","examples":["Schrägdach"]},"window_coverage":{"$ref":"#/components/schemas/WindowCoverageType","description":"Category for the percentage of how much uncovered facade area is assumed as window area. Possible values are: small: 22%, medium: 30%, big: 45%","examples":["medium"]},"attic_conversion":{"$ref":"#/components/schemas/HeatingType","description":"Indicates if the attic is converted and heated","default":"heated","examples":["heated"]},"basement":{"$ref":"#/components/schemas/HeatingType","description":"Indicates if there is a basement and it is heated","default":"heated","examples":["heated"]},"construction_year":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"description":"Construction year of the building - initial value is the mean of construction year class of the largest building and the origin as a fallback","examples":[1960]},{"type":"null"}],"title":"Construction Year","description":"Construction year derived from cadastral data. `None` when no construction year could be determined for the building","examples":[1960]}},"type":"object","required":["usable_area","rental_units","volume","roof_type","window_coverage"],"title":"RenovationBuildingDefaults"},"PushSubscriptionKeys":{"properties":{"p256dh":{"type":"string","maxLength":256,"pattern":"^[A-Za-z0-9_-]+=*$","title":"P256Dh","description":"The public key of the browser subscription, base64url encoded","examples":["BNcRdreALRFXTkOOUHK1EtK2wtaz5Ry4YfYCA_0QTpQtUbVlUls0VJXg7A8u-Ts1XbjhazAkj7I99e8QcYP7DkM"]},"auth":{"type":"string","maxLength":256,"pattern":"^[A-Za-z0-9_-]+=*$","title":"Auth","description":"The authentication secret of the browser subscription, base64url encoded","examples":["tBHItJI5svbpez7KI4CCXg"]}},"type":"object","required":["p256dh","auth"],"title":"PushSubscriptionKeys"},"StoredZoningPlanSearchResult":{"properties":{"date_added":{"type":"string","title":"Date Added","description":"The date when the resource was added","examples":["2023-05-11T09:31:00.117Z"]},"date_modified":{"type":"string","title":"Date Modified","description":"The date when the resource was last modified","examples":["2023-05-11T09:31:00.117Z"]},"zoning_plan_search_id":{"type":"string","format":"uuid","title":"Zoning Plan Search Id","description":"Zoning plan search identifier","examples":["4d2c8a0e-8f3b-4a8e-a1a5-2b7e9f0c6d11"]},"research_id":{"type":"string","title":"Research Id","description":"The identifier of the research in the agentic search service","examples":["rsr_01K5XJ8Q2W3E4R5T6Y7U8I9O0P"]},"property_identifier":{"type":"string","title":"Property Identifier","description":"The identifier of the property the zoning plan was searched for","examples":["PROPERTY-DENW16AL00000PnI"]},"project_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Project Id","description":"Identifier of the project this search belongs to, if any","examples":["0b6f0d4e-5f4a-4c43-9d55-3f1f6a1c2e7b"]}},"type":"object","required":["date_added","date_modified","zoning_plan_search_id","research_id","property_identifier"],"title":"StoredZoningPlanSearchResult"},"ProductionStatus":{"type":"string","enum":["queued","running","succeeded","partial","failed"],"title":"ProductionStatus","description":"Lifecycle states exposed by the production research endpoint."},"ProductionPhase":{"type":"string","enum":["resolving_property","checking_geoportal","searching_plans","preparing_documents","localizing_property","extracting_documents","consolidating_results","generating_summary","saving_result"],"title":"ProductionPhase","description":"Stable user-facing phases backed by real workflow boundaries."},"ProductionResearchResult":{"properties":{"outcome":{"$ref":"#/components/schemas/ResearchOutcome","description":"The outcome of the search, `plan_found`, `no_plan_confirmed` or `inconclusive`","examples":["plan_found"]},"legal_basis":{"$ref":"#/components/schemas/LegalBasis","description":"The planning-law basis of the property, `unknown` when no single basis was found","examples":["section_30"]},"extraction_status":{"$ref":"#/components/schemas/ProductionExtractionStatus","description":"The usability of the property-specific extraction; `unavailable` comes with empty `key_information`","examples":["complete"]},"key_information":{"items":{"$ref":"#/components/schemas/KeyInformation"},"type":"array","title":"Key Information","description":"The prominent property-specific values, one per fixed `key`","examples":[[{"alternatives":[],"derivation":"explicit","display_value":"0.5","key":"grz","label":"GRZ","review_recommended":false,"sources":[{"document_id":"doc_123","document_name":"STM8_Planzeichnung.pdf","href":"https://geo.stadt-muenster.de/bplan/STM8_Planzeichnung.pdf#page=1","page":1,"quote":"GRZ 0,5","source_type":"document"}],"status":"found","value":0.5}]]},"summary_markdown":{"type":"string","title":"Summary Markdown","description":"The German Markdown summary for direct rendering, including generated headings, qualifications and source links; documentary quotes and source titles retain their original wording","default":"","examples":["## Entwurfsrelevante Festsetzungen\n\n- **GRZ:** 0.5 ([STM8_Planzeichnung.pdf, S. 1](https://geo.stadt-muenster.de/bplan/STM8_Planzeichnung.pdf#page=1))"]},"plans":{"items":{"$ref":"#/components/schemas/ProductionPlan"},"type":"array","title":"Plans","description":"The base plans and amendments that apply or may apply to the property","examples":[[{"applicability":"applies","documents":[{"document_id":"doc_123","document_type":"planzeichnung","download_url":"https://geo.stadt-muenster.de/bplan/STM8_Planzeichnung.pdf","name":"STM8_Planzeichnung.pdf"}],"geoportal_url":"https://geo.stadt-muenster.de/bplan/STM8","legal_effect":"binding","legally_binding_date":"1974-06-12","name":"Bebauungsplan St. Mauritz 8","plan_id":"pln_123","plan_number":"STM 8"}]]},"warnings":{"items":{"$ref":"#/components/schemas/ProductionWarning"},"type":"array","title":"Warnings","description":"The limitations to know before relying on the result","examples":[[{"code":"manual_review_recommended","message":"At least one design-relevant value is ambiguous and needs a check.","phase":"extracting_documents"}]]},"search_evidence":{"anyOf":[{"$ref":"#/components/schemas/ProductionSearchEvidence"},{"type":"null"}],"description":"The checks behind a `no_plan_confirmed` or `inconclusive` outcome, `null` for `plan_found` and for runs without an evidence assessment","examples":[{"checks":[{"details":{},"key":"authoritative_source","label":"Official plan source","message":"The official municipal plan service returned no plan at the property.","sources":[{"feature_count":1243,"nearest_distance_m":180,"nearest_plan":"Bebauungsplan St. Mauritz 8","outcome":"no_match","source_class":"municipal_service","url":"https://geo.stadt-muenster.de/bplan/wms"}],"status":"satisfied"}],"nearest_plan":{"distance_m":180,"name":"Bebauungsplan St. Mauritz 8","source_label":"Geoportal Stadt Münster - Bebauungspläne","url":"https://geo.stadt-muenster.de/bplan/wms"},"note":"This is not a binding statement. Only the municipality or a preliminary building decision gives a binding answer; older plans are often unpublished online.","sources_checked":[{"feature_count":1243,"instruments":["binding_bplan"],"label":"Geoportal Stadt Münster - Bebauungspläne","nearest_distance_m":180,"nearest_plan":"Bebauungsplan St. Mauritz 8","result":"no_match","result_label":"no match at the property","source_class":"municipal_service","source_type":"geoportal","url":"https://geo.stadt-muenster.de/bplan/wms"}]}]}},"type":"object","required":["outcome","legal_basis","extraction_status"],"title":"ProductionResearchResult","description":"Compact domain result available after a usable terminal run."},"ProductionError":{"properties":{"code":{"$ref":"#/components/schemas/ProductionErrorCode","description":"The stable id of the failure","examples":["analysis_failed"]},"message":{"type":"string","minLength":1,"title":"Message","description":"The explanation of the failure for display","examples":["Could not finish the analysis because of a technical error."]},"phase":{"anyOf":[{"$ref":"#/components/schemas/ProductionPhase"},{"type":"null"}],"description":"The workflow phase the run failed in, `null` when the failure concerns the whole run","examples":["extracting_documents"]}},"type":"object","required":["code","message"],"title":"ProductionError","description":"Terminal technical error exposed without internal diagnostics."},"ProductionErrorCode":{"type":"string","enum":["property_unavailable","analysis_timeout","analysis_failed"],"title":"ProductionErrorCode","description":"Minimal technical failure vocabulary for API consumers."},"ResearchOutcome":{"type":"string","enum":["plan_found","no_plan_confirmed","inconclusive"],"title":"ResearchOutcome","description":"Domain result of a completed zoning-plan search."},"LegalBasis":{"type":"string","enum":["section_12","section_30","section_33","section_34","section_35","unknown"],"title":"LegalBasis","description":"Legal basis supported by the current buildability workflow."},"ProductionExtractionStatus":{"type":"string","enum":["complete","limited","unavailable"],"title":"ProductionExtractionStatus","description":"Usability of the property-specific extraction result."},"KeyInformation":{"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]*$","title":"Key","description":"The stable id of the value, one of `baugebiet_type`, `grz`, `gfz`, `vollgeschosse` and `height_limits` in that order","examples":["grz"]},"label":{"type":"string","minLength":1,"title":"Label","description":"The display label of the value","examples":["GRZ"]},"status":{"$ref":"#/components/schemas/ProductionFieldStatus","description":"The evidence state of the value; `found` carries a `value` and `conflicting` carries `alternatives`","examples":["found"]},"value":{"anyOf":[{"$ref":"#/components/schemas/ProductionValue"},{"type":"null"}],"description":"The machine-readable value when `status` is `found`: a string for `baugebiet_type`, a number for `grz` and `gfz`, a `RangeValue` for `vollgeschosse` and a list of `HeightValue` for `height_limits`","examples":[0.5,"WR",{"max_value":2},[{"kind":"TH","max_value":7.5,"reference_point":"Höhe der angrenzenden Verkehrsfläche"}]]},"display_value":{"type":"string","minLength":1,"title":"Display Value","description":"The value formatted for display, or the label of `status` when `value` is `null`","examples":["0.5"]},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit","description":"The unit of the value, `m` for `height_limits` and `null` for unitless values","examples":["m"]},"derivation":{"anyOf":[{"$ref":"#/components/schemas/ProductionDerivation"},{"type":"null"}],"description":"The origin of the value when `status` is `found`, `explicit` from the plan or `derived` from a legal reference","examples":["explicit"]},"sources":{"items":{"$ref":"#/components/schemas/ProductionSource"},"type":"array","title":"Sources","description":"The sources that support `value`","examples":[[{"document_id":"doc_123","document_name":"STM8_Planzeichnung.pdf","href":"https://geo.stadt-muenster.de/bplan/STM8_Planzeichnung.pdf#page=1","page":1,"quote":"GRZ 0,5","source_type":"document"}]]},"alternatives":{"items":{"$ref":"#/components/schemas/KeyInformationAlternative"},"type":"array","title":"Alternatives","description":"The candidate values of an `ambiguous` or `conflicting` value, two or more for `conflicting`","examples":[[{"display_value":"0.4","qualifier":"Teilfläche WA 2","sources":[{"document_id":"doc_123","document_name":"STM8_Planzeichnung.pdf","href":"https://geo.stadt-muenster.de/bplan/STM8_Planzeichnung.pdf#page=1","page":2,"quote":"GRZ 0,4","source_type":"document"}],"value":0.4}]]},"review_recommended":{"type":"boolean","title":"Review Recommended","description":"The flag that a person should check the value in the original document before planning","default":false,"examples":[false]},"review_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Review Message","description":"The review hint, set exactly when `review_recommended` is `true`","examples":["Check the value that applies to the property in the original document before further planning."]}},"type":"object","required":["key","label","status","display_value"],"title":"KeyInformation","description":"One prominent property-specific value rendered by the details page."},"ProductionPlan":{"properties":{"plan_id":{"type":"string","pattern":"^pln_","title":"Plan Id","description":"The id of the plan within the research","examples":["pln_123"]},"plan_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan Number","description":"The official number of the plan, `null` when the municipality publishes none","examples":["STM 8"]},"name":{"type":"string","minLength":1,"title":"Name","description":"The official name of the plan","examples":["Bebauungsplan St. Mauritz 8"]},"applicability":{"$ref":"#/components/schemas/PlanApplicability","description":"The coverage of the property by the plan's area of applicability","examples":["applies"]},"legal_effect":{"$ref":"#/components/schemas/ProductionLegalEffect","description":"The legal effect of the plan, `unknown` when the sources leave it open","examples":["binding"]},"legally_binding_date":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}],"title":"Legally Binding Date","description":"The date the plan entered legal force as `YYYY-MM-DD`, `null` when it is unknown","examples":["1974-06-12"]},"amends_plan_id":{"anyOf":[{"type":"string","pattern":"^pln_"},{"type":"null"}],"title":"Amends Plan Id","description":"The `plan_id` of the plan this plan amends, `null` for a base plan","examples":[null]},"geoportal_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Geoportal Url","description":"The official geoportal page of the plan opened during research, `null` when none was found","examples":["https://geo.stadt-muenster.de/bplan/STM8"]},"documents":{"items":{"$ref":"#/components/schemas/ProductionDocument"},"type":"array","title":"Documents","description":"The official documents of the plan","examples":[[{"document_id":"doc_123","document_type":"planzeichnung","download_url":"https://geo.stadt-muenster.de/bplan/STM8_Planzeichnung.pdf","name":"STM8_Planzeichnung.pdf"}]]}},"type":"object","required":["plan_id","name","applicability","legal_effect"],"title":"ProductionPlan","description":"One applicable or potentially applicable zoning plan."},"ProductionWarning":{"properties":{"code":{"type":"string","minLength":1,"title":"Code","description":"The stable snake_case id of the limitation","examples":["manual_review_recommended"]},"message":{"type":"string","minLength":1,"title":"Message","description":"The explanation of the limitation for display","examples":["At least one design-relevant value is ambiguous and needs a check."]},"phase":{"anyOf":[{"$ref":"#/components/schemas/ProductionPhase"},{"type":"null"}],"description":"The workflow phase of the limitation, `null` when it concerns the whole run","examples":["extracting_documents"]}},"type":"object","required":["code","message"],"title":"ProductionWarning","description":"Actionable limitation retained in the compact response."},"ProductionSearchEvidence":{"properties":{"checks":{"items":{"$ref":"#/components/schemas/ProductionEvidenceCheck"},"type":"array","title":"Checks","description":"The checks behind the outcome","examples":[[{"details":{},"key":"authoritative_source","label":"Official plan source","message":"The official municipal plan service returned no plan at the property.","sources":[{"feature_count":1243,"nearest_distance_m":180,"nearest_plan":"Bebauungsplan St. Mauritz 8","outcome":"no_match","source_class":"municipal_service","url":"https://geo.stadt-muenster.de/bplan/wms"}],"status":"satisfied"}]]},"sources_checked":{"items":{"$ref":"#/components/schemas/ProductionCheckedSource"},"type":"array","title":"Sources Checked","description":"The official sources the search consulted","examples":[[{"feature_count":1243,"instruments":["binding_bplan"],"label":"Geoportal Stadt Münster - Bebauungspläne","nearest_distance_m":180,"nearest_plan":"Bebauungsplan St. Mauritz 8","result":"no_match","result_label":"no match at the property","source_class":"municipal_service","source_type":"geoportal","url":"https://geo.stadt-muenster.de/bplan/wms"}]]},"nearest_plan":{"anyOf":[{"$ref":"#/components/schemas/ProductionNearestPlan"},{"type":"null"}],"description":"The closest plan any source returned, `null` when none returned a plan nearby","examples":[{"distance_m":180,"name":"Bebauungsplan St. Mauritz 8","source_label":"Geoportal Stadt Münster - Bebauungspläne","url":"https://geo.stadt-muenster.de/bplan/wms"}]},"presumed_regime":{"anyOf":[{"$ref":"#/components/schemas/PresumedRegime"},{"type":"null"}],"description":"The presumed planning-law regime without a plan, reserved and `null` in every response today","examples":[null]},"note":{"type":"string","minLength":1,"title":"Note","description":"The caveat on how binding the evidence is, for display","examples":["This is not a binding statement. Only the municipality or a preliminary building decision gives a binding answer; older plans are often unpublished online."]}},"type":"object","required":["note"],"title":"ProductionSearchEvidence","description":"What the search checked before concluding that no plan applies.\n\nNever a probability."},"ProductionEvidenceCheck":{"properties":{"key":{"$ref":"#/components/schemas/EvidenceCheckKey","description":"The stable id of the check","examples":["authoritative_source"]},"status":{"$ref":"#/components/schemas/EvidenceCheckStatus","description":"The answer of the check","examples":["satisfied"]},"label":{"type":"string","minLength":1,"title":"Label","description":"The display label of the check","examples":["Official plan source"]},"message":{"type":"string","minLength":1,"title":"Message","description":"The explanation of the check result for display","examples":["The official municipal plan service returned no plan at the property."]},"details":{"additionalProperties":{"type":"string"},"type":"object","title":"Details","description":"The per-category result of `instrument_coverage`, mapping each `EvidenceInstrument` value to `found`, `covered` or `not_covered`; empty for the other checks","examples":[{"binding_bplan":"covered","legacy_plan":"not_covered","other_statute":"not_covered","plan_in_procedure":"covered"}]},"sources":{"items":{"$ref":"#/components/schemas/ProductionEvidenceSource"},"type":"array","title":"Sources","description":"The sources the check cites","examples":[[{"feature_count":1243,"nearest_distance_m":180,"nearest_plan":"Bebauungsplan St. Mauritz 8","outcome":"no_match","source_class":"municipal_service","url":"https://geo.stadt-muenster.de/bplan/wms"}]]}},"type":"object","required":["key","status","label","message"],"title":"ProductionEvidenceCheck","description":"One practice-grounded check with a three-state answer and its sources."},"ProductionCheckedSource":{"properties":{"label":{"type":"string","minLength":1,"title":"Label","description":"The display name of the source, built from its type, operator and content","examples":["Geoportal Stadt Münster - Bebauungspläne"]},"source_type":{"$ref":"#/components/schemas/EvidenceSourceType","description":"The kind of the source","default":"other","examples":["geoportal"]},"source_class":{"$ref":"#/components/schemas/EvidenceSourceClass","description":"The publisher level of the source","examples":["municipal_service"]},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"The official URL of the source, `null` when no external link was retained","examples":["https://geo.stadt-muenster.de/bplan/wms"]},"result":{"$ref":"#/components/schemas/EvidenceSourceOutcome","description":"The result the source returned for the property","examples":["no_match"]},"result_label":{"type":"string","minLength":1,"title":"Result Label","description":"The display label of `result`","examples":["no match at the property"]},"instruments":{"items":{"$ref":"#/components/schemas/EvidenceInstrument"},"type":"array","title":"Instruments","description":"The plan instrument categories the source covers","examples":[["binding_bplan"]]},"feature_count":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Feature Count","description":"The number of plans the service holds, when it reports one","examples":[1243]},"nearest_plan":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nearest Plan","description":"The name of the closest plan the source returned, `null` when it returned none","examples":["Bebauungsplan St. Mauritz 8"]},"nearest_distance_m":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Nearest Distance M","description":"The distance in metres from the property to `nearest_plan`","examples":[180]},"coverage_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Coverage Note","description":"The completeness or period the source states about itself, in the source's own words","examples":["nur Pläne ab 2017"]}},"type":"object","required":["label","source_class","url","result","result_label"],"title":"ProductionCheckedSource","description":"One authoritative source the search consulted, for a flat list of sources searched."},"ProductionNearestPlan":{"properties":{"name":{"type":"string","minLength":1,"title":"Name","description":"The official name of the plan","examples":["Bebauungsplan St. Mauritz 8"]},"distance_m":{"type":"integer","minimum":0,"title":"Distance M","description":"The distance in metres from the property to the plan","examples":[180]},"source_label":{"type":"string","minLength":1,"title":"Source Label","description":"The display name of the source that returned the plan","examples":["Geoportal Stadt Münster - Bebauungspläne"]},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"The official URL of that source, `null` when no external link was retained","examples":["https://geo.stadt-muenster.de/bplan/wms"]}},"type":"object","required":["name","distance_m","source_label"],"title":"ProductionNearestPlan","description":"The closest plan a register returned without covering the property."},"PresumedRegime":{"type":"string","enum":["section_34","section_35"],"title":"PresumedRegime","description":"Planning-law regime presumed when no plan applies."},"EvidenceSourceType":{"type":"string","enum":["geoportal","geodata_service","plan_list","council_information_system","state_portal","document_archive","authority_statement","other"],"title":"EvidenceSourceType","description":"Kind of a consulted source."},"EvidenceSourceClass":{"type":"string","enum":["municipal_service","state_or_district_aggregator","unknown"],"title":"EvidenceSourceClass","description":"Publisher level of a consulted source."},"EvidenceSourceOutcome":{"type":"string","enum":["match","no_match","opened","error","unreadable"],"title":"EvidenceSourceOutcome","description":"What one consulted source returned for the property."},"EvidenceInstrument":{"type":"string","enum":["binding_bplan","plan_in_procedure","legacy_plan","other_statute"],"title":"EvidenceInstrument","description":"Plan instrument categories a source can cover."},"EvidenceCheckKey":{"type":"string","enum":["authoritative_source","instrument_coverage","failed_source_replaced","search_completed"],"title":"EvidenceCheckKey","description":"Stable checks behind a negative or open search outcome."},"EvidenceCheckStatus":{"type":"string","enum":["satisfied","deficient","not_checked"],"title":"EvidenceCheckStatus","description":"Three-state answer of one evidence check."},"ProductionEvidenceSource":{"properties":{"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"The official URL of the source, `null` when no external link was retained","examples":["https://geo.stadt-muenster.de/bplan/wms"]},"source_class":{"$ref":"#/components/schemas/EvidenceSourceClass","description":"The publisher level of the source","examples":["municipal_service"]},"outcome":{"$ref":"#/components/schemas/EvidenceSourceOutcome","description":"The result the source returned for the property","examples":["no_match"]},"coverage_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Coverage Note","description":"The completeness or period the source states about itself, in the source's own words","examples":["nur Pläne ab 2017"]},"feature_count":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Feature Count","description":"The number of plans the service holds, when it reports one","examples":[1243]},"nearest_plan":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nearest Plan","description":"The name of the closest plan the source returned, `null` when it returned none","examples":["Bebauungsplan St. Mauritz 8"]},"nearest_distance_m":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Nearest Distance M","description":"The distance in metres from the property to `nearest_plan`","examples":[180]}},"type":"object","required":["url","source_class","outcome"],"title":"ProductionEvidenceSource","description":"One consulted source cited by a check: what was asked and what came back."},"PlanApplicability":{"type":"string","enum":["applies","partially_applies","uncertain"],"title":"PlanApplicability","description":"Spatial applicability of a plan to the researched property."},"ProductionLegalEffect":{"type":"string","enum":["binding","non_binding","unknown"],"title":"ProductionLegalEffect","description":"Official legal effect without collapsing an unknown state."},"ProductionDocument":{"properties":{"document_id":{"type":"string","minLength":1,"title":"Document Id","description":"The id of the document, referenced by `document_id` in `sources`","examples":["doc_123"]},"name":{"type":"string","minLength":1,"title":"Name","description":"The file name of the document","examples":["STM8_Planzeichnung.pdf"]},"document_type":{"$ref":"#/components/schemas/ProductionDocumentType","description":"The role of the document within the plan","examples":["planzeichnung"]},"download_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Download Url","description":"The official geoportal URL the document was downloaded from, `null` when no URL was retained","examples":["https://geo.stadt-muenster.de/bplan/STM8_Planzeichnung.pdf"]}},"type":"object","required":["document_id","name","document_type","download_url"],"title":"ProductionDocument","description":"Official source document associated with one returned plan."},"ProductionDocumentType":{"type":"string","enum":["planzeichnung","textliche_festsetzungen","begruendung","legende","satzungstext","planakte","other"],"title":"ProductionDocumentType","description":"Normalized document roles used by the frontend."},"ProductionFieldStatus":{"type":"string","enum":["found","not_specified","unreadable","ambiguous","conflicting"],"title":"ProductionFieldStatus","description":"Evidence state for one prominent property value."},"ProductionValue":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"$ref":"#/components/schemas/RangeValue"},{"items":{"$ref":"#/components/schemas/HeightValue"},"type":"array"}]},"ProductionDerivation":{"type":"string","enum":["explicit","derived"],"title":"ProductionDerivation","description":"Whether a displayed value was explicit or derived."},"ProductionSource":{"properties":{"document_id":{"type":"string","minLength":1,"title":"Document Id","description":"The id of the cited document, matching a `document_id` in the plan `documents` for `document` sources","examples":["doc_123"]},"document_name":{"type":"string","minLength":1,"title":"Document Name","description":"The file name of the cited document, or the title of the cited legal source","examples":["STM8_Planzeichnung.pdf"]},"source_type":{"$ref":"#/components/schemas/ProductionSourceType","description":"The kind of source, `document` for a plan document and `legal_reference` for a versioned legal source","default":"document","examples":["document"]},"page":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Page","description":"The 1-based page of the cited document, `null` for a `legal_reference` source","examples":[1]},"quote":{"type":"string","minLength":1,"title":"Quote","description":"The verbatim text of the source that supports the value","examples":["GRZ 0,5"]},"href":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Href","description":"The official link to the cited page or legal source, `null` when no source link was retained","examples":["https://geo.stadt-muenster.de/bplan/STM8_Planzeichnung.pdf#page=1"]}},"type":"object","required":["document_id","document_name","quote","href"],"title":"ProductionSource","description":"Traceable plan-document or versioned legal reference for one value."},"KeyInformationAlternative":{"properties":{"value":{"$ref":"#/components/schemas/ProductionValue","description":"The candidate value, typed like the parent `value` for the same `key`","examples":[0.4]},"display_value":{"type":"string","minLength":1,"title":"Display Value","description":"The candidate value formatted for display","examples":["0.4"]},"qualifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Qualifier","description":"The part of the plan area or the condition the candidate applies to, `null` when the source names none","examples":["Teilfläche WA 2"]},"sources":{"items":{"$ref":"#/components/schemas/ProductionSource"},"type":"array","minItems":1,"title":"Sources","description":"The sources that state the candidate","examples":[[{"document_id":"doc_123","document_name":"STM8_Planzeichnung.pdf","href":"https://geo.stadt-muenster.de/bplan/STM8_Planzeichnung.pdf#page=1","page":2,"quote":"GRZ 0,4","source_type":"document"}]]}},"type":"object","required":["value","display_value","sources"],"title":"KeyInformationAlternative","description":"One unconfirmed value retained for an ambiguous or conflicting field."},"ProductionSourceType":{"type":"string","enum":["document","legal_reference"],"title":"ProductionSourceType","description":"Kind of trusted provenance exposed for one production value."},"RangeValue":{"properties":{"min_value":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Min Value","description":"The minimum number of full storeys, `null` when the plan sets only a maximum","examples":[null]},"max_value":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Max Value","description":"The maximum number of full storeys, `null` when the plan sets only a minimum","examples":[2]}},"type":"object","title":"RangeValue","description":"Machine-readable lower and upper bound for storey values."},"HeightValue":{"properties":{"kind":{"type":"string","minLength":1,"title":"Kind","description":"The height type, `TH` (eaves height), `FH` (ridge height), `OK` (top edge) or `GH` (total height)","examples":["TH"]},"min_value":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Min Value","description":"The minimum height in metres, `null` when the plan sets only a maximum","examples":[null]},"max_value":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Max Value","description":"The maximum height in metres, `null` when the plan sets only a minimum","examples":[7.5]},"reference_point":{"type":"string","minLength":1,"title":"Reference Point","description":"The reference point of the height, as the plan states it","examples":["Höhe der angrenzenden Verkehrsfläche"]}},"type":"object","required":["kind","reference_point"],"title":"HeightValue","description":"Machine-readable height regulation for the frontend."},"PlanArea":{"properties":{"type":{"type":"string","const":"Feature","title":"Type","default":"Feature"},"geometry":{"anyOf":[{"$ref":"#/components/schemas/Polygon"},{"$ref":"#/components/schemas/MultiPolygon"}],"title":"Geometry"},"properties":{"anyOf":[{"$ref":"#/components/schemas/PlanProperties"},{"$ref":"#/components/schemas/BuildableAreaProperties"},{"$ref":"#/components/schemas/PartialAreaProperties"}],"title":"Properties"},"id":{"type":"string","title":"Id"}},"type":"object","required":["geometry","properties","id"],"title":"PlanArea"},"Polygon":{"properties":{"type":{"type":"string","const":"Polygon","title":"Type","default":"Polygon"},"coordinates":{"items":{"items":{"anyOf":[{"$ref":"#/components/schemas/Position2D"},{"$ref":"#/components/schemas/Position3D"}]},"type":"array","minItems":4},"type":"array","title":"Coordinates","examples":[[[[7.591723,51.990776],[7.592227,51.990776],[7.592227,51.991191],[7.591723,51.991191],[7.591723,51.990776]]]]}},"type":"object","required":["coordinates"],"title":"Polygon"},"MultiPolygon":{"properties":{"type":{"type":"string","const":"MultiPolygon","title":"Type","default":"MultiPolygon"},"coordinates":{"items":{"items":{"items":{"anyOf":[{"$ref":"#/components/schemas/Position2D"},{"$ref":"#/components/schemas/Position3D"}]},"type":"array","minItems":4},"type":"array"},"type":"array","title":"Coordinates","examples":[[[[[7.591723,51.990776],[7.592227,51.990776],[7.592227,51.991191],[7.591723,51.991191],[7.591723,51.990776]]]]]}},"type":"object","required":["coordinates"],"title":"MultiPolygon"},"PlanProperties":{"properties":{"max_grz":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Grz","description":"Max allowed GRZ (Grundflaechenzahl) - site coverage ratio","examples":[0.4]},"max_gfz":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Gfz","description":"Max allowed GFZ (Geschossflaechenzahl) - floor area ratio","examples":[1.2]},"max_bmz":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Bmz","description":"Max allowed BMZ (Baumassenzahl) - building mass ratio (volume/area)","examples":[2]},"max_entire_floors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Entire Floors","description":"Max allowed entire floors","examples":[3]},"max_residential_units":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Residential Units","description":"Max allowed residential units","examples":[8]},"max_height":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Height","description":"Max allowed building height in meters","examples":[12.5]},"max_eaves_height":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Eaves Height","description":"Max allowed eaves height in meters","examples":[9]},"usage_allowed":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Usage Allowed","description":"Allowed usage type in the area","examples":["GE"]},"coverage_types":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Coverage Types","description":"List of allowed coverage types. Possible values: 'closed', 'open-adjoining-houses', 'open-detached-house', 'open-semi-detached-house'.","examples":[["open-detached-house"]]},"type":{"type":"string","const":"plan","title":"Type","description":"Type of the area","default":"plan","examples":["plan"]},"identifier":{"type":"string","title":"Identifier","description":"GML ID of the zoning xplan (derived from column gml_id)","examples":["DESHe794175b-3c34-4272-a24e-8dbff8d8125a"]},"state":{"type":"string","enum":["debw","deby","debe","debb","dehb","dehh","dehe","demv","deni","denw","derp","desl","desn","dest","desh","deth","esan","esar","esas","esib","escn","escb","escl","escm","esct","esvc","esex","esga","esmd","esmc","esnc","espv","esri","esce","esml","gbeng","gbsct","gbwls","gbnir"],"title":"State","description":"The country-prefixed state code","examples":["denw"]},"additional_data":{"anyOf":[{"$ref":"#/components/schemas/AdditionalData"},{"type":"null"}],"description":"Additional attributes not part of the typed schema.","examples":[{}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the plan (derived from column name)","examples":["Neue Schule Fruerlund"]},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number","description":"Number of the plan (derived from column nummer)","examples":["307"]},"plan_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan Type","description":"Type of the plan (derived from column planArt)","examples":["Bebauungsplan"]},"legal_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Legal Status","description":"Legal status of the plan (derived from column rechtsstand)","examples":["festgesetzt"]},"effective_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Effective Date","description":"Date when the zoning plan is in effect (derived from column inkrafttretensDatum)","examples":["1998-05-12T00:00:00"]},"reference_urls":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Reference Urls","description":"List of reference URLs to descriptions & maps of the plan (derived from column referenzURL)","examples":[["https://www.flensburg.de/bebauungsplaene/307.pdf"]]}},"type":"object","required":["identifier","state"],"title":"PlanProperties"},"BuildableAreaProperties":{"properties":{"max_grz":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Grz","description":"Max allowed GRZ (Grundflaechenzahl) - site coverage ratio","examples":[0.4]},"max_gfz":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Gfz","description":"Max allowed GFZ (Geschossflaechenzahl) - floor area ratio","examples":[1.2]},"max_bmz":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Bmz","description":"Max allowed BMZ (Baumassenzahl) - building mass ratio (volume/area)","examples":[2]},"max_entire_floors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Entire Floors","description":"Max allowed entire floors","examples":[3]},"max_residential_units":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Residential Units","description":"Max allowed residential units","examples":[8]},"max_height":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Height","description":"Max allowed building height in meters","examples":[12.5]},"max_eaves_height":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Eaves Height","description":"Max allowed eaves height in meters","examples":[9]},"usage_allowed":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Usage Allowed","description":"Allowed usage type in the area","examples":["GE"]},"coverage_types":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Coverage Types","description":"List of allowed coverage types. Possible values: 'closed', 'open-adjoining-houses', 'open-detached-house', 'open-semi-detached-house'.","examples":[["open-detached-house"]]},"type":{"type":"string","const":"buildable_area","title":"Type","description":"Type of the area","default":"buildable_area","examples":["buildable_area"]},"identifier":{"type":"string","title":"Identifier","description":"GML ID of this area (derived from column gml_id)","examples":["GML_9332b135-58d4-481c-b66e-c808a0b0d8b0"]},"state":{"type":"string","enum":["debw","deby","debe","debb","dehb","dehh","dehe","demv","deni","denw","derp","desl","desn","dest","desh","deth","esan","esar","esas","esib","escn","escb","escl","escm","esct","esvc","esex","esga","esmd","esmc","esnc","espv","esri","esce","esml","gbeng","gbsct","gbwls","gbnir"],"title":"State","description":"The country-prefixed state code","examples":["denw"]},"additional_data":{"anyOf":[{"$ref":"#/components/schemas/AdditionalData"},{"type":"null"}],"description":"Additional attributes not part of the typed schema.","examples":[{}]},"partial_area_identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partial Area Identifier","description":"GML ID of the partial area this buildable area belongs to","examples":["GML_9332b135-58d4-481c-b66e-c808a0b0d8b0"]},"plan_identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan Identifier","description":"GML ID of the zoning xplan this area belongs to","examples":["DEBYC00000000000000000"]}},"type":"object","required":["identifier","state"],"title":"BuildableAreaProperties"},"PartialAreaProperties":{"properties":{"max_grz":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Grz","description":"Max allowed GRZ (Grundflaechenzahl) - site coverage ratio","examples":[0.4]},"max_gfz":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Gfz","description":"Max allowed GFZ (Geschossflaechenzahl) - floor area ratio","examples":[1.2]},"max_bmz":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Bmz","description":"Max allowed BMZ (Baumassenzahl) - building mass ratio (volume/area)","examples":[2]},"max_entire_floors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Entire Floors","description":"Max allowed entire floors","examples":[3]},"max_residential_units":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Residential Units","description":"Max allowed residential units","examples":[8]},"max_height":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Height","description":"Max allowed building height in meters","examples":[12.5]},"max_eaves_height":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Eaves Height","description":"Max allowed eaves height in meters","examples":[9]},"usage_allowed":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Usage Allowed","description":"Allowed usage type in the area","examples":["GE"]},"coverage_types":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Coverage Types","description":"List of allowed coverage types. Possible values: 'closed', 'open-adjoining-houses', 'open-detached-house', 'open-semi-detached-house'.","examples":[["open-detached-house"]]},"type":{"type":"string","const":"partial_area","title":"Type","description":"Type of the area","default":"partial_area","examples":["partial_area"]},"identifier":{"type":"string","title":"Identifier","description":"GML ID of this area (derived from column gml_id)","examples":["GML_9332b135-58d4-481c-b66e-c808a0b0d8b0"]},"state":{"type":"string","enum":["debw","deby","debe","debb","dehb","dehh","dehe","demv","deni","denw","derp","desl","desn","dest","desh","deth","esan","esar","esas","esib","escn","escb","escl","escm","esct","esvc","esex","esga","esmd","esmc","esnc","espv","esri","esce","esml","gbeng","gbsct","gbwls","gbnir"],"title":"State","description":"The country-prefixed state code","examples":["denw"]},"additional_data":{"anyOf":[{"$ref":"#/components/schemas/AdditionalData"},{"type":"null"}],"description":"Additional attributes not part of the typed schema.","examples":[{}]},"plan_identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan Identifier","description":"GML ID of the zoning xplan this area belongs to","examples":["DEBYC00000000000000000"]}},"type":"object","required":["identifier","state"],"title":"PartialAreaProperties"},"AdditionalData":{"properties":{},"additionalProperties":true,"type":"object","title":"AdditionalData"},"Position2D":{"prefixItems":[{"type":"number","title":"Longitude"},{"type":"number","title":"Latitude"}],"type":"array","maxItems":2,"minItems":2},"Position3D":{"prefixItems":[{"type":"number","title":"Longitude"},{"type":"number","title":"Latitude"},{"type":"number","title":"Altitude"}],"type":"array","maxItems":3,"minItems":3},"PriceUpdateCalculationMethod":{"properties":{"type":{"type":"string","enum":["current_stock","redensification_and_refurbishment","new_building"],"title":"Type","description":"The type of this development","examples":["current_stock"]},"stock_net_cold_rent_by_sqm":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Stock Net Cold Rent By Sqm","description":"Stock net cold rent by square meter rental space (Nettokaltmiete Bestand)","examples":[11]},"new_or_refurbished_net_cold_rent_by_sqm":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"New Or Refurbished Net Cold Rent By Sqm","description":"New building or refurbished building net cold rent by square meter rental space (Nettokaltmiete Neubau/saniert)","examples":[11]},"selling_price_by_sqm":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Selling Price By Sqm","description":"Selling price per square meter rental space (Verkaufspreis)","examples":[6549]}},"type":"object","required":["type"],"title":"PriceUpdateCalculationMethod"},"ProjectCalculationCurrentStock":{"properties":{"linked":{"type":"boolean","title":"Linked","description":"If the current stock is linked to a parcel","examples":[true]},"area":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Area (Grundstücksfläche)","description":"The area of the property (Grundstücksfläche)","examples":[811.4423156897531]},"grz1":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Site Occupancy Index 1 (Grundflächenzahl 1)","description":"The Site Occupancy Index 1 (German Grundflächenzahl 1) is a measure of the density of built use (Maß der baulichen Nutzung) incorporating the built surface area (Grundfläche) of only the primary buildings (Hauptgebäude)","examples":[0.24147450379043955]},"gfz":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Floor Space Index (Geschossflächenzahl)","description":"The Floor Space Index (German Geschossflächenzahl) is a measure of the density of built use (Maß der baulichen Nutzung) incorporating the amount of full floors (Vollgeschosse)","examples":[0.24122308173345774]},"built_surface_area_primary_buildings":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Primary built surface area (Grundfläche Hauptgebäude)","description":"The built surface area (Grundfläche) of all primary buildings aller Hauptgebäude)","examples":[403.67191]},"floorspace_primary_buildings":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Primary Floorspace (Brutto-Grundfläche Hauptgebäude)","description":"The estimated floorspace (Brutto-Grundfläche) of all overground floors of all primary buildings (oberirdische Geschosse aller Hauptgebäude)","examples":[403.67191]},"volume":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Volume","description":"The sum of the volumes of all buildings on the property. The volume is also known as the Baumasse in German.","examples":[1492.1089901322962]},"floorspace_rentalspace_factor":{"anyOf":[{"type":"number","maximum":1,"minimum":0},{"type":"null"}],"title":"Floorspace Rentalspace Factor","description":"The ratio of the rental space (Vermietbare Fläche) to the floorspace (BGF).","examples":[0.72]},"rentalunit_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Rentalunit Size","description":"The size of a rental unit in the property.","examples":[70]},"origin_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Origin Year","description":"The year when the building with the most floorspace on the property was constructed or when the property was created","examples":[1956]},"energy_demand_label":{"anyOf":[{"type":"string","enum":["A+","A","B","C","D","E","F","G","H"]},{"type":"null"}],"title":"Energy Demand Label","description":"The estimated average energy efficiency class of all buildings on this property","examples":["A+"]}},"type":"object","required":["linked"],"title":"ProjectCalculationCurrentStock"},"ProjectCalculationCosts":{"properties":{"property":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Property","description":"The current cost of the property","examples":[830000]},"land_additional_costs_factor":{"anyOf":[{"type":"number","maximum":1,"minimum":0},{"type":"null"}],"title":"Land Additional Costs Factor","description":"The factor for additional costs for the land (Nebenkosten Grundstück)","examples":[0.7]}},"type":"object","title":"ProjectCalculationCosts"},"ProjectCalculationMethod":{"properties":{"type":{"type":"string","enum":["current_stock","redensification_and_refurbishment","new_building"],"title":"Type","description":"The type of this development","examples":["current_stock"]},"new_building":{"$ref":"#/components/schemas/ProjectCalculationMethodNewBuilding","description":"New Building (Neubaufläche)","examples":[{"built_surface_area_potential":300,"floorspace_potential":600,"floorspace_rentalspace_factor":0.72,"floorspace_volume_factor":3,"overground_parkingspace_count":6,"rentalunit_size":70,"underground_parkingspace_count":6}]},"costs":{"$ref":"#/components/schemas/ProjectCalculationMethodCosts","description":"Costs (Kosten)","examples":[{"construction_by_sqm":1800,"deconstruction_by_cbm":30,"financing_duration_years":3,"incidental_building_costs_factor":0.26,"interest_rate_on_debt":0.04,"other_costs_factor":0.1,"outdoor_facilities_by_sqm":132.5,"overground_parkingspace_by_unit":4500,"prepare_and_develop_by_sqm":20,"refurbishment_by_sqm":1500,"underground_parkingspaces_by_unit":27500}]},"rent":{"$ref":"#/components/schemas/ProjectCalculationMethodRent","description":"Rent (Mieterträge)","examples":[{"new_or_refurbished_net_cold_rent_by_sqm":11,"overground_parkingspace_by_unit":50,"stock_net_cold_rent_by_sqm":11,"underground_parkingspaces_by_unit":100}]},"subsidies":{"$ref":"#/components/schemas/ProjectCalculationMethodSubsidies","description":"Subsidies (Förderungen)","examples":[{"kfw_target_usage_type":"residential","other":0}]},"selling_price_by_sqm":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Selling Price By Sqm","description":"Selling price per square meter rental space (Verkaufspreis)","examples":[6549]},"target_return_factor":{"anyOf":[{"type":"number","maximum":1,"minimum":0},{"type":"null"}],"title":"Target Return Factor","description":"Target return factor (Angestrebte Rendite)","examples":[0.24]},"calculation_results":{"$ref":"#/components/schemas/ProjectCalculationMethodCalculationResults","description":"Computed financial results for this scenario (yields, totals, returns)","examples":[{"rental_yield":0.104,"residual_value_property_cost":723000}]},"selling_price_overground_parkingspace_by_unit":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Selling Price Overground Parkingspace By Unit","description":"Selling price per overground parking lot (Verkaufspreis Stellplätze (Oberirdisch))","examples":[4500]},"selling_price_underground_parkingspaces_by_unit":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Selling Price Underground Parkingspaces By Unit","description":"Selling price per underground parking lot (Tiefgarage Stellplätze (Unterirdisch))","examples":[15000]}},"type":"object","required":["type","new_building","costs","rent","subsidies","calculation_results"],"title":"ProjectCalculationMethod"},"ProjectCalculationMethodNewBuilding":{"properties":{"built_surface_area_potential":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Built Surface Area Potential","description":"The potential built surface area","examples":[300]},"floorspace_potential":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Floorspace Potential","description":"The potential floorspace (BGF)","examples":[600]},"floorspace_volume_factor":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Floorspace Volume Factor","description":"The factor between floorspace and volume","examples":[3]},"floorspace_rentalspace_factor":{"anyOf":[{"type":"number","maximum":1,"minimum":0},{"type":"null"}],"title":"Floorspace Rentalspace Factor","description":"The factor between floorspace and rental space - 0.7 means that 70% of the floorspace is regarded as rental space","examples":[0.72]},"rentalunit_size":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Rentalunit Size","description":"The size of a rental unit in square meters","examples":[70]},"overground_parkingspace_count":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Overground Parkingspace Count","description":"The amount of overground parking lots","examples":[6]},"underground_parkingspace_count":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Underground Parkingspace Count","description":"The amount of underground parking lots","examples":[6]}},"type":"object","title":"ProjectCalculationMethodNewBuilding"},"ProjectCalculationMethodCosts":{"properties":{"prepare_and_develop_by_sqm":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Prepare And Develop By Sqm","description":"The cost for preparation and development per square meter property area (DIN 100 - Herrichten und Erschließen)","examples":[20]},"deconstruction_by_cbm":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Deconstruction By Cbm","description":"The cost for deconstruction per cubic meter volume (DIN 300 & 400 - Rückbau)","examples":[30]},"refurbishment_by_sqm":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Refurbishment By Sqm","description":"The cost for refurbishment per square meter floorspace (DIN 300 & 400 - Sanierung)","examples":[1500]},"construction_by_sqm":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Construction By Sqm","description":"The cost for new building per square meter floorspace (DIN 300 & 400 - Herstellung Neubau)","examples":[1800]},"outdoor_facilities_by_sqm":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Outdoor Facilities By Sqm","description":"The cost for outdoor facilities per square meter (DIN 500 - Herstellung Außenanlagen)","examples":[132.5]},"overground_parkingspace_by_unit":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Overground Parkingspace By Unit","description":"The cost for overground parking lot per unit (DIN 500 - Herstellung Stellplatz)","examples":[4500]},"underground_parkingspaces_by_unit":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Underground Parkingspaces By Unit","description":"The cost for underground parking lot per unit (DIN 500 - Herstellung Tiefgaragenplatz)","examples":[27500]},"incidental_building_costs_factor":{"anyOf":[{"type":"number","maximum":1,"minimum":0},{"type":"null"}],"title":"Incidental Building Costs Factor","description":"The incidental building costs factor (DIN 700 - Baunebenkosten)","examples":[0.26]},"other_costs_factor":{"anyOf":[{"type":"number","maximum":1,"minimum":0},{"type":"null"}],"title":"Other Costs Factor","description":"Other costs factor (DIN 700 - Sonstiges)","examples":[0.1]},"financing_duration_years":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Financing Duration Years","description":"Financing duration in years (Finanzierungsdauer)","examples":[3]},"interest_rate_on_debt":{"anyOf":[{"type":"number","maximum":1},{"type":"null"}],"title":"Interest Rate On Debt","description":"Interest rate on debt (Zins)","examples":[0.04]}},"type":"object","title":"ProjectCalculationMethodCosts"},"ProjectCalculationMethodRent":{"properties":{"stock_net_cold_rent_by_sqm":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Stock Net Cold Rent By Sqm","description":"Stock net cold rent by square meter rental space (Nettokaltmiete Bestand)","examples":[11]},"new_or_refurbished_net_cold_rent_by_sqm":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"New Or Refurbished Net Cold Rent By Sqm","description":"New building or refurbished building net cold rent by square meter rental space (Nettokaltmiete Neubau/saniert)","examples":[11]},"overground_parkingspace_by_unit":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Overground Parkingspace By Unit","description":"Overground parking lot rent per unit (Stellplatzmiete)","examples":[50]},"underground_parkingspaces_by_unit":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Underground Parkingspaces By Unit","description":"Underground parking lot rent per unit (Tiefgaragenmiete)","examples":[100]}},"type":"object","title":"ProjectCalculationMethodRent"},"ProjectCalculationMethodSubsidies":{"properties":{"kfw_target_usage_type":{"anyOf":[{"type":"string","enum":["residential","commercial","industrial","logistic"]},{"type":"null"}],"title":"Kfw Target Usage Type","description":"Target usage for KFW subsidies (Zielnutzung)","examples":["residential"]},"other":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Other","description":"Other subsidies (Sonst. Förderungen und Zuschüsse)","examples":[0]}},"type":"object","title":"ProjectCalculationMethodSubsidies"},"ProjectCalculationMethodCalculationResults":{"properties":{"rental_yield":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rental Yield","description":"Rental yield (Rendite p.a.)","examples":[0.104]},"residual_value_property_cost":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Residual Value Property Cost","description":"Residual value for the property cost (Kostenprognose Grundstück)","examples":[723000]}},"type":"object","title":"ProjectCalculationMethodCalculationResults"},"Region":{"properties":{"type":{"type":"string","const":"Feature","title":"Type","default":"Feature"},"geometry":{"anyOf":[{"$ref":"#/components/schemas/Polygon"},{"$ref":"#/components/schemas/MultiPolygon"}],"title":"Geometry"},"properties":{"$ref":"#/components/schemas/RegionProperties"},"id":{"type":"string","maxLength":14,"minLength":2,"title":"Id"}},"type":"object","required":["geometry","properties","id"],"title":"Region"},"RegionProperties":{"properties":{"identifier":{"type":"string","maxLength":14,"minLength":2,"title":"Region Identifier","description":"The unique region identifier: the country code followed by the national code (the ARS in Germany)","examples":["DE05"]},"state":{"type":"string","enum":["debw","deby","debe","debb","dehb","dehh","dehe","demv","deni","denw","derp","desl","desn","dest","desh","deth","esan","esar","esas","esib","escn","escb","escl","escm","esct","esvc","esex","esga","esmd","esmc","esnc","espv","esri","esce","esml","gbeng","gbsct","gbwls","gbnir"],"title":"State","description":"The country-prefixed state code that this property belongs to","examples":["denw"]},"type":{"anyOf":[{"type":"string","enum":["state","administrative_district","administrative_region","county","municipal_association","municipality"]},{"type":"null"}],"title":"Type","description":"The syte's internal translated region type","examples":["state"]},"type_local":{"type":"string","enum":["Bundesland","Regierungsbezirk","Region","Kreis","Gemeindeverband","Gemeinde"],"title":"Type Local","description":"The original region type name","examples":["Bundesland"]},"name":{"type":"string","title":"Region Name (Gemeindename)","description":"The region's name","examples":["Nordrhein-Westfalen"]},"population":{"type":"integer","title":"Population","description":"Number of inhabitants in this region","examples":[18190422]},"density":{"type":"integer","title":"Density","description":"Number of inhabitants per square kilometer","examples":[533]},"area":{"type":"number","title":"Area","description":"Total area of the region in squared kilometers","examples":[34112.56]},"center":{"anyOf":[{"$ref":"#/components/schemas/Position2D"},{"$ref":"#/components/schemas/Position3D"}],"title":"Area (Grundstücksfläche)","description":"The center coordinate of the region","examples":[[7.55413954972517,51.4778909628134]]},"urbanization":{"anyOf":[{"type":"string","enum":["high","medium","low"]},{"type":"null"}],"title":"Urbanization","description":"The urbanization level of the region","examples":["high"]},"is_subscribed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Subscribed","description":"Whether the region is subscribed to the syte or not","examples":[true]},"available":{"type":"boolean","title":"Available","description":"Whether the region is available in the app or not","examples":[true]},"children":{"items":{"type":"string"},"type":"array","title":"Children","description":"List of child regions identifiers","examples":[["DE051110000000","DE051120000000"]]}},"type":"object","required":["identifier","state","type_local","name","population","density","area","center","available","children"],"title":"RegionProperties"},"SearchResult":{"properties":{"identifier":{"type":"string","title":"Identifier","description":"The property identifier","examples":["PROPERTY-DENW49AL00009b0v"]},"address":{"type":"string","title":"Address","description":"Human-readable address","examples":["Fernholzstraße 33"]},"label":{"type":"string","title":"Label","description":"A label for this property, e.g. the Zähler of a parcel this belongs to","examples":["427"]},"area":{"type":"number","title":"Area","description":"Property area in square meters","examples":[100]},"state":{"type":"string","title":"State","description":"German state(Bundesland)","examples":["NRW"]},"county":{"type":"string","title":"County","description":"German district(Kreis) or district-free city(Kreisfreie Stadt)","examples":["Münster"]},"municipality":{"type":"string","title":"Municipality","description":"German municipality(Gemeinde)","examples":["Münster"]},"postcode":{"type":"string","title":"Postcode","description":"German postcode(PLZ)","examples":["48155"]},"total_potential_label":{"anyOf":[{"type":"string","enum":["low","medium","high"]},{"type":"null"}],"title":"Total Potential Label","description":"total_potential_label of the prediction","examples":["medium"]},"center":{"prefixItems":[{"type":"number"},{"type":"number"}],"type":"array","maxItems":2,"minItems":2,"title":"Center","description":"Centroid of the property as [lng, lat]","examples":[[7.6,51.9]]}},"type":"object","required":["identifier","address","label","area","state","county","municipality","postcode","center"],"title":"SearchResult"},"CloseByPoi":{"properties":{"poi_type":{"type":"string","enum":["motorway","railway"],"title":"Poi Type","description":"One of railway, motorway: Type of the point of Interest ","examples":["railway","motorway"]},"distance_max":{"type":"number","maximum":20000,"minimum":0,"title":"Distance Max","description":"Maximum distance in meters","examples":[500]}},"type":"object","required":["poi_type","distance_max"],"title":"CloseByPoi"},"UsageClusterProperties":{"properties":{"identifier":{"type":"string","title":"Identifier","description":"The unique resource identifier","examples":["DENW49AL00009Jri"]},"state":{"type":"string","enum":["debw","deby","debe","debb","dehb","dehh","dehe","demv","deni","denw","derp","desl","desn","dest","desh","deth","esan","esar","esas","esib","escn","escb","escl","escm","esct","esvc","esex","esga","esmd","esmc","esnc","espv","esri","esce","esml","gbeng","gbsct","gbwls","gbnir"],"title":"State","description":"The state of the usage cluster","examples":["denw"]},"usage_group":{"anyOf":[{"type":"string","enum":["Wohnbaufläche","Industrie- und Gewerbefläche","Halde","Bergbaubetrieb","Tagebau, Grube, Steinbruch","Fläche gemischter Nutzung","Fläche besonderer funktionaler Prägung","Sport-, Freizeit- und Erholungsfläche","Friedhof","Straßenverkehr","Weg","Platz","Bahnverkehr","Flugverkehr","Schiffsverkehr","Landwirtschaft","Wald","Gehölz","Heide","Moor","Sumpf","Unland, Vegetationslose Fläche","Fließgewässer","Hafenbecken","Stehendes Gewässer","Meer"]},{"type":"null"}],"title":"Usage Group","description":"The usage group (Nutzungsartengruppe)","examples":["Industrie- und Gewerbefläche"]},"category":{"anyOf":[{"type":"string","enum":["Wohnen","Industrie/Gewerbe","Halde","gemischte Nutzung","bes. funktionale Prägung","Sport- & Freizeitfläche Friedhof","Straßen","Platz","Bahnverkehr","Flugverkehr","Schiffsverkehr","Landwirtschaft","Wald etc.","Wasser"]},{"type":"null"}],"title":"Category","description":"Custom SYTE usage category summarizing usage groups","examples":["Industrie/Gewerbe"]},"fill":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fill","description":"Fill color according to simple style (ignore!)","examples":["#ffb400"]},"additional_data":{"$ref":"#/components/schemas/AdditionalData","description":"Additional attributes not part of the typed schema.","examples":[{}]}},"type":"object","required":["identifier","state","additional_data"],"title":"UsageClusterProperties"},"YearlyPVPotential":{"properties":{"solar_irradiation":{"type":"number","title":"Solar Irradiation","description":"Total solar irradiation on tilted panels (shadings not included) in kWh","examples":[1.534]},"pv_potential":{"type":"number","title":"Pv Potential","description":"Average predicted energy potential in kWh","examples":[8.856]},"pv_potential_min":{"type":"number","title":"Pv Potential Min","description":"Minimum predicted energy potential in kWh","examples":[7.856]},"pv_potential_max":{"type":"number","title":"Pv Potential Max","description":"Maximum predicted energy potential in kWh","examples":[9.856]}},"type":"object","required":["solar_irradiation","pv_potential","pv_potential_min","pv_potential_max"],"title":"YearlyPVPotential"},"MonthlyPVPotential":{"properties":{"month":{"type":"integer","title":"Month","description":"1-indexed month for which the pv potential is calculated. January is 1, December is 12.","examples":[1]},"solar_irradiation":{"type":"number","title":"Solar Irradiation","description":"Total solar irradiation on tilted panels (shadings not included) in kWh","examples":[1.534]},"pv_potential":{"type":"number","title":"Pv Potential","description":"Average predicted energy potential in kWh","examples":[8.856]},"pv_potential_min":{"type":"number","title":"Pv Potential Min","description":"Minimum predicted energy potential in kWh","examples":[7.856]},"pv_potential_max":{"type":"number","title":"Pv Potential Max","description":"Maximum predicted energy potential in kWh","examples":[9.856]}},"type":"object","required":["month","solar_irradiation","pv_potential","pv_potential_min","pv_potential_max"],"title":"MonthlyPVPotential"},"BuildingPotentialParcelNeighbor":{"properties":{"parcel_identifier":{"type":"string","title":"Neighbor identifier","description":"Parcel identifier of a neighbor","examples":["DENW49AL00009b0D"]},"distance":{"type":"number","title":"Distance to property","description":"Distance in meters between the property and the neighbor property that the parcel belongs to","examples":[50.32]},"is_street":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Street","description":"Indicates if the parcel is a street or not, NULL is unsure","examples":[true]}},"type":"object","required":["parcel_identifier","distance","is_street"],"title":"BuildingPotentialParcelNeighbor"},"ZoningPlanReference":{"properties":{"url":{"type":"string","title":"Url","description":"Reference URL to the zoning plan document","examples":["https://www.flensburg.de/bebauungsplaene/307.pdf"]},"name":{"type":"string","title":"Name","description":"Name of the provided zoning plan document","examples":["Neue Schule Fruerlund"]}},"type":"object","required":["url","name"],"title":"ZoningPlanReference"},"Property":{"properties":{"type":{"type":"string","const":"Feature","title":"Type","default":"Feature"},"geometry":{"anyOf":[{"$ref":"#/components/schemas/Polygon"},{"$ref":"#/components/schemas/MultiPolygon"}],"title":"Geometry"},"properties":{"$ref":"#/components/schemas/PropertyProperties"},"id":{"type":"string","title":"Id"}},"type":"object","required":["geometry","properties","id"],"title":"Property"},"PropertyProperties":{"properties":{"state":{"type":"string","enum":["debw","deby","debe","debb","dehb","dehh","dehe","demv","deni","denw","derp","desl","desn","dest","desh","deth","esan","esar","esas","esib","escn","escb","escl","escm","esct","esvc","esex","esga","esmd","esmc","esnc","espv","esri","esce","esml","gbeng","gbsct","gbwls","gbnir"],"title":"State","description":"The country-prefixed state code that this entity belongs to","examples":["denw"]},"region":{"type":"string","title":"Region","description":"The region identifier of the smallest unit of regions this entity belongs to. The identifiers follow a pattern so a LIKE query will match also for larger units (e.g. state).","examples":["DE055150000000"]},"county":{"type":"string","title":"County","description":"The name of the county (Kreis) that the entity belongs to","examples":["Münster"]},"municipality":{"type":"string","title":"Municipality","description":"The name of the municipality (Gemeindeverband) that the entity belongs to","examples":["Münster"]},"population":{"type":"integer","title":"Population","description":"The population of the municipality region this entity belongs to","examples":[322904]},"postcode":{"type":"string","title":"Postcode","description":"The postcode (Postleitzahl) this entity belongs to","examples":["48159"]},"identifier":{"type":"string","title":"Identifier","description":"The unique resource identifier. Please note that this is a string constructed from the parcel the property belongs to adding a prefix.","examples":["PROPERTY-DENW49AL00009b0v"]},"type":{"type":"string","enum":["syte","custom"],"title":"Type","description":"Set to 'syte' for stock properties, 'custom' for custom properties created with /api/custom-properties","default":"syte","examples":["syte"]},"parcel_identifiers":{"items":{"type":"string"},"type":"array","title":"Parcel Identifiers","description":"A list of parcel identifiers (e.g. DENW49AL00009b0v) that belong to this property","examples":[["DENW49AL00009b0v"]]},"building_identifiers":{"items":{"type":"string"},"type":"array","title":"Building Identifiers","description":"A list of building identifiers (e.g. DENW49AL00009b0v) that belong to this property, ordered by relevance","examples":[["DENW49AL00009XTV","DENW49AL00009XB6","DENW49AL00009XAR"]]},"label":{"type":"string","title":"Label","description":"A label for this property, e.g. the Zähler of a parcel this belongs to","examples":["427"]},"usage":{"items":{"type":"string"},"type":"array","title":"usage (Nutzungsartengruppe / Nutzung)","description":"The usage types (Nutzungsart) of the parcels that belong to this property","examples":[["Wohnbaufläche"]]},"address":{"type":"string","title":"Address","description":"A human-readable address string (of the largest parcel)","examples":["Fernholzstraße 33"]},"center":{"anyOf":[{"$ref":"#/components/schemas/Position2D"},{"$ref":"#/components/schemas/Position3D"}],"title":"Center","description":"The center coordinate of this property","examples":[[7.59188257977666,51.990909281942]]},"uri":{"type":"string","title":"Uri","description":"An API URI to this resource","examples":["https://api.syte.ms/api/cadastral/property?parcel_identifier=DENW49AL00009b0v&lat=51.990909281942024&lng=7.5918825797766649"]},"deeplink":{"type":"string","title":"Deeplink","description":"A link to the map showing this property","examples":["https://app.syte.ms/project/explore?parcelId=DENW49AL00009b0v&lat=51.990909281942024&lng=7.5918825797766649"]},"origin":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Origin (Entstehung)","description":"The origin of the oldest parcel the property belongs too, derived from the ALKIS property `zeitpunktDerEntstehung` - Format is %E4Y-%m-%d","examples":["1983-01-01"]},"area":{"type":"number","title":"Area (Grundstücksfläche)","description":"The area of the property (Grundstücksfläche)","examples":[812.2885]},"built_surface_area":{"type":"number","title":"Built Surface Area (Grundfläche)","description":"The area of the footprints of all buildings (Grundfläche)","examples":[230.65634]},"built_surface_area_primary_buildings":{"type":"number","title":"Primary Built Surface Area (Grundfläche Hauptgebäude)","description":"The area of the footprints of all buildings (Grundfläche) of all primary buildings (aller Primärgebäude)","examples":[192.02321]},"floors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Floors (Geschosse)","description":"The amount of actual floors of the building with the most floors. This number will be estimated through the building geometry using assumptions about the floor height. The floor height will be guessed using the usage type of the building.","examples":[3]},"entire_floors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Entire Floors (Vollgeschosse)","description":"The amount of entire floors (Vollgeschosse) of the building with the most entire floors.","examples":[1]},"floorspace":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Floorspace (Brutto-Grundfläche)","description":"The estimated floorspace (Geschossfläche) of all overground floors (oberirdische Geschosse)","examples":[451.9824]},"floorspace_primary_buildings":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Primary Floorspace (Brutto-Grundfläche Hauptgebäude)","description":"The estimated floorspace (Geschossfläche) of all overground floors of all primary buildings (oberirdische Geschosse aller primär Gebäude)","examples":[413.34924]},"floorspace_entire_floors":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Floorspace Entire Floors (Geschossfläche Vollgeschosse)","description":"The estimated floorspace (Geschossfläche) of all overground entire floors (oberirdische Vollgeschosse)","examples":[230.65634]},"floorspace_entire_floors_primary_buildings":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Primary Floorspace Entire Floors (Geschossfläche Vollgeschosse Hauptgebäude)","description":"The estimated floorspace (Geschossfläche) of all overground entire floors (oberirdische Vollgeschosse) of all primary buildings (aller primär Gebäude)","examples":[192.02321]},"floorspace_non_entire_floors_primary_buildings":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Floorspace Non Entire Floors Primary Buildings","description":"The estimated floorspace (Geschossfläche) of all overground non-entire floors (oberirdische nicht Vollgeschosse) of all primary buildings (aller Primärgebäude)","examples":[221.32605]},"volume":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Volume","description":"The sum of the volumes of all buildings on the property. The volume is also known as the Baumasse in German.","examples":[1544.3527]},"grz":{"type":"number","title":"Site Occupancy Index (Grundflächenzahl)","description":"The Site Occupancy Index (German Grundflächenzahl) is a measure of the density of built use (Maß der baulichen Nutzung) incorporating the built surface area (Grundfläche)","examples":[0.28395864]},"grz1":{"type":"number","title":"Site Occupancy Index 1 (Grundflächenzahl 1)","description":"The Site Occupancy Index 1 (German Grundflächenzahl 1) is a measure of the density of built use (Maß der baulichen Nutzung) incorporating the built surface area (Grundfläche) of only the primary buildings (Hauptgebäude)","examples":[0.23639779]},"grz2":{"type":"number","title":"Site Occupancy Index 2 (Grundflächenzahl 2)","description":"The Site Occupancy Index 2 (German Grundflächenzahl 2) is a measure of the density of built use (Maß der baulichen Nutzung) incorporating the built surface area (Grundfläche) of only the secondary buildings (Sekundärgebäude)","examples":[0.047560863]},"gfz":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Floor Space Index (Geschossflächenzahl)","description":"The Floor Space Index (German Geschossflächenzahl) is a measure of the density of built use (Maß der baulichen Nutzung) incorporating the amount of full floors (Vollgeschosse)","examples":[0.23639779]},"bmz":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Bmz","description":"The BMZ (Baumassenzahl) is the volume divided by the area","examples":[1.9012367]},"envelope_area":{"type":"number","title":"Envelope Area","description":"The area an square meters of the minimum-area rotated rectangle enclosing the geometry","examples":[1018.858]},"width":{"type":"number","title":"Width","description":"The width in square meters of the minimum-area rotated rectangle enclosing the geometry","examples":[31.198927]},"length":{"type":"number","title":"Length","description":"The length in square meters of the minimum-area rotated rectangle enclosing the geometry","examples":[32.58392]},"rectangularity":{"type":"number","title":"Rectangularity","description":"The quotient geometry area/envelope_area; the values are between 0 and 1; a value close to 1 means that geometry area is close to a rectangle","examples":[0.7946466]},"squareness":{"type":"number","title":"Squareness","description":"The quotient width/length; the values are between 0 and 1; a value close to 1 means that the width and length are almost equal as for a square.","examples":[0.9574946]},"urban":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Urban","description":"Indicates if the property is in an urban area or not","examples":[true]},"street_access":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Street Access","description":"True if the property touches another property where is_street is true. False otherwise.","examples":[true]},"touching_properties":{"items":{"type":"string"},"type":"array","title":"Touching Properties","description":"A list property identifiers of non-street properties that this property is touching (0.5m tolerance allowed)","examples":[["PROPERTY-DENW49AL00009b0o","PROPERTY-DENW49AL00009b0D","PROPERTY-DENW49AL00009aWv","PROPERTY-DENW49AL00009b0q"]]},"neighbor_usage_groups":{"anyOf":[{"additionalProperties":{"type":"integer"},"type":"object"},{"type":"null"}],"title":"Neighbor Usage Groups","description":"Mapping between usage groups (Nutzungsartengruppe) and the number of neighbors with that usage group within 50m distance including duplicates","examples":[{"FlaecheGemischterNutzung":0,"IndustrieUndGewerbeflaeche":1,"Wohnbauflaeche":37}]},"direct_neighbor_usage_groups":{"anyOf":[{"additionalProperties":{"type":"integer"},"type":"object"},{"type":"null"}],"title":"Direct Neighbor Usage Groups","description":"Mapping between usage groups (Nutzungsartengruppe) and the number of direct neighbors with that usage group including duplicates","examples":[{"FlaecheGemischterNutzung":0,"IndustrieUndGewerbeflaeche":0,"Wohnbauflaeche":4}]},"same_street_max_entire_floors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Same Street Max Entire Floors","description":"The maximum amount of entire floors of neighbors in the same street within 50m distance","examples":[1]},"direct_neighbor_max_entire_floors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Direct Neighbor Max Entire Floors","description":"The maximum amount of entire floors of direct neighbors in the same street","examples":[1]},"same_street_max_height":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Same Street Max Height","description":"The maximum highest_primary_building_height of neighbors in the same street within 50m distance","examples":[11.479706]},"direct_neighbor_max_height":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Direct Neighbor Max Height","description":"The maximum highest_primary_building_height of direct neighbors in the same street","examples":[10.123333]},"largest_parcel_usage":{"items":{"type":"string"},"type":"array","title":"usage (Nutzungsartengruppe / Nutzung)","description":"The usages of the largest parcel that belong to this property","examples":[["Wohnbaufläche"]]},"usage_areas":{"anyOf":[{"additionalProperties":{"type":"number"},"type":"object"},{"type":"null"}],"title":"Usage Areas","description":"Mapping between usage types (Nutzungsart) and the corresponding area on the property. Null when the source cadastral data does not provide per-usage area breakdowns (e.g. UK, ES).","examples":[{"Wohnbaufläche":809.6320403960216}]},"usage_group":{"items":{"type":"string"},"type":"array","title":"Usage Group","description":"The usage groups (Nutzungsartengruppe) of the parcels that belong to this property","examples":[["Wohnbaufläche"]]},"usage_group_areas":{"items":{"$ref":"#/components/schemas/UsageGroupArea"},"type":"array","title":"Usage Group Areas","description":"Lists the usage groups (Nutzungsartengruppe) and the corresponding area on the property, sorted by area descending","examples":[[{"area":809.6320403960216,"usage":"Wohnbaufläche"}]]},"usage_cluster":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Usage Cluster","description":"The usage cluster identifier without `urn:adv:oid:` prefix and with `TN` suffix from the usage cluster (alkis.actualusage) which has the largest intersection with the property","examples":["DENW49AL0000UlAs"]},"addresses":{"items":{"$ref":"#/components/schemas/PropertyAddress"},"type":"array","title":"Addresses","description":"A list of addresses (street name, number) ordered by parcel area (DESC)","examples":[[{"number":"33","street":"Fernholzstraße"}]]},"street_names":{"items":{"type":"string"},"type":"array","title":"Street Names","description":"The property's street names sorted by parcel area (DESC) and alphabetically (ASC)","examples":[["Fernholzstraße"]]},"street_percentage":{"type":"number","title":"Street Percentage","description":"The property's percentage of area that is street area","examples":[0]},"is_street":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Street","description":"True if high percentage of area is street usage, False if no percentage of area is street usage, NULL otherwise","examples":[false]},"highest_primary_building_height":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Highest Primary Building Height","description":"The height of the highest primary building on the property","examples":[11.093841]},"highest_primary_building_usage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Highest Primary Building Usage","description":"The usage of the highest primary building on the property","examples":["Wohngebäude"]},"highest_secondary_building_height":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Highest Secondary Building Height","description":"The height of the highest secondary building on the property","examples":[3.074589]},"highest_secondary_building_usage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Highest Secondary Building Usage","description":"The usage of the highest secondary building on the property","examples":["Gebäude zum Parken"]},"usable_area":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Usable Area","description":"The estimated usable area (Nutzläche) of all buildings on the property","examples":[325.42734]},"roof_surface_area_lod2":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Roof Surface Area Lod2","description":"Surface area of the roof as calculated in 3D space at Level of Detail 2 (LOD2) in 3DCityDB, which includes generalized roof structures, summed for all buildings in this property, in m2","examples":[324.01172]},"facade_surface_area_lod2":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Facade Surface Area Lod2","description":"Surface area of the facade as calculated in 3D space at Level of Detail 2 (LOD2) in 3DCityDB summed for all buildings in this property, in m2","examples":[456.23328]},"built_surface_area_lod2":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Built Surface Area Lod2","description":"Surface area of the entire built structure as calculated in 3D space at Level of Detail 2 (LOD2) in 3DCityDB summed for all buildings in this property, in m2","examples":[230.66016]},"enveloping_surface_area_lod2":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Enveloping Surface Area Lod2","description":"The surface area of all entire enveloping structures (roof_surface_area_lod2, facade_surface_area_lod2, and built_surface_area_lod2) as calculated in 3D space at Level of Detail 2 (LOD2) in 3DCityDB - only residential buildings for now","examples":[1010.90515]},"enveloping_surface_volume_ratio":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Enveloping Surface Volume Ratio","description":"The ratio enveloping surface area / volume both calculated in 3D space at Level of Detail 2 (LOD2) in 3DCityDB (DE: A/V-Verhältnis) - only residential buildings for now","examples":[0.6545818]},"volume_primary_buildings":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Volume Primary Buildings","description":"The sum of the volumes of all primary buildings (aller primär Gebäude) on the property. The volume is also known as the Baumasse in German.","examples":[1431.3749]},"has_lod2":{"type":"boolean","title":"Has Lod2","description":"Indicates if the property has LOD2 data or not","examples":[true]},"has_lidar":{"type":"boolean","title":"Has Lidar","description":"Indicates if the property has LiDAR data or not","examples":[true]},"lidar_offset":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lidar Offset","description":"Height above sea level where LiDAR points have zero height on the map","examples":[60.73]},"ground_zero":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ground Zero","description":"Height above sea level of the ground reference point of the property","examples":[61.47]},"energy_demand_total":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Energy Demand Total","description":"The estimated total energy demand of all buildings in this property in kWh/y","examples":[58733.254]},"energy_demand":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Energy Demand","description":"The estimated average (relative) energy demand of the all buildings in this property in kWh/m2y","examples":[197.34877]},"energy_demand_label":{"anyOf":[{"type":"string","enum":["A+","A","B","C","D","E","F","G","H"]},{"type":"null"}],"title":"Energy Demand Label","description":"The estimated average energy efficiency class of all buildings on this property","examples":["F"]}},"type":"object","required":["state","region","county","municipality","population","postcode","identifier","label","usage","address","center","uri","deeplink","area","built_surface_area","built_surface_area_primary_buildings","grz","grz1","grz2","envelope_area","width","length","rectangularity","squareness","urban","street_access","touching_properties","neighbor_usage_groups","direct_neighbor_usage_groups","same_street_max_entire_floors","direct_neighbor_max_entire_floors","same_street_max_height","direct_neighbor_max_height","largest_parcel_usage","usage_areas","usage_group","usage_group_areas","addresses","street_names","street_percentage","has_lod2","has_lidar"],"title":"PropertyProperties"},"UsageGroupArea":{"properties":{"usage":{"type":"string","title":"Usage","description":"Usage group (Nutzungsartengruppe) of the parcel","examples":["Wohnbaufläche"]},"area":{"type":"number","title":"Area","description":"Area on the property","examples":[809.6320403960216]}},"type":"object","required":["usage","area"],"title":"UsageGroupArea"},"PropertyAddress":{"properties":{"street":{"type":"string","title":"Street","description":"Street name","examples":["Fernholzstraße"]},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number","description":"Street number","examples":["33"]}},"type":"object","required":["street"],"title":"PropertyAddress"},"ConcealedPropertyProperties":{"properties":{"concealedProperties":{"items":{"type":"string"},"type":"array","title":"Concealedproperties","description":"A list of model properties that are concealed. Requires authentication or higher permissions to reveal all properties.","examples":[["area"]]},"state":{"type":"string","enum":["debw","deby","debe","debb","dehb","dehh","dehe","demv","deni","denw","derp","desl","desn","dest","desh","deth","esan","esar","esas","esib","escn","escb","escl","escm","esct","esvc","esex","esga","esmd","esmc","esnc","espv","esri","esce","esml","gbeng","gbsct","gbwls","gbnir"],"title":"State","description":"The country-prefixed state code that this entity belongs to","examples":["denw"]},"region":{"type":"string","title":"Region","description":"The region identifier of the smallest unit of regions this entity belongs to. The identifiers follow a pattern so a LIKE query will match also for larger units (e.g. state).","examples":["DE055150000000"]},"county":{"type":"string","title":"County","description":"The name of the county (Kreis) that the entity belongs to","examples":["Münster"]},"municipality":{"type":"string","title":"Municipality","description":"The name of the municipality (Gemeindeverband) that the entity belongs to","examples":["Münster"]},"population":{"type":"integer","title":"Population","description":"The population of the municipality region this entity belongs to","examples":[322904]},"postcode":{"type":"string","title":"Postcode","description":"The postcode (Postleitzahl) this entity belongs to","examples":["48159"]},"identifier":{"type":"string","title":"Identifier","description":"The unique resource identifier. Please note that this is a string constructed from the parcel the property belongs to adding a prefix.","examples":["PROPERTY-DENW49AL00009b0v"]},"type":{"type":"string","enum":["syte","custom"],"title":"Type","description":"Set to 'syte' for stock properties, 'custom' for custom properties created with /api/custom-properties","default":"syte","examples":["syte"]},"parcel_identifiers":{"items":{"type":"string"},"type":"array","title":"Parcel Identifiers","description":"A list of parcel identifiers (e.g. DENW49AL00009b0v) that belong to this property","examples":[["DENW49AL00009b0v"]]},"building_identifiers":{"items":{"type":"string"},"type":"array","title":"Building Identifiers","description":"A list of building identifiers (e.g. DENW49AL00009b0v) that belong to this property, ordered by relevance","examples":[["DENW49AL00009XTV","DENW49AL00009XB6","DENW49AL00009XAR"]]},"label":{"type":"string","title":"Label","description":"A label for this property, e.g. the Zähler of a parcel this belongs to","examples":["427"]},"usage":{"items":{"type":"string"},"type":"array","title":"usage (Nutzungsartengruppe / Nutzung)","description":"The usage types (Nutzungsart) of the parcels that belong to this property","examples":[["Wohnbaufläche"]]},"address":{"type":"string","title":"Address","description":"A human-readable address string (of the largest parcel)","examples":["Fernholzstraße 33"]},"center":{"anyOf":[{"$ref":"#/components/schemas/Position2D"},{"$ref":"#/components/schemas/Position3D"}],"title":"Center","description":"The center coordinate of this property","examples":[[7.59188257977666,51.990909281942]]},"uri":{"type":"string","title":"Uri","description":"An API URI to this resource","examples":["https://api.syte.ms/api/cadastral/property?parcel_identifier=DENW49AL00009b0v&lat=51.990909281942024&lng=7.5918825797766649"]},"deeplink":{"type":"string","title":"Deeplink","description":"A link to the map showing this property","examples":["https://app.syte.ms/project/explore?parcelId=DENW49AL00009b0v&lat=51.990909281942024&lng=7.5918825797766649"]},"origin":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Origin (Entstehung)","description":"The origin of the oldest parcel the property belongs too, derived from the ALKIS property `zeitpunktDerEntstehung` - Format is %E4Y-%m-%d","examples":["1983-01-01"]},"area":{"type":"number","title":"Area (Grundstücksfläche)","description":"The area of the property (Grundstücksfläche)","examples":[812.2885]},"built_surface_area":{"type":"number","title":"Built Surface Area (Grundfläche)","description":"The area of the footprints of all buildings (Grundfläche)","examples":[230.65634]},"built_surface_area_primary_buildings":{"type":"number","title":"Primary Built Surface Area (Grundfläche Hauptgebäude)","description":"The area of the footprints of all buildings (Grundfläche) of all primary buildings (aller Primärgebäude)","examples":[192.02321]},"floors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Floors (Geschosse)","description":"The amount of actual floors of the building with the most floors. This number will be estimated through the building geometry using assumptions about the floor height. The floor height will be guessed using the usage type of the building.","examples":[3]},"entire_floors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Entire Floors (Vollgeschosse)","description":"The amount of entire floors (Vollgeschosse) of the building with the most entire floors.","examples":[1]},"floorspace":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Floorspace (Brutto-Grundfläche)","description":"The estimated floorspace (Geschossfläche) of all overground floors (oberirdische Geschosse)","examples":[451.9824]},"floorspace_primary_buildings":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Primary Floorspace (Brutto-Grundfläche Hauptgebäude)","description":"The estimated floorspace (Geschossfläche) of all overground floors of all primary buildings (oberirdische Geschosse aller primär Gebäude)","examples":[413.34924]},"floorspace_entire_floors":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Floorspace Entire Floors (Geschossfläche Vollgeschosse)","description":"The estimated floorspace (Geschossfläche) of all overground entire floors (oberirdische Vollgeschosse)","examples":[230.65634]},"floorspace_entire_floors_primary_buildings":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Primary Floorspace Entire Floors (Geschossfläche Vollgeschosse Hauptgebäude)","description":"The estimated floorspace (Geschossfläche) of all overground entire floors (oberirdische Vollgeschosse) of all primary buildings (aller primär Gebäude)","examples":[192.02321]},"floorspace_non_entire_floors_primary_buildings":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Floorspace Non Entire Floors Primary Buildings","description":"The estimated floorspace (Geschossfläche) of all overground non-entire floors (oberirdische nicht Vollgeschosse) of all primary buildings (aller Primärgebäude)","examples":[221.32605]},"volume":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Volume","description":"The sum of the volumes of all buildings on the property. The volume is also known as the Baumasse in German.","examples":[1544.3527]},"grz":{"type":"number","title":"Site Occupancy Index (Grundflächenzahl)","description":"The Site Occupancy Index (German Grundflächenzahl) is a measure of the density of built use (Maß der baulichen Nutzung) incorporating the built surface area (Grundfläche)","examples":[0.28395864]},"grz1":{"type":"number","title":"Site Occupancy Index 1 (Grundflächenzahl 1)","description":"The Site Occupancy Index 1 (German Grundflächenzahl 1) is a measure of the density of built use (Maß der baulichen Nutzung) incorporating the built surface area (Grundfläche) of only the primary buildings (Hauptgebäude)","examples":[0.23639779]},"grz2":{"type":"number","title":"Site Occupancy Index 2 (Grundflächenzahl 2)","description":"The Site Occupancy Index 2 (German Grundflächenzahl 2) is a measure of the density of built use (Maß der baulichen Nutzung) incorporating the built surface area (Grundfläche) of only the secondary buildings (Sekundärgebäude)","examples":[0.047560863]},"gfz":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Floor Space Index (Geschossflächenzahl)","description":"The Floor Space Index (German Geschossflächenzahl) is a measure of the density of built use (Maß der baulichen Nutzung) incorporating the amount of full floors (Vollgeschosse)","examples":[0.23639779]},"bmz":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Bmz","description":"The BMZ (Baumassenzahl) is the volume divided by the area","examples":[1.9012367]},"envelope_area":{"type":"number","title":"Envelope Area","description":"The area an square meters of the minimum-area rotated rectangle enclosing the geometry","examples":[1018.858]},"width":{"type":"number","title":"Width","description":"The width in square meters of the minimum-area rotated rectangle enclosing the geometry","examples":[31.198927]},"length":{"type":"number","title":"Length","description":"The length in square meters of the minimum-area rotated rectangle enclosing the geometry","examples":[32.58392]},"rectangularity":{"type":"number","title":"Rectangularity","description":"The quotient geometry area/envelope_area; the values are between 0 and 1; a value close to 1 means that geometry area is close to a rectangle","examples":[0.7946466]},"squareness":{"type":"number","title":"Squareness","description":"The quotient width/length; the values are between 0 and 1; a value close to 1 means that the width and length are almost equal as for a square.","examples":[0.9574946]},"urban":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Urban","description":"Indicates if the property is in an urban area or not","examples":[true]},"street_access":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Street Access","description":"True if the property touches another property where is_street is true. False otherwise.","examples":[true]},"touching_properties":{"items":{"type":"string"},"type":"array","title":"Touching Properties","description":"A list property identifiers of non-street properties that this property is touching (0.5m tolerance allowed)","examples":[["PROPERTY-DENW49AL00009b0o","PROPERTY-DENW49AL00009b0D","PROPERTY-DENW49AL00009aWv","PROPERTY-DENW49AL00009b0q"]]},"neighbor_usage_groups":{"anyOf":[{"additionalProperties":{"type":"integer"},"type":"object"},{"type":"null"}],"title":"Neighbor Usage Groups","description":"Mapping between usage groups (Nutzungsartengruppe) and the number of neighbors with that usage group within 50m distance including duplicates","examples":[{"FlaecheGemischterNutzung":0,"IndustrieUndGewerbeflaeche":1,"Wohnbauflaeche":37}]},"direct_neighbor_usage_groups":{"anyOf":[{"additionalProperties":{"type":"integer"},"type":"object"},{"type":"null"}],"title":"Direct Neighbor Usage Groups","description":"Mapping between usage groups (Nutzungsartengruppe) and the number of direct neighbors with that usage group including duplicates","examples":[{"FlaecheGemischterNutzung":0,"IndustrieUndGewerbeflaeche":0,"Wohnbauflaeche":4}]},"same_street_max_entire_floors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Same Street Max Entire Floors","description":"The maximum amount of entire floors of neighbors in the same street within 50m distance","examples":[1]},"direct_neighbor_max_entire_floors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Direct Neighbor Max Entire Floors","description":"The maximum amount of entire floors of direct neighbors in the same street","examples":[1]},"same_street_max_height":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Same Street Max Height","description":"The maximum highest_primary_building_height of neighbors in the same street within 50m distance","examples":[11.479706]},"direct_neighbor_max_height":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Direct Neighbor Max Height","description":"The maximum highest_primary_building_height of direct neighbors in the same street","examples":[10.123333]},"largest_parcel_usage":{"items":{"type":"string"},"type":"array","title":"usage (Nutzungsartengruppe / Nutzung)","description":"The usages of the largest parcel that belong to this property","examples":[["Wohnbaufläche"]]},"usage_areas":{"anyOf":[{"additionalProperties":{"type":"number"},"type":"object"},{"type":"null"}],"title":"Usage Areas","description":"Mapping between usage types (Nutzungsart) and the corresponding area on the property. Null when the source cadastral data does not provide per-usage area breakdowns (e.g. UK, ES).","examples":[{"Wohnbaufläche":809.6320403960216}]},"usage_group":{"items":{"type":"string"},"type":"array","title":"Usage Group","description":"The usage groups (Nutzungsartengruppe) of the parcels that belong to this property","examples":[["Wohnbaufläche"]]},"usage_group_areas":{"items":{"$ref":"#/components/schemas/UsageGroupArea"},"type":"array","title":"Usage Group Areas","description":"Lists the usage groups (Nutzungsartengruppe) and the corresponding area on the property, sorted by area descending","examples":[[{"area":809.6320403960216,"usage":"Wohnbaufläche"}]]},"usage_cluster":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Usage Cluster","description":"The usage cluster identifier without `urn:adv:oid:` prefix and with `TN` suffix from the usage cluster (alkis.actualusage) which has the largest intersection with the property","examples":["DENW49AL0000UlAs"]},"addresses":{"items":{"$ref":"#/components/schemas/PropertyAddress"},"type":"array","title":"Addresses","description":"A list of addresses (street name, number) ordered by parcel area (DESC)","examples":[[{"number":"33","street":"Fernholzstraße"}]]},"street_names":{"items":{"type":"string"},"type":"array","title":"Street Names","description":"The property's street names sorted by parcel area (DESC) and alphabetically (ASC)","examples":[["Fernholzstraße"]]},"street_percentage":{"type":"number","title":"Street Percentage","description":"The property's percentage of area that is street area","examples":[0]},"is_street":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Street","description":"True if high percentage of area is street usage, False if no percentage of area is street usage, NULL otherwise","examples":[false]},"highest_primary_building_height":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Highest Primary Building Height","description":"The height of the highest primary building on the property","examples":[11.093841]},"highest_primary_building_usage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Highest Primary Building Usage","description":"The usage of the highest primary building on the property","examples":["Wohngebäude"]},"highest_secondary_building_height":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Highest Secondary Building Height","description":"The height of the highest secondary building on the property","examples":[3.074589]},"highest_secondary_building_usage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Highest Secondary Building Usage","description":"The usage of the highest secondary building on the property","examples":["Gebäude zum Parken"]},"usable_area":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Usable Area","description":"The estimated usable area (Nutzläche) of all buildings on the property","examples":[325.42734]},"roof_surface_area_lod2":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Roof Surface Area Lod2","description":"Surface area of the roof as calculated in 3D space at Level of Detail 2 (LOD2) in 3DCityDB, which includes generalized roof structures, summed for all buildings in this property, in m2","examples":[324.01172]},"facade_surface_area_lod2":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Facade Surface Area Lod2","description":"Surface area of the facade as calculated in 3D space at Level of Detail 2 (LOD2) in 3DCityDB summed for all buildings in this property, in m2","examples":[456.23328]},"built_surface_area_lod2":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Built Surface Area Lod2","description":"Surface area of the entire built structure as calculated in 3D space at Level of Detail 2 (LOD2) in 3DCityDB summed for all buildings in this property, in m2","examples":[230.66016]},"enveloping_surface_area_lod2":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Enveloping Surface Area Lod2","description":"The surface area of all entire enveloping structures (roof_surface_area_lod2, facade_surface_area_lod2, and built_surface_area_lod2) as calculated in 3D space at Level of Detail 2 (LOD2) in 3DCityDB - only residential buildings for now","examples":[1010.90515]},"enveloping_surface_volume_ratio":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Enveloping Surface Volume Ratio","description":"The ratio enveloping surface area / volume both calculated in 3D space at Level of Detail 2 (LOD2) in 3DCityDB (DE: A/V-Verhältnis) - only residential buildings for now","examples":[0.6545818]},"volume_primary_buildings":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Volume Primary Buildings","description":"The sum of the volumes of all primary buildings (aller primär Gebäude) on the property. The volume is also known as the Baumasse in German.","examples":[1431.3749]},"has_lod2":{"type":"boolean","title":"Has Lod2","description":"Indicates if the property has LOD2 data or not","examples":[true]},"has_lidar":{"type":"boolean","title":"Has Lidar","description":"Indicates if the property has LiDAR data or not","examples":[true]},"lidar_offset":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lidar Offset","description":"Height above sea level where LiDAR points have zero height on the map","examples":[60.73]},"ground_zero":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ground Zero","description":"Height above sea level of the ground reference point of the property","examples":[61.47]},"energy_demand_total":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Energy Demand Total","description":"The estimated total energy demand of all buildings in this property in kWh/y","examples":[58733.254]},"energy_demand":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Energy Demand","description":"The estimated average (relative) energy demand of the all buildings in this property in kWh/m2y","examples":[197.34877]},"energy_demand_label":{"anyOf":[{"type":"string","enum":["A+","A","B","C","D","E","F","G","H"]},{"type":"null"}],"title":"Energy Demand Label","description":"The estimated average energy efficiency class of all buildings on this property","examples":["F"]}},"type":"object","required":["state","region","county","municipality","population","postcode","identifier","label","usage","address","center","uri","deeplink","area","built_surface_area","built_surface_area_primary_buildings","grz","grz1","grz2","envelope_area","width","length","rectangularity","squareness","urban","street_access","touching_properties","neighbor_usage_groups","direct_neighbor_usage_groups","same_street_max_entire_floors","direct_neighbor_max_entire_floors","same_street_max_height","direct_neighbor_max_height","largest_parcel_usage","usage_areas","usage_group","usage_group_areas","addresses","street_names","street_percentage","has_lod2","has_lidar"],"title":"ConcealedPropertyProperties"},"ConcealedParcelProperties":{"properties":{"concealedProperties":{"items":{"type":"string"},"type":"array","title":"Concealedproperties","description":"A list of model properties that are concealed. Requires authentication or higher permissions to reveal all properties.","examples":[["area"]]},"state":{"type":"string","enum":["debw","deby","debe","debb","dehb","dehh","dehe","demv","deni","denw","derp","desl","desn","dest","desh","deth","esan","esar","esas","esib","escn","escb","escl","escm","esct","esvc","esex","esga","esmd","esmc","esnc","espv","esri","esce","esml","gbeng","gbsct","gbwls","gbnir"],"title":"State","description":"The country-prefixed state code that this entity belongs to","examples":["denw"]},"region":{"type":"string","title":"Region","description":"The region identifier of the smallest unit of regions this entity belongs to. The identifiers follow a pattern so a LIKE query will match also for larger units (e.g. state).","examples":["DE055150000000"]},"county":{"type":"string","title":"County","description":"The name of the county (Kreis) that the entity belongs to","examples":["Münster"]},"municipality":{"type":"string","title":"Municipality","description":"The name of the municipality (Gemeindeverband) that the entity belongs to","examples":["Münster"]},"population":{"type":"integer","title":"Population","description":"The population of the municipality region this entity belongs to","examples":[322904]},"postcode":{"type":"string","title":"Postcode","description":"The postcode (Postleitzahl) this entity belongs to","examples":["48159"]},"identifier":{"type":"string","title":"Identifier","description":"The unique resource identifier from ALKIS","examples":["DENW49AL00009b0v"]},"label":{"type":"string","title":"Label","description":"A label for this parcel, e.g. the Zähler of a parcel this belongs to","examples":["427"]},"center":{"anyOf":[{"$ref":"#/components/schemas/Position2D"},{"$ref":"#/components/schemas/Position3D"}],"title":"Center","description":"The center coordinate of this parcel","examples":[[7.59188257977666,51.990909281942]]},"uri":{"type":"string","title":"Uri","description":"An API URI to the resource of the property this parcel belongs to","examples":["https://api.syte.ms/api/cadastral/property?parcel_identifier=DENW49AL00009b0v&lat=51.990909281942024&lng=7.5918825797766649"]},"deeplink":{"type":"string","title":"Deeplink","description":"A link to the map showing the property to this parcel","examples":["https://app.syte.ms/project/explore?parcelId=DENW49AL00009b0v&lat=51.990909281942024&lng=7.5918825797766649"]},"on_property":{"type":"string","title":"On Property","description":"The unique resource identifier of the property this parcel belongs to","examples":["PROPERTY-DENW49AL00009b0v"]},"origin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Origin (Entstehung)","description":"The origin of the oldest parcel the property belongs too, derived from the ALKIS property `zeitpunktDerEntstehung`","examples":["1983-01-01"]},"usage":{"items":{"type":"string"},"type":"array","title":"usage (Nutzungsartengruppe / Nutzung)","description":"The usages of the parcel (Nutzungsartengruppe / Nutzung)","examples":[["Wohnbaufläche"]]},"address":{"type":"string","title":"Address (Lagebezeichnungen)","description":"A human-readable address string (of the largest parcel)","examples":["Fernholzstraße 33"]},"is_street":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Street","description":"Indicates if this parcel is a street; Null means not sure","examples":[false]},"area":{"type":"number","title":"Area (Grundstücksfläche)","description":"The area of the property (Grundstücksfläche)","examples":[812.2885]},"additional_data":{"$ref":"#/components/schemas/AdditionalData","description":"Additional attributes not part of the typed schema.","examples":[{}]}},"type":"object","required":["state","region","county","municipality","population","postcode","identifier","label","center","uri","deeplink","on_property","usage","address","area","additional_data"],"title":"ConcealedParcelProperties"},"BuildingSurface":{"properties":{"type":{"type":"string","const":"Feature","title":"Type","default":"Feature"},"geometry":{"$ref":"#/components/schemas/Geometry3D"},"properties":{"$ref":"#/components/schemas/BuildingSurfaceProperties"},"id":{"type":"string","title":"Id"}},"type":"object","required":["geometry","properties","id"],"title":"BuildingSurface"},"JsonCRS":{"properties":{"type":{"type":"string","const":"name","title":"Type","description":"CRS type, e.g. \"name\"","examples":["name"]},"properties":{"$ref":"#/components/schemas/JsonCRSProperties","description":"CRS properties object","examples":[{"name":"urn:ogc:def:crs:EPSG::25832"}]}},"type":"object","required":["type","properties"],"title":"JsonCRS"},"JsonCRSProperties":{"properties":{"name":{"type":"string","title":"Name","description":"Coordinate reference system name, e.g. an EPSG URN","examples":["urn:ogc:def:crs:EPSG::25832"]}},"type":"object","required":["name"],"title":"JsonCRSProperties"},"Geometry3D":{"anyOf":[{"$ref":"#/components/schemas/Point3D"},{"$ref":"#/components/schemas/MultiPoint3D"},{"$ref":"#/components/schemas/LineString3D"},{"$ref":"#/components/schemas/MultiLineString3D"},{"$ref":"#/components/schemas/Polygon3D"},{"$ref":"#/components/schemas/MultiPolygon3D"}]},"BuildingSurfaceProperties":{"properties":{"state":{"type":"string","enum":["debw","deby","debe","debb","dehb","dehh","dehe","demv","deni","denw","derp","desl","desn","dest","desh","deth","esan","esar","esas","esib","escn","escb","escl","escm","esct","esvc","esex","esga","esmd","esmc","esnc","espv","esri","esce","esml","gbeng","gbsct","gbwls","gbnir"],"title":"State","description":"State of the building this surface belongs to","examples":["denw"]},"building_identifier":{"type":"string","title":"Building Identifier","description":"Identifier of the building this surface belongs to","examples":["DENIAL12000045np"]},"gmlid":{"type":"string","title":"Gmlid","description":"Surface identifier","examples":["UUID_84a65907-63f4-4fed-9545-8fb2bc61d028"]},"surface_type":{"$ref":"#/components/schemas/SurfaceTypeStr","description":"Type of surface according to the CityGML/LoD2 specification. Possible values are RoofSurface, WallSurface, GroundSurface, ClosureSurface","examples":["WallSurface"]},"area_3d":{"type":"number","title":"Area 3D","description":"Inclinated area of the surface in sqm","examples":[5.14]},"tilt":{"type":"number","title":"Tilt","description":"The tilt of the surface in degrees. It represents the angle between the surface and the horizontal plane. Its value ranges from 0 (horizontal) to 90 (vertical). A tilt of 0 means the panel is flat and facing upwards (towards the sky), while a tilt of 90 means the panel is vertical","examples":[90]},"azimuth":{"type":"number","title":"Azimuth","description":"Azimuth angle of the surface in degrees. It defines the orientation of the surface with respect to the North","examples":[35.09]},"overlap_area_primary":{"type":"number","title":"Overlap Area Primary","description":"Area of the surface that is covered by primary buildings in sqm","examples":[2.85]},"overlap_area_secondary":{"type":"number","title":"Overlap Area Secondary","description":"Area of the surface that is covered by secondary buildings in sqm","examples":[0]},"uncovered_area":{"type":"number","title":"Uncovered Area","description":"Area of the surface that is not covered","examples":[2.29]},"center":{"$ref":"#/components/schemas/Point3D","description":"Center coordinates of the surface in EPSG 4236 for lat and long, and altitude in meters","examples":[{"coordinates":[7.5918667,51.9909653,62.17],"type":"Point"}]}},"type":"object","required":["state","building_identifier","gmlid","surface_type","area_3d","tilt","azimuth","overlap_area_primary","overlap_area_secondary","uncovered_area","center"],"title":"BuildingSurfaceProperties","description":"Properties of a building surface using string surface types."},"Point3D":{"properties":{"type":{"type":"string","const":"Point","title":"Type","default":"Point"},"coordinates":{"$ref":"#/components/schemas/Position3D","examples":[[7.591723,51.990776]]}},"type":"object","required":["coordinates"],"title":"Point3D"},"MultiPoint3D":{"properties":{"type":{"type":"string","const":"MultiPoint","title":"Type","default":"MultiPoint"},"coordinates":{"items":{"$ref":"#/components/schemas/Position3D"},"type":"array","title":"Coordinates","examples":[[[7.591723,51.990776],[7.592227,51.991191]]]}},"type":"object","required":["coordinates"],"title":"MultiPoint3D"},"LineString3D":{"properties":{"type":{"type":"string","const":"LineString","title":"Type","default":"LineString"},"coordinates":{"items":{"$ref":"#/components/schemas/Position3D"},"type":"array","title":"Coordinates","examples":[[[7.591723,51.990776],[7.592227,51.991191]]]}},"type":"object","required":["coordinates"],"title":"LineString3D"},"MultiLineString3D":{"properties":{"type":{"type":"string","const":"MultiLineString","title":"Type","default":"MultiLineString"},"coordinates":{"items":{"items":{"$ref":"#/components/schemas/Position3D"},"type":"array"},"type":"array","title":"Coordinates","examples":[[[[7.591723,51.990776],[7.592227,51.991191]]]]}},"type":"object","required":["coordinates"],"title":"MultiLineString3D"},"Polygon3D":{"properties":{"type":{"type":"string","const":"Polygon","title":"Type","default":"Polygon"},"coordinates":{"items":{"items":{"$ref":"#/components/schemas/Position3D"},"type":"array"},"type":"array","title":"Coordinates","examples":[[[[7.591723,51.990776],[7.592227,51.990776],[7.592227,51.991191],[7.591723,51.991191],[7.591723,51.990776]]]]}},"type":"object","required":["coordinates"],"title":"Polygon3D"},"MultiPolygon3D":{"properties":{"type":{"type":"string","const":"MultiPolygon","title":"Type","default":"MultiPolygon"},"coordinates":{"items":{"items":{"items":{"$ref":"#/components/schemas/Position3D"},"type":"array"},"type":"array"},"type":"array","title":"Coordinates","examples":[[[[[7.591723,51.990776],[7.592227,51.990776],[7.592227,51.991191],[7.591723,51.991191],[7.591723,51.990776]]]]]}},"type":"object","required":["coordinates"],"title":"MultiPolygon3D"},"ConcealedBuildingProperties":{"properties":{"concealedProperties":{"items":{"type":"string"},"type":"array","title":"Concealedproperties","description":"A list of model properties that are concealed. Requires authentication or higher permissions to reveal all properties.","examples":[["area"]]},"state":{"type":"string","enum":["debw","deby","debe","debb","dehb","dehh","dehe","demv","deni","denw","derp","desl","desn","dest","desh","deth","esan","esar","esas","esib","escn","escb","escl","escm","esct","esvc","esex","esga","esmd","esmc","esnc","espv","esri","esce","esml","gbeng","gbsct","gbwls","gbnir"],"title":"State","description":"The country-prefixed state code that this entity belongs to","examples":["denw"]},"region":{"type":"string","title":"Region","description":"The region identifier of the smallest unit of regions this entity belongs to. The identifiers follow a pattern so a LIKE query will match also for larger units (e.g. state).","examples":["DE055150000000"]},"county":{"type":"string","title":"County","description":"The name of the county (Kreis) that the entity belongs to","examples":["Münster"]},"municipality":{"type":"string","title":"Municipality","description":"The name of the municipality (Gemeindeverband) that the entity belongs to","examples":["Münster"]},"population":{"type":"integer","title":"Population","description":"The population of the municipality region this entity belongs to","examples":[322904]},"postcode":{"type":"string","title":"Postcode","description":"The postcode (Postleitzahl) this entity belongs to","examples":["48159"]},"origin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Origin","description":"Origin of the parcel the building mostly intersects with, derived from the ALKIS property `zeitpunktDerEntstehung` - Format is %E4Y-%m-%d","examples":["1983-01-01"]},"address":{"type":"string","title":"Address","description":"A human-readable address string","examples":["Fernholzstraße 33"]},"built_surface_area":{"type":"number","title":"Built Surface Area","description":"The built surface area (Grundfläche)","examples":[192.02321]},"eaves_height":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Eaves Height","description":"The eaves height of the building (Traufhöhe)","examples":[3.695625]},"ridge_height":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ridge Height","description":"The ridge height of the building (Firsthöhe)","examples":[11.0888405]},"label":{"type":"string","title":"Label","description":"A label for this building","examples":["Wohngebäude"]},"usage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Usage","description":"The usage of the building","examples":["Wohngebäude"]},"floors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Floors","description":"The estimated amount of usable floors (Nutzbare Geschosse)","examples":[3]},"entire_floors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Entire Floors","description":"The amount of entire floors (Vollgeschosse): the measured count of the preferred 3D source where one exists, the official ALKIS count otherwise","examples":[2]},"entire_floors_assumed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Entire Floors Assumed","description":"Indicates if the value for entire_floors was assumed/predicted or if it was present in the ALKIS data otherwise","examples":[true]},"floorspace":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Floorspace","description":"The estimated gross floorspace (Brutto-Grundfläche) of all overground floors (oberirdische Geschosse)","examples":[514.114]},"floorspace_entire_floors":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Floorspace Entire Floors","description":"The estimated gross floorspace (Geschossfläche) of all overground entire floors (oberirdische Vollgeschosse)","examples":[379.14526]},"floors_array":{"anyOf":[{"items":{"$ref":"#/components/schemas/FloorDetail"},"type":"array"},{"type":"null"}],"title":"Floors Array","description":"The building's floors from the ground up; `null` when no 3D data was available to measure them, in which case consumers fall back to the scalar floor fields such as `floors` and `floorspace`","examples":[[{"eligible_height_floorspace":189.24134,"fully_usable_floorspace":189.25137,"gross_floorspace":190.01436,"gross_height":3,"is_entire":true,"living_area":136.53567,"net_height":2.7,"partially_usable_floorspace":0.76299,"starting_height":0,"usable_area":151.7063,"usable_floorspace":189.63287},{"eligible_height_floorspace":144.85747,"fully_usable_floorspace":152.35684,"gross_floorspace":189.1309,"gross_height":3,"is_entire":true,"living_area":118.55162,"net_height":2.7,"partially_usable_floorspace":24.59635,"starting_height":3,"usable_area":131.72402,"usable_floorspace":164.65502},{"eligible_height_floorspace":69.70306,"fully_usable_floorspace":76.54988,"gross_floorspace":134.96873,"gross_height":5.2,"is_entire":false,"living_area":62.17798,"net_height":4.9,"partially_usable_floorspace":19.61685,"starting_height":6,"usable_area":69.08664,"usable_floorspace":86.3583}]]},"usable_area":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Usable Area","description":"The estimated usable area (Nutzläche) calculated as a static fraction of floorspace (currently 72%)","examples":[352.51697]},"roof_type_lod2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Roof Type Lod2","description":"The generalized roof type (Dachform) of the building from 3DCityDB","examples":["Satteldach"]},"roof_surface_area_lod2":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Roof Surface Area Lod2","description":"The surface area of the roof as calculated in 3D space at Level of Detail 2 (LOD2) in 3DCityDB, which includes generalized roof structures","examples":[285.3789]},"facade_surface_area_lod2":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Facade Surface Area Lod2","description":"The surface area of the facade as calculated in 3D space at Level of Detail 2 (LOD2) in 3DCityDB","examples":[341.02063]},"built_surface_area_lod2":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Built Surface Area Lod2","description":"The surface area of the entire built structure as calculated in 3D space at Level of Detail 2 (LOD2) in 3DCityDB","examples":[192.02344]},"enveloping_surface_area_lod2":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Enveloping Surface Area Lod2","description":"The surface area of the entire enveloping structure (roof_surface_area_lod2, facade_surface_area_lod2, and built_surface_area_lod2) as calculated in 3D space at Level of Detail 2 (LOD2) in 3DCityDB","examples":[818.423]},"enveloping_surface_volume_ratio":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Enveloping Surface Volume Ratio","description":"The ratio enveloping surface area / volume both calculated in 3D space at Level of Detail 2 (LOD2) in 3DCityDB (DE: A/V-Verhältnis)","examples":[0.5565882]},"volume":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Volume","description":"The volume of all building. The volume is also known as the Baumasse in German","examples":[1431.3749]},"secondary_structure":{"type":"boolean","title":"Secondary Structure","description":"Indicates if the building is a secondary structure (e.g. garage) or primary building otherwise","examples":[false]},"on_parcels":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"On Parcels","description":"Identifiers of the parcels this building is on","examples":[["DENW49AL00009b0v"]]},"on_property":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"On Property","description":"Identifier of the property this building is on","examples":["PROPERTY-DENW49AL00009b0v"]},"layers3D":{"anyOf":[{"$ref":"#/components/schemas/SceneGraphLayer"},{"type":"null"}],"description":"A list of 3D layer available for this building. This is usually the LoD2 model of the building with meta data and a URL to the GLTF file.","examples":[{"heading":358.89526,"relation":{"id":"DENW49AL00009XTV","type":"building"},"root":[7.591792,51.9908902,61.222],"type":"scenegraph","url":"https://api.syte.ms/api/3d/gltf/DENW49AL00009XTV"}]},"identifier":{"type":"string","title":"Identifier","description":"The unique resource identifier from ALKIS","examples":["DENW49AL00009XTV"]},"envelope_area":{"type":"number","title":"Envelope Area","description":"The area an square meters of the minimum-area rotated rectangle enclosing the geometry","examples":[218.5472]},"width":{"type":"number","title":"Width","description":"The width in square meters of the minimum-area rotated rectangle enclosing the geometry","examples":[13.840534]},"length":{"type":"number","title":"Length","description":"The length in square meters of the minimum-area rotated rectangle enclosing the geometry","examples":[15.755089]},"rectangularity":{"type":"number","title":"Rectangularity","description":"The quotient geometry area/envelope_area; the values are between 0 and 1; a value close to 1 means that geometry area is close to a rectangle","examples":[0.8757606]},"squareness":{"type":"number","title":"Squareness","description":"The quotient width/length; the values are between 0 and 1; a value close to 1 means that the width and length are almost equal as for a square","examples":[0.87848026]},"usage_cluster":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Usage Cluster","description":"The usage cluster identifier without `urn:adv:oid:` prefix and with `TN` suffix from the usage cluster (alkis.actualusage) which has the largest intersection with the building","examples":["DENW49AL0000UlAs"]},"touching_properties":{"items":{"type":"string"},"type":"array","title":"Touching Properties","description":"A list property identifiers of non-street properties that the building is touching (0.5m tolerance allowed)","examples":[[]]},"energy_demand_total":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Energy Demand Total","description":"The estimated total energy demand of the building in kWh/y","examples":[58733.254]},"energy_demand_label":{"anyOf":[{"type":"string","enum":["A+","A","B","C","D","E","F","G","H"]},{"type":"null"}],"title":"Energy Demand Label","description":"The estimated energy efficiency class of the building","examples":["F"]},"energy_demand":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Energy Demand","description":"The estimated (relative) energy demand of the building in kWh/m²y","examples":[197.34877]},"facade_surface_area_lod2_covered_primary":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Facade Surface Area Lod2 Covered Primary","description":"Facade area of the building which is covered by primary building surfaces as calculated in 3D space at LoD2, in m2","examples":[0]},"facade_surface_area_lod2_covered_secondary":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Facade Surface Area Lod2 Covered Secondary","description":"Facade area of the building which is covered by secondary building surfaces as calculated in 3D space at LoD2, in m2","examples":[19.30888]},"facade_surface_area_lod2_uncovered":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Facade Surface Area Lod2 Uncovered","description":"Facade area of the building which is not covered by other building surfaces as calculated in 3D space at LoD2, in m2","examples":[321.71175]},"construction_year_class_lower":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Construction Year Class Lower","description":"Lower bound for construction_year_class, for example 1900; the construction year is larger than or equal to this value","examples":[1981]},"construction_year_class_upper":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Construction Year Class Upper","description":"Upper bound for construction_year_class, for example 1945; the construction year is lower than or equal to this value","examples":[1985]},"construction_year_estimate":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Construction Year Estimate","description":"Estimated construction year, for example 1922; either derived from the average of construction year class (from Nexiga) or from the origin column (from parcel creation)","examples":[1983]},"coverage_type":{"anyOf":[{"type":"string","enum":["closed","open-adjoining-houses","open-detached-house","open-semi-detached-house"]},{"type":"null"}],"title":"Coverage Type","description":"Building coverage type ('Bauweise'). Calculated from geometry connections and relations to other buildings. Possible values: 'closed', 'open-adjoining-houses', 'open-detached-house', 'open-semi-detached-house'.","examples":["open-detached-house"]},"coverage_subtype":{"anyOf":[{"type":"string","enum":["open-detached-house","open-adjoining-houses-middle","closed-middle","closed-corner","open-semi-detached-house","open-adjoining-houses-corner"]},{"type":"null"}],"title":"Coverage Subtype","description":"Sub type of coverage_type ('Bauweise'). Calculated from geometry connections and relations to other buildings. Possible values: 'open-detached-house', 'open-adjoining-houses-middle', 'closed-middle', 'closed-corner', 'open-semi-detached-house', 'open-adjoining-houses-corner'.","examples":["open-detached-house"]},"heating_systems_estimate":{"items":{"$ref":"#/components/schemas/BuildingHeatingSystem"},"type":"array","title":"Heating Systems Estimate","description":"Estimated heating systems for the building, ordered by the probability descending, derived from census data","examples":[[{"heating_system":"gas","probability":1}]]},"heating_system_estimate":{"anyOf":[{"type":"string","enum":["coal","oil","gas","heat_pump_air_to_water","pellet","district_heating","electricity"]},{"type":"null"}],"title":"Heating System Estimate","description":"The most likely heating system according to the census data","examples":["gas"]},"residential_building_type":{"anyOf":[{"type":"string","enum":["SFH","AB","MFH","AB_HR","TH"]},{"type":"null"}],"title":"Residential Building Type","description":"Building classification as residential building, calculated from building characteristics with options: SFH: Single Family House; AB: Apartment Building; MFH: Multi Family House; AB_HR: Apartment Building Highrise; TH: Terraced House","examples":["MFH"]},"has_lod2":{"type":"boolean","title":"Has Lod2","description":"Indicates if LoD2 data is available for the building","examples":[true]},"has_lidar":{"type":"boolean","title":"Has Lidar","description":"Indicates if LIDAR data is available for the building","examples":[true]},"additional_data":{"$ref":"#/components/schemas/AdditionalData","description":"Additional attributes not part of the typed schema.","examples":[{}]}},"type":"object","required":["state","region","county","municipality","population","postcode","address","built_surface_area","label","secondary_structure","layers3D","identifier","envelope_area","width","length","rectangularity","squareness","touching_properties","has_lod2","has_lidar","additional_data"],"title":"ConcealedBuildingProperties"},"FloorDetail":{"properties":{"starting_height":{"type":"number","title":"Starting Height","description":"Height in m where this floor begins, relative to the building's ground zero","examples":[0]},"gross_height":{"type":"number","title":"Gross Height","description":"Gross height in m of this floor, from its floor surface to the floor surface above","examples":[3]},"net_height":{"type":"number","title":"Net Height","description":"The clear height in m inside this floor, without the ceiling structure. A floor needs at least 1.25 m of it and 3 m² of area to count as a floor","examples":[2.7]},"is_entire":{"type":"boolean","title":"Is Entire","description":"Whether this floor is an entire floor (Vollgeschoss): its `eligible_height_floorspace` is at least 75 % of the `gross_floorspace` of the floor below","examples":[true]},"gross_floorspace":{"type":"number","title":"Gross Floorspace","description":"The gross floorspace (Brutto-Grundfläche) of this floor in m², measured at its `starting_height` and including the wall areas","examples":[190.01436]},"eligible_height_floorspace":{"type":"number","title":"Eligible Height Floorspace","description":"The floorspace of this floor in m² with a net height above 2.30 m (Anrechenbare Fläche), including the wall areas. This is the basis for `is_entire`","examples":[189.24134]},"fully_usable_floorspace":{"type":"number","title":"Fully Usable Floorspace","description":"The floorspace of this floor in m² with more than 2 m of net height, including the wall areas","examples":[189.25137]},"partially_usable_floorspace":{"type":"number","title":"Partially Usable Floorspace","description":"The floorspace of this floor in m² with between 1 m and 2 m of net height, including the wall areas","examples":[0.76299]},"usable_floorspace":{"type":"number","title":"Usable Floorspace","description":"The usable floorspace of this floor in m², `fully_usable_floorspace` plus half of `partially_usable_floorspace`, still including the wall areas","examples":[189.63287]},"usable_area":{"type":"number","title":"Usable Area","description":"The usable area (Nutzungsfläche) of this floor in m², `usable_floorspace` without the wall areas, currently approximated as 80 % of it","examples":[151.7063]},"living_area":{"type":"number","title":"Living Area","description":"The living area (Wohnfläche) of this floor in m², `usable_area` without shared and utility spaces, balconies and terraces, currently approximated as 90 % of it","examples":[136.53567]}},"type":"object","required":["starting_height","gross_height","net_height","is_entire","gross_floorspace","eligible_height_floorspace","fully_usable_floorspace","partially_usable_floorspace","usable_floorspace","usable_area","living_area"],"title":"FloorDetail"},"SceneGraphLayer":{"properties":{"type":{"type":"string","const":"scenegraph","title":"Type","description":"Constant layer type identifying a scene graph layer","default":"scenegraph","examples":["scenegraph"]},"relation":{"$ref":"#/components/schemas/LayerRelation","description":"Entity this 3D layer belongs to","examples":[{"id":"DENW49AL00009XTV","type":"building"}]},"root":{"$ref":"#/components/schemas/Position3D","description":"Origin position of the scene graph as `[lng, lat, altitude]`","examples":[[7.5918667,51.9909653,62.17]]},"heading":{"type":"number","title":"Heading","description":"Orientation heading in degrees","examples":[358.9]},"url":{"type":"string","title":"Url","description":"URL to the glTF model","examples":["https://api.syte.ms/api/3d/gltf/DENW49AL00009XTV"]}},"type":"object","required":["relation","root","heading","url"],"title":"SceneGraphLayer"},"BuildingHeatingSystem":{"properties":{"heating_system":{"type":"string","enum":["coal","oil","gas","heat_pump_air_to_water","pellet","district_heating","electricity"],"title":"Heating System","description":"Type of heating system","examples":["district_heating"]},"probability":{"type":"number","title":"Probability","description":"Probability that the heating system is currently used by the building","examples":[0.85]}},"type":"object","required":["heating_system","probability"],"title":"BuildingHeatingSystem"},"LayerRelation":{"properties":{"type":{"type":"string","enum":["parcel","building","property"],"title":"Type","description":"Kind of entity this layer relates to","examples":["building"]},"id":{"type":"string","title":"Id","description":"Identifier of the related entity","examples":["DENW49AL00009XTV"]}},"type":"object","required":["type","id"],"title":"LayerRelation"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"Building":{"properties":{"type":{"type":"string","const":"Feature","title":"Type","default":"Feature"},"geometry":{"anyOf":[{"$ref":"#/components/schemas/Polygon"},{"$ref":"#/components/schemas/MultiPolygon"}],"title":"Geometry"},"properties":{"$ref":"#/components/schemas/BuildingProperties"},"id":{"type":"string","title":"Id"}},"type":"object","required":["geometry","properties","id"],"title":"Building"},"BuildingProperties":{"properties":{"state":{"type":"string","enum":["debw","deby","debe","debb","dehb","dehh","dehe","demv","deni","denw","derp","desl","desn","dest","desh","deth","esan","esar","esas","esib","escn","escb","escl","escm","esct","esvc","esex","esga","esmd","esmc","esnc","espv","esri","esce","esml","gbeng","gbsct","gbwls","gbnir"],"title":"State","description":"The country-prefixed state code that this entity belongs to","examples":["denw"]},"region":{"type":"string","title":"Region","description":"The region identifier of the smallest unit of regions this entity belongs to. The identifiers follow a pattern so a LIKE query will match also for larger units (e.g. state).","examples":["DE055150000000"]},"county":{"type":"string","title":"County","description":"The name of the county (Kreis) that the entity belongs to","examples":["Münster"]},"municipality":{"type":"string","title":"Municipality","description":"The name of the municipality (Gemeindeverband) that the entity belongs to","examples":["Münster"]},"population":{"type":"integer","title":"Population","description":"The population of the municipality region this entity belongs to","examples":[322904]},"postcode":{"type":"string","title":"Postcode","description":"The postcode (Postleitzahl) this entity belongs to","examples":["48159"]},"origin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Origin","description":"Origin of the parcel the building mostly intersects with, derived from the ALKIS property `zeitpunktDerEntstehung` - Format is %E4Y-%m-%d","examples":["1983-01-01"]},"address":{"type":"string","title":"Address","description":"A human-readable address string","examples":["Fernholzstraße 33"]},"built_surface_area":{"type":"number","title":"Built Surface Area","description":"The built surface area (Grundfläche)","examples":[192.02321]},"eaves_height":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Eaves Height","description":"The eaves height of the building (Traufhöhe)","examples":[3.695625]},"ridge_height":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ridge Height","description":"The ridge height of the building (Firsthöhe)","examples":[11.0888405]},"label":{"type":"string","title":"Label","description":"A label for this building","examples":["Wohngebäude"]},"usage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Usage","description":"The usage of the building","examples":["Wohngebäude"]},"floors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Floors","description":"The estimated amount of usable floors (Nutzbare Geschosse)","examples":[3]},"entire_floors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Entire Floors","description":"The amount of entire floors (Vollgeschosse): the measured count of the preferred 3D source where one exists, the official ALKIS count otherwise","examples":[2]},"entire_floors_assumed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Entire Floors Assumed","description":"Indicates if the value for entire_floors was assumed/predicted or if it was present in the ALKIS data otherwise","examples":[true]},"floorspace":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Floorspace","description":"The estimated gross floorspace (Brutto-Grundfläche) of all overground floors (oberirdische Geschosse)","examples":[514.114]},"floorspace_entire_floors":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Floorspace Entire Floors","description":"The estimated gross floorspace (Geschossfläche) of all overground entire floors (oberirdische Vollgeschosse)","examples":[379.14526]},"floors_array":{"anyOf":[{"items":{"$ref":"#/components/schemas/FloorDetail"},"type":"array"},{"type":"null"}],"title":"Floors Array","description":"The building's floors from the ground up; `null` when no 3D data was available to measure them, in which case consumers fall back to the scalar floor fields such as `floors` and `floorspace`","examples":[[{"eligible_height_floorspace":189.24134,"fully_usable_floorspace":189.25137,"gross_floorspace":190.01436,"gross_height":3,"is_entire":true,"living_area":136.53567,"net_height":2.7,"partially_usable_floorspace":0.76299,"starting_height":0,"usable_area":151.7063,"usable_floorspace":189.63287},{"eligible_height_floorspace":144.85747,"fully_usable_floorspace":152.35684,"gross_floorspace":189.1309,"gross_height":3,"is_entire":true,"living_area":118.55162,"net_height":2.7,"partially_usable_floorspace":24.59635,"starting_height":3,"usable_area":131.72402,"usable_floorspace":164.65502},{"eligible_height_floorspace":69.70306,"fully_usable_floorspace":76.54988,"gross_floorspace":134.96873,"gross_height":5.2,"is_entire":false,"living_area":62.17798,"net_height":4.9,"partially_usable_floorspace":19.61685,"starting_height":6,"usable_area":69.08664,"usable_floorspace":86.3583}]]},"usable_area":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Usable Area","description":"The estimated usable area (Nutzläche) calculated as a static fraction of floorspace (currently 72%)","examples":[352.51697]},"roof_type_lod2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Roof Type Lod2","description":"The generalized roof type (Dachform) of the building from 3DCityDB","examples":["Satteldach"]},"roof_surface_area_lod2":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Roof Surface Area Lod2","description":"The surface area of the roof as calculated in 3D space at Level of Detail 2 (LOD2) in 3DCityDB, which includes generalized roof structures","examples":[285.3789]},"facade_surface_area_lod2":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Facade Surface Area Lod2","description":"The surface area of the facade as calculated in 3D space at Level of Detail 2 (LOD2) in 3DCityDB","examples":[341.02063]},"built_surface_area_lod2":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Built Surface Area Lod2","description":"The surface area of the entire built structure as calculated in 3D space at Level of Detail 2 (LOD2) in 3DCityDB","examples":[192.02344]},"enveloping_surface_area_lod2":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Enveloping Surface Area Lod2","description":"The surface area of the entire enveloping structure (roof_surface_area_lod2, facade_surface_area_lod2, and built_surface_area_lod2) as calculated in 3D space at Level of Detail 2 (LOD2) in 3DCityDB","examples":[818.423]},"enveloping_surface_volume_ratio":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Enveloping Surface Volume Ratio","description":"The ratio enveloping surface area / volume both calculated in 3D space at Level of Detail 2 (LOD2) in 3DCityDB (DE: A/V-Verhältnis)","examples":[0.5565882]},"volume":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Volume","description":"The volume of all building. The volume is also known as the Baumasse in German","examples":[1431.3749]},"secondary_structure":{"type":"boolean","title":"Secondary Structure","description":"Indicates if the building is a secondary structure (e.g. garage) or primary building otherwise","examples":[false]},"on_parcels":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"On Parcels","description":"Identifiers of the parcels this building is on","examples":[["DENW49AL00009b0v"]]},"on_property":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"On Property","description":"Identifier of the property this building is on","examples":["PROPERTY-DENW49AL00009b0v"]},"layers3D":{"anyOf":[{"$ref":"#/components/schemas/SceneGraphLayer"},{"type":"null"}],"description":"A list of 3D layer available for this building. This is usually the LoD2 model of the building with meta data and a URL to the GLTF file.","examples":[{"heading":358.89526,"relation":{"id":"DENW49AL00009XTV","type":"building"},"root":[7.591792,51.9908902,61.222],"type":"scenegraph","url":"https://api.syte.ms/api/3d/gltf/DENW49AL00009XTV"}]},"identifier":{"type":"string","title":"Identifier","description":"The unique resource identifier from ALKIS","examples":["DENW49AL00009XTV"]},"envelope_area":{"type":"number","title":"Envelope Area","description":"The area an square meters of the minimum-area rotated rectangle enclosing the geometry","examples":[218.5472]},"width":{"type":"number","title":"Width","description":"The width in square meters of the minimum-area rotated rectangle enclosing the geometry","examples":[13.840534]},"length":{"type":"number","title":"Length","description":"The length in square meters of the minimum-area rotated rectangle enclosing the geometry","examples":[15.755089]},"rectangularity":{"type":"number","title":"Rectangularity","description":"The quotient geometry area/envelope_area; the values are between 0 and 1; a value close to 1 means that geometry area is close to a rectangle","examples":[0.8757606]},"squareness":{"type":"number","title":"Squareness","description":"The quotient width/length; the values are between 0 and 1; a value close to 1 means that the width and length are almost equal as for a square","examples":[0.87848026]},"usage_cluster":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Usage Cluster","description":"The usage cluster identifier without `urn:adv:oid:` prefix and with `TN` suffix from the usage cluster (alkis.actualusage) which has the largest intersection with the building","examples":["DENW49AL0000UlAs"]},"touching_properties":{"items":{"type":"string"},"type":"array","title":"Touching Properties","description":"A list property identifiers of non-street properties that the building is touching (0.5m tolerance allowed)","examples":[[]]},"energy_demand_total":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Energy Demand Total","description":"The estimated total energy demand of the building in kWh/y","examples":[58733.254]},"energy_demand_label":{"anyOf":[{"type":"string","enum":["A+","A","B","C","D","E","F","G","H"]},{"type":"null"}],"title":"Energy Demand Label","description":"The estimated energy efficiency class of the building","examples":["F"]},"energy_demand":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Energy Demand","description":"The estimated (relative) energy demand of the building in kWh/m²y","examples":[197.34877]},"facade_surface_area_lod2_covered_primary":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Facade Surface Area Lod2 Covered Primary","description":"Facade area of the building which is covered by primary building surfaces as calculated in 3D space at LoD2, in m2","examples":[0]},"facade_surface_area_lod2_covered_secondary":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Facade Surface Area Lod2 Covered Secondary","description":"Facade area of the building which is covered by secondary building surfaces as calculated in 3D space at LoD2, in m2","examples":[19.30888]},"facade_surface_area_lod2_uncovered":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Facade Surface Area Lod2 Uncovered","description":"Facade area of the building which is not covered by other building surfaces as calculated in 3D space at LoD2, in m2","examples":[321.71175]},"construction_year_class_lower":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Construction Year Class Lower","description":"Lower bound for construction_year_class, for example 1900; the construction year is larger than or equal to this value","examples":[1981]},"construction_year_class_upper":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Construction Year Class Upper","description":"Upper bound for construction_year_class, for example 1945; the construction year is lower than or equal to this value","examples":[1985]},"construction_year_estimate":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Construction Year Estimate","description":"Estimated construction year, for example 1922; either derived from the average of construction year class (from Nexiga) or from the origin column (from parcel creation)","examples":[1983]},"coverage_type":{"anyOf":[{"type":"string","enum":["closed","open-adjoining-houses","open-detached-house","open-semi-detached-house"]},{"type":"null"}],"title":"Coverage Type","description":"Building coverage type ('Bauweise'). Calculated from geometry connections and relations to other buildings. Possible values: 'closed', 'open-adjoining-houses', 'open-detached-house', 'open-semi-detached-house'.","examples":["open-detached-house"]},"coverage_subtype":{"anyOf":[{"type":"string","enum":["open-detached-house","open-adjoining-houses-middle","closed-middle","closed-corner","open-semi-detached-house","open-adjoining-houses-corner"]},{"type":"null"}],"title":"Coverage Subtype","description":"Sub type of coverage_type ('Bauweise'). Calculated from geometry connections and relations to other buildings. Possible values: 'open-detached-house', 'open-adjoining-houses-middle', 'closed-middle', 'closed-corner', 'open-semi-detached-house', 'open-adjoining-houses-corner'.","examples":["open-detached-house"]},"heating_systems_estimate":{"items":{"$ref":"#/components/schemas/BuildingHeatingSystem"},"type":"array","title":"Heating Systems Estimate","description":"Estimated heating systems for the building, ordered by the probability descending, derived from census data","examples":[[{"heating_system":"gas","probability":1}]]},"heating_system_estimate":{"anyOf":[{"type":"string","enum":["coal","oil","gas","heat_pump_air_to_water","pellet","district_heating","electricity"]},{"type":"null"}],"title":"Heating System Estimate","description":"The most likely heating system according to the census data","examples":["gas"]},"residential_building_type":{"anyOf":[{"type":"string","enum":["SFH","AB","MFH","AB_HR","TH"]},{"type":"null"}],"title":"Residential Building Type","description":"Building classification as residential building, calculated from building characteristics with options: SFH: Single Family House; AB: Apartment Building; MFH: Multi Family House; AB_HR: Apartment Building Highrise; TH: Terraced House","examples":["MFH"]},"has_lod2":{"type":"boolean","title":"Has Lod2","description":"Indicates if LoD2 data is available for the building","examples":[true]},"has_lidar":{"type":"boolean","title":"Has Lidar","description":"Indicates if LIDAR data is available for the building","examples":[true]},"additional_data":{"$ref":"#/components/schemas/AdditionalData","description":"Additional attributes not part of the typed schema.","examples":[{}]}},"type":"object","required":["state","region","county","municipality","population","postcode","address","built_surface_area","label","secondary_structure","layers3D","identifier","envelope_area","width","length","rectangularity","squareness","touching_properties","has_lod2","has_lidar","additional_data"],"title":"BuildingProperties"}},"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"},"download_token":{"type":"http","scheme":"download_token"}}},"tags":[{"name":"Cadastral","description":"Cadastral and inventory data for buildings, parcels, properties, usage clusters, regions and zoning plans","externalDocs":{"description":"More info","url":"https://www.syte.ms/bestandsanalysen"}},{"name":"Photovoltaic Potential","description":"On-roof photovoltaic potential calculated with the LoD2 models","externalDocs":{"description":"More info","url":"https://www.syte.ms/photovoltaikpotenziale"}},{"name":"Renovation Plans","description":"Renovation plans and renovation recommendations","externalDocs":{"description":"More info","url":"https://www.syte.ms/sanierungsplaene"}},{"name":"Building Potential","description":"AI based building potentials for new building according to §34 BauGB","externalDocs":{"description":"More info","url":"https://www.syte.ms/bebauungspotenziale"}},{"name":"Map and Building Images","description":"Images of maps of a building or a property and images of the 3D visualisation of buildings"},{"name":"Agentic Buildability Search","description":"AI agent searching the zoning plans of a property and extracting their key regulations"},{"name":"3D Building Models","description":"3D building models in different formats (glTF, OBJ, STL)"},{"name":"Project Calculator","description":"Project development calculation for building projects that combines syte's AI building potential with rents, market valuations and subsidies to calculate the profit of a project","externalDocs":{"description":"More info","url":"https://www.syte.ms/wirtschaftslichkeitsberechnungen"}},{"name":"Search","description":"Search engine with extensive filter options for the entire building and property stock","externalDocs":{"description":"More info","url":"https://www.syte.ms/grundstueckssuchen"}},{"name":"Download","description":"Helper to download data like 3D models and map data from an app"}]}