@viadukt/connect 2.4.2 → 2.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/dist/index.d.ts +114 -602
  2. package/dist/index.js +100 -566
  3. package/dist/index.js.map +1 -1
  4. package/package.json +1 -1
package/dist/index.js CHANGED
@@ -25,11 +25,9 @@ var $LookupPropertiesV2 = {
25
25
  street: {
26
26
  type: ["string", "null"],
27
27
  description: `
28
- **Datasources / Datenquellen:**<br /><br />
28
+ The \`street\` field specifies the street name of a building.
29
29
 
30
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
31
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
32
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)`,
30
+ The field is set to \`null\` if the street is unknown.`,
33
31
  example: "Friedrich Ebert Stra\xDFe"
34
32
  },
35
33
  city: {
@@ -37,13 +35,7 @@ var $LookupPropertiesV2 = {
37
35
  description: `
38
36
  The \`city\` field specifies the city name of a building.
39
37
 
40
- The field is set to \`null\` if the city is unknown.
41
-
42
- <br /><br />**Datasources / Datenquellen:**<br /><br />
43
-
44
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
45
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
46
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)`,
38
+ The field is set to \`null\` if the city is unknown.`,
47
39
  example: "Wuppertal"
48
40
  },
49
41
  street_number: {
@@ -51,13 +43,7 @@ The field is set to \`null\` if the city is unknown.
51
43
  description: `
52
44
  The \`street_number\` field specifies the street number name of a building.
53
45
 
54
- The field is set to \`null\` if the street number is unknown.
55
-
56
- <br /><br />**Datasources / Datenquellen:**<br /><br />
57
-
58
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
59
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
60
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)`,
46
+ The field is set to \`null\` if the street number is unknown.`,
61
47
  example: "107"
62
48
  },
63
49
  postcode: {
@@ -65,13 +51,7 @@ The field is set to \`null\` if the street number is unknown.
65
51
  description: `
66
52
  The \`postcode\` field specifies the postcode of a building.
67
53
 
68
- The field is set to \`null\` if the postcode is unknown.
69
-
70
- <br /><br />**Datasources / Datenquellen:**<br /><br />
71
-
72
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
73
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
74
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)`,
54
+ The field is set to \`null\` if the postcode is unknown.`,
75
55
  example: "107"
76
56
  },
77
57
  roof_type: {
@@ -84,13 +64,7 @@ The \`roof_type\` field specifies the type of roof of a building. This field can
84
64
  - **pitched**: Pitched roof
85
65
  - **mixed**: Mixed types of roofs
86
66
 
87
- The field is set to \`null\` if the building type is unknown.
88
-
89
- <br /><br />**Datasources / Datenquellen:**<br /><br />
90
-
91
- - Solarthermal Potential (NRW) <br />
92
- \xA9 Landesamt f\xFCr Natur, Umwelt und Verbraucherschutz (LANUV) NRW (2024) <br />
93
- [Datasources / Datenquellen](https://www.opengeodata.nrw.de/produkte/umwelt_klima/klima/solarkataster/photovoltaik/)`,
67
+ The field is set to \`null\` if the building type is unknown.`,
94
68
  example: "flat"
95
69
  },
96
70
  type: {
@@ -104,13 +78,7 @@ The \`type\` field specifies the type of building. This field can have one of th
104
78
  - **non_residential**: Non-residential building
105
79
  - **mixed_use**: Mixed-use building
106
80
 
107
- The field is set to \`null\` if the building type is unknown.
108
-
109
- <br /><br />**Datasources / Datenquellen:**<br /><br />
110
-
111
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
112
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
113
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)`,
81
+ The field is set to \`null\` if the building type is unknown.`,
114
82
  example: "single_family"
115
83
  },
116
84
  type_class: {
@@ -125,13 +93,7 @@ The \`type_class\` field specifies the class of the building type. This field ca
125
93
  - **3**: Non-residential building
126
94
  - **4**: Mixed-use building
127
95
 
128
- The field is set to \`null\` if the building type is unknown.
129
-
130
- <br /><br />**Datasources / Datenquellen:**<br /><br />
131
-
132
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
133
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
134
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)`,
96
+ The field is set to \`null\` if the building type is unknown.`,
135
97
  example: 1
136
98
  },
137
99
  water_protected: {
@@ -139,22 +101,7 @@ The field is set to \`null\` if the building type is unknown.
139
101
  description: `
140
102
  The \`water_protected\` field specifies whether the building is within a water protection area.
141
103
 
142
- If the field is set to \`null\`, no water protection area could be assigned.
143
-
144
- <br /><br />**Datasources / Datenquellen:**<br /><br />
145
-
146
- - Water Protection Areas (Germany ex. Rheinland-Pfalz, Baden-W\xFCrtemberg, NRW) <br />
147
- \xA9 WasserBLIcK/BfG & Zust\xE4ndige Beh\xF6rden der L\xE4nder (2024) <br />
148
- [Datasources / Datenquellen](https://geoportal.bafg.de/inspire/download/AM/waterProtectionArea/datasetfeed.xml)
149
- - Water Protection Areas (Rheinland-Pfalz) <br />
150
- \xA9 Landesamt f\xFCr Umwelt (LfU) (2024) <br />
151
- [Datasources / Datenquellen](https://geodienste-wasser.rlp-umwelt.de/geonetwork/srv/ger/catalog.search;jsessionid=7E55E5AFBC8BF10DBE2ABEE3FA110723#/metadata/17a6a735-8bd0-4258-ae32-883c8a8f4af5)
152
- - Water Protection Areas (Baden-W\xFCrtemberg) <br />
153
- \xA9 Landesanstalt f\xFCr Umwelt Baden-W\xFCrtemberg (LUBW) (2024) <br />
154
- [Datasources / Datenquellen](https://rips-metadaten.lubw.de/trefferanzeige?docuuid=ec2d7bcc-1f56-4596-bbc0-459ddb6a1a82)
155
- - Water Protection Areas (Nordrhein-Westfalen) <br />
156
- \xA9 Landesamt f\xFCr Natur, Umwelt und Verbraucherschutz (LANUV) NRW <br />
157
- Fachbereich 56: Wasserwirtschaftlicher Datenverbund, ELWAS-Gesch\xE4ftsstelle, 2024`,
104
+ If the field is set to \`null\`, no water protection area could be assigned.`,
158
105
  example: true
159
106
  },
160
107
  heated: {
@@ -162,13 +109,7 @@ If the field is set to \`null\`, no water protection area could be assigned.
162
109
  description: `
163
110
  The \`heated\` field specifies whether the building is heated or not.
164
111
 
165
- The field is set to \`null\` if the heating status is unknown.
166
-
167
- <br /><br />**Datasources / Datenquellen:**<br /><br />
168
-
169
- - Geb\xE4udefunktionsklasse (GFK) (Manual Assignment of the Heating Status) <br />
170
- \xA9 Geodateninfrastruktur Deutschland (2024) <br />
171
- [Datasources / Datenquellen](https://repository.gdi-de.org/schemas/adv/citygml/Codelisten/BuildingFunctionTypeAdV.xml)`,
112
+ The field is set to \`null\` if the heating status is unknown.`,
172
113
  example: true
173
114
  },
174
115
  heat_demand: {
@@ -177,13 +118,7 @@ The field is set to \`null\` if the heating status is unknown.
177
118
  description: `
178
119
  The \`heat_demand\` field specifies the heat demand of the building in [kWh/m\xB2a].
179
120
 
180
- The field is set to \`null\` if the heat demand is unknown.
181
-
182
- <br /><br />**Datasources / Datenquellen:**<br /><br />
183
-
184
- - Kommunale W\xE4rmeplanung NRW (KWP-NRW) <br />
185
- \xA9 Landesamt f\xFCr Natur, Umwelt und Verbraucherschutz (LANUV) NRW (2024)<br />
186
- [Datasources / Datenquellen]https://www.opengeodata.nrw.de/produkte/umwelt_klima/klima/kwp/)`,
121
+ The field is set to \`null\` if the heat demand is unknown.`,
187
122
  example: 127.42
188
123
  },
189
124
  height_category: {
@@ -204,12 +139,6 @@ number between 1 and 6, where 1 is the lowest and 6 is the highest category.
204
139
 
205
140
  If the height category is unknown, the field is set to \`null\`.
206
141
 
207
- <br /><br />**Datasources / Datenquellen:**<br /><br />
208
-
209
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
210
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
211
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)
212
-
213
142
  <br /><br />**Warning:**<br /><br />
214
143
 
215
144
  This field is deprecated and will be removed in future API versions. It is no longer actively supported and may be omitted from upcoming endpoints. We recommend updating your implementation to use the latest supported fields.
@@ -236,12 +165,6 @@ number between 1 and 6, where 1 is the lowest and 6 is the highest category.
236
165
 
237
166
  The field is set to \`null\` if the number of height category is unknown.
238
167
 
239
- <br /><br />**Datasources / Datenquellen:**<br /><br />
240
-
241
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
242
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
243
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)
244
-
245
168
  <br /><br />**Warning:**<br /><br />
246
169
 
247
170
  This field is deprecated and will be no longer supported in future datasets.`,
@@ -254,15 +177,7 @@ This field is deprecated and will be no longer supported in future datasets.`,
254
177
  description: `
255
178
  The \`levels\` field specifies the number of levels in the building.
256
179
 
257
- The field is set to \`null\` if the number of levels is unknown.
258
-
259
- <br /><br />**Datasources / Datenquellen:**<br /><br />
260
-
261
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
262
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
263
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)
264
- - Additionally, this field is enhanced using a proprietary machine learning model developed to estimate levels
265
- where explicit data is unavailable.`,
180
+ The field is set to \`null\` if the number of levels is unknown.`,
266
181
  example: 4
267
182
  },
268
183
  household_count: {
@@ -271,13 +186,7 @@ The field is set to \`null\` if the number of levels is unknown.
271
186
  description: `
272
187
  The \`household_count\` field specifies the number of households in the building.
273
188
 
274
- The field is set to \`null\` if the number of households is unknown.
275
-
276
- <br /><br />**Datasources / Datenquellen:**<br /><br />
277
-
278
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
279
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
280
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)`,
189
+ The field is set to \`null\` if the number of households is unknown.`,
281
190
  example: 3
282
191
  },
283
192
  net_area: {
@@ -314,12 +223,6 @@ The \`usage\` field specifies the usage of the building. This field can have one
314
223
 
315
224
  If the usage is unknown, the field is set to \`null\`.
316
225
 
317
- <br /><br />**Datasources / Datenquellen:**<br /><br />
318
-
319
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
320
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
321
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)
322
-
323
226
  <br /><br />**Warning:**<br /><br />
324
227
 
325
228
  This field is deprecated and will be removed in future API versions. It is no longer actively supported and may be omitted from upcoming endpoints. We recommend updating your implementation to use the latest supported fields.`,
@@ -339,12 +242,6 @@ The \`usage_class\` field specifies the usage of the building. This field can ha
339
242
 
340
243
  If the usage is unknown, the field is set to \`null\`.
341
244
 
342
- <br /><br />**Datasources / Datenquellen:**<br /><br />
343
-
344
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
345
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
346
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)
347
-
348
245
  <br /><br />**Warning:**<br /><br />
349
246
 
350
247
  This field is deprecated and will be removed in future API versions. It is no longer actively supported and may be omitted from upcoming endpoints. We recommend updating your implementation to use the latest supported fields.`,
@@ -368,13 +265,7 @@ various types of residential and non-residential buildings. This field can have
368
265
  - **office_other**: Office or other building
369
266
  - **factory_warehouse**: Factory or warehouse building
370
267
 
371
- If the characteristics is unknown, the field is set to \`null\`.
372
-
373
- <br /><br />**Datasources / Datenquellen:**<br /><br />
374
-
375
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
376
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
377
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)`,
268
+ If the characteristics is unknown, the field is set to \`null\`.`,
378
269
  example: "residential_block"
379
270
  },
380
271
  characteristics_class: {
@@ -395,13 +286,7 @@ various types of residential and non-residential buildings. This field can have
395
286
  - **8**: Office or other building
396
287
  - **9**: Factory or warehouse building
397
288
 
398
- If the characteristics_class is unknown, the field is set to \`null\`.
399
-
400
- <br /><br />**Datasources / Datenquellen:**<br /><br />
401
-
402
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
403
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
404
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)`,
289
+ If the characteristics_class is unknown, the field is set to \`null\`.`,
405
290
  example: 1
406
291
  },
407
292
  development_layout: {
@@ -474,13 +359,7 @@ values: the lower and upper bound of the construction year and can have one of t
474
359
  - **[2011, 2015]**
475
360
  - **[2016, 2024]**
476
361
 
477
- If the construction year class is unknown, the field is set to \`null\`.
478
-
479
- <br /><br />**Datasources / Datenquellen:**<br /><br />
480
-
481
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
482
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
483
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)`,
362
+ If the construction year class is unknown, the field is set to \`null\`.`,
484
363
  example: [1990, 1995]
485
364
  },
486
365
  construction_year_range_class: {
@@ -503,13 +382,7 @@ The \`construction_year_range_class\` field specifies the approximate constructi
503
382
  - **11**: 2011 - 2015
504
383
  - **12**: 2016 - 2024
505
384
 
506
- If the construction year range class is unknown, the field is set to \`null\`.
507
-
508
- <br /><br />**Datasources / Datenquellen:**<br /><br />
509
-
510
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
511
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
512
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)`,
385
+ If the construction year range class is unknown, the field is set to \`null\`.`,
513
386
  example: 1
514
387
  },
515
388
  construction_year: {
@@ -535,13 +408,7 @@ The field is set to \`null\` if the heritage status is unknown.`,
535
408
  description: `
536
409
  The \`geo_conductivity_100\` field specifies the geothermal conductivity in 100 m depth.
537
410
 
538
- The field is set to \`null\` if the geothermal conductivity is unknown.
539
-
540
- <br /><br />**Datasources / Datenquellen:**<br /><br />
541
-
542
- - Geothermic Potential in 100 m depth (NRW) <br />
543
- \xA9 Geologischer Dienst (GD) NRW (2024) <br />
544
- [Datasources / Datenquellen](https://open.nrw/dataset/912ad0a6-5eb4-4df3-a19f-908c33650964)`,
411
+ The field is set to \`null\` if the geothermal conductivity is unknown.`,
545
412
  example: 2
546
413
  },
547
414
  heat_pump_air_possible: {
@@ -551,16 +418,7 @@ The \`heat_pump_air_possible\` field indicates whether an air-source heat pump i
551
418
 
552
419
  - Set to \`true\` if an air-source heat pump is feasible.
553
420
  - Set to \`false\` if an air-source heat pump is not feasible.
554
- - Set to \`null\` if the information is unknown.
555
-
556
- <br /><br />**Datasources / Datenquellen:**<br /><br />
557
-
558
- - 3D-Geb\xE4udemodelle LoD2 Deutschland (LoD2-DE) <br />
559
- \xA9 GeoBasis-DE / BKG (2024)<br />
560
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)
561
- - Flurst\xFCcksinformationen Deutschland (FS-DE) <br />
562
- \xA9 GeoBasis-DE / BKG (2024)<br />
563
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)`,
421
+ - Set to \`null\` if the information is unknown.`,
564
422
  example: true
565
423
  },
566
424
  heat_pump_maximal_distance_drillings: {
@@ -570,16 +428,7 @@ The \`heat_pump_air_possible\` field indicates whether an air-source heat pump i
570
428
  The \`heat_pump_maximal_distance_drillings\` field specifies the maximum allowable distance between drillings for a heat pump installation, measured in meters.
571
429
  This field will be deprecated in future versions. Please use \`heat_pump_maximal_distance_drillings_5m\` instead.
572
430
 
573
- The field is set to \`null\` if the information is unknown.
574
-
575
- <br /><br />**Datasources / Datenquellen:**<br /><br />
576
-
577
- - 3D-Geb\xE4udemodelle LoD2 Deutschland (LoD2-DE) <br />
578
- \xA9 GeoBasis-DE / BKG (2024)<br />
579
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)
580
- - Flurst\xFCcksinformationen Deutschland (FS-DE) <br />
581
- \xA9 GeoBasis-DE / BKG (2024)<br />
582
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)`,
431
+ The field is set to \`null\` if the information is unknown.`,
583
432
  example: 100
584
433
  },
585
434
  heat_pump_maximal_distance_drillings_5m: {
@@ -588,16 +437,7 @@ The field is set to \`null\` if the information is unknown.
588
437
  description: `
589
438
  The \`heat_pump_maximal_distance_drillings_5m\` field specifies the maximum allowable distance between drillings for a heat pump installation, measured in meters.
590
439
 
591
- The field is set to \`null\` if the information is unknown.
592
-
593
- <br /><br />**Datasources / Datenquellen:**<br /><br />
594
-
595
- - 3D-Geb\xE4udemodelle LoD2 Deutschland (LoD2-DE) <br />
596
- \xA9 GeoBasis-DE / BKG (2024)<br />
597
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)
598
- - Flurst\xFCcksinformationen Deutschland (FS-DE) <br />
599
- \xA9 GeoBasis-DE / BKG (2024)<br />
600
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)`,
440
+ The field is set to \`null\` if the information is unknown.`,
601
441
  example: 100.35
602
442
  },
603
443
  heat_pump_minimal_number_possible_drillings: {
@@ -613,16 +453,7 @@ The field is set to \`null\` if the information is unknown.
613
453
 
614
454
  <br /><br />**Deprecation Warning:**<br /><br />
615
455
 
616
- Please use \`heat_pump_minimal_number_possible_drillings_5m\` instead of this field.
617
-
618
- <br /><br />**Datasources / Datenquellen:**<br /><br />
619
-
620
- - 3D-Geb\xE4udemodelle LoD2 Deutschland (LoD2-DE) <br />
621
- \xA9 GeoBasis-DE / BKG (2024)<br />
622
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)
623
- - Flurst\xFCcksinformationen Deutschland (FS-DE) <br />
624
- \xA9 GeoBasis-DE / BKG (2024)<br />
625
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)`,
456
+ Please use \`heat_pump_minimal_number_possible_drillings_5m\` instead of this field.`,
626
457
  example: 1,
627
458
  deprecated: true
628
459
  },
@@ -634,16 +465,7 @@ The \`heat_pump_minimal_number_possible_drillings_5m\` field specifies the minim
634
465
  number of drillings required for a heat pump installation with a distance of 5m
635
466
  to the parcel border.
636
467
 
637
- The field is set to \`null\` if the information is unknown.
638
-
639
- <br /><br />**Datasources / Datenquellen:**<br /><br />
640
-
641
- - 3D-Geb\xE4udemodelle LoD2 Deutschland (LoD2-DE) <br />
642
- \xA9 GeoBasis-DE / BKG (2024)<br />
643
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)
644
- - Flurst\xFCcksinformationen Deutschland (FS-DE) <br />
645
- \xA9 GeoBasis-DE / BKG (2024)<br />
646
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)`,
468
+ The field is set to \`null\` if the information is unknown.`,
647
469
  example: 1
648
470
  },
649
471
  heat_pump_minimal_number_possible_drillings_2m: {
@@ -654,16 +476,7 @@ The \`heat_pump_minimal_number_possible_drillings_2m\` field specifies the minim
654
476
  number of drillings required for a heat pump installation with a distance of 2m
655
477
  to the parcel border.
656
478
 
657
- The field is set to \`null\` if the information is unknown.
658
-
659
- <br /><br />**Datasources / Datenquellen:**<br /><br />
660
-
661
- - 3D-Geb\xE4udemodelle LoD2 Deutschland (LoD2-DE) <br />
662
- \xA9 GeoBasis-DE / BKG (2024)<br />
663
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)
664
- - Flurst\xFCcksinformationen Deutschland (FS-DE) <br />
665
- \xA9 GeoBasis-DE / BKG (2024)<br />
666
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)`,
479
+ The field is set to \`null\` if the information is unknown.`,
667
480
  example: 1
668
481
  },
669
482
  heat_pump_minimal_number_possible_drillings_no_distance: {
@@ -673,16 +486,7 @@ The field is set to \`null\` if the information is unknown.
673
486
  The \`heat_pump_minimal_number_possible_drillings_no_distance\` field specifies the minimum
674
487
  number of drillings required for a heat pump installation with no distance to the parcel border.
675
488
 
676
- The field is set to \`null\` if the information is unknown.
677
-
678
- <br /><br />**Datasources / Datenquellen:**<br /><br />
679
-
680
- - 3D-Geb\xE4udemodelle LoD2 Deutschland (LoD2-DE) <br />
681
- \xA9 GeoBasis-DE / BKG (2024)<br />
682
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)
683
- - Flurst\xFCcksinformationen Deutschland (FS-DE) <br />
684
- \xA9 GeoBasis-DE / BKG (2024)<br />
685
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)`,
489
+ The field is set to \`null\` if the information is unknown.`,
686
490
  example: 1
687
491
  },
688
492
  heat_pump_collector_free_area: {
@@ -692,17 +496,7 @@ The field is set to \`null\` if the information is unknown.
692
496
  The \`heat_pump_collector_free_area\` field specifies the sum of the free area suitable
693
497
  for a collector heat pump on parcels associated to a building.
694
498
 
695
- The field is set to \`null\` if the information is unknown.
696
-
697
- <br /><br />**Datasources / Datenquellen:**<br /><br />
698
-
699
- - 3D-Geb\xE4udemodelle LoD2 Deutschland (LoD2-DE) <br />
700
- \xA9 GeoBasis-DE / BKG (2024)<br />
701
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)
702
- - Flurst\xFCcksinformationen Deutschland (FS-DE) <br />
703
- \xA9 GeoBasis-DE / BKG (2024)<br />
704
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)
705
- `,
499
+ The field is set to \`null\` if the information is unknown.`,
706
500
  example: 100
707
501
  },
708
502
  flood_potential: {
@@ -741,13 +535,7 @@ location. The objects in the array can contain the following fields:
741
535
  A value of \`true\` means flood defenses are present, while \`false\` indicates the absence of such
742
536
  measures.
743
537
 
744
- If this array is set to \`null\`, it means that no data regarding flood potential is available for the location.
745
-
746
- <br /><br />**Datasources / Datenquellen:**<br /><br />
747
-
748
- - Flood hazard area (\xDCberflutungsfl\xE4chen-DE) <br />
749
- \xA9 WasserBLIcK/BfG & Zust\xE4ndige Beh\xF6rden der L\xE4nder (2022) <br />
750
- [Terms of Use / Nutzungsbedingungen](https://www.gesetze-im-internet.de/geonutzv/GeoNutzV.pdf)`,
538
+ If this array is set to \`null\`, it means that no data regarding flood potential is available for the location.`,
751
539
  example: [
752
540
  {
753
541
  min_recurrence: 100,
@@ -770,13 +558,7 @@ If this array is set to \`null\`, it means that no data regarding flood potentia
770
558
  description: `
771
559
  The \`suitable_roof_area\` field specifies the roof area suited for photovoltaics [m^2].
772
560
 
773
- The field is set to \`null\` if the roof area suited for photovoltaics is unknown.
774
-
775
- <br /><br />**Datasources / Datenquellen:**<br /><br />
776
-
777
- - Photovoltaics Potential on Roofs (NRW) <br />
778
- \xA9 Landesamt f\xFCr Natur, Umwelt und Verbraucherschutz (LANUV) NRW (2024) <br />
779
- [Datasources / Datenquellen](https://www.opengeodata.nrw.de/produkte/umwelt_klima/klima/solarkataster/photovoltaik/)`,
561
+ The field is set to \`null\` if the roof area suited for photovoltaics is unknown.`,
780
562
  example: 77
781
563
  },
782
564
  gross_collector_area: {
@@ -785,13 +567,7 @@ The field is set to \`null\` if the roof area suited for photovoltaics is unknow
785
567
  description: `
786
568
  The \`gross_collector_area\` field specifies the maximal collector area for photovoltaics including module frames [m^2].
787
569
 
788
- The field is set to \`null\` if the maximal collector area for photovoltaics is unknown.
789
-
790
- <br /><br />**Datasources / Datenquellen:**<br /><br />
791
-
792
- - Photovoltaics Potential on Roofs (NRW) <br />
793
- \xA9 Landesamt f\xFCr Natur, Umwelt und Verbraucherschutz (LANUV) NRW (2024) <br />
794
- [Datasources / Datenquellen](https://www.opengeodata.nrw.de/produkte/umwelt_klima/klima/solarkataster/photovoltaik/)`,
570
+ The field is set to \`null\` if the maximal collector area for photovoltaics is unknown.`,
795
571
  example: 48
796
572
  },
797
573
  net_collector_area: {
@@ -800,13 +576,7 @@ The field is set to \`null\` if the maximal collector area for photovoltaics is
800
576
  description: `
801
577
  The \`net_collector_area\` field specifies the maximal collector area for photovoltaics excluding module frames [m^2].
802
578
 
803
- The field is set to \`null\` if the maximal collector area for photovoltaics excluding module frames is unknown.
804
-
805
- <br /><br />**Datasources / Datenquellen:**<br /><br />
806
-
807
- - Photovoltaics Potential on Roofs (NRW) <br />
808
- \xA9 Landesamt f\xFCr Natur, Umwelt und Verbraucherschutz (LANUV) NRW (2024) <br />
809
- [Datasources / Datenquellen](https://www.opengeodata.nrw.de/produkte/umwelt_klima/klima/solarkataster/photovoltaik/)`,
579
+ The field is set to \`null\` if the maximal collector area for photovoltaics excluding module frames is unknown.`,
810
580
  example: 48
811
581
  },
812
582
  electricity_generation: {
@@ -815,13 +585,7 @@ The field is set to \`null\` if the maximal collector area for photovoltaics exc
815
585
  description: `
816
586
  The \`electricity_generation\` field specifies the maximal electricity generation from photovoltaics of the building per year [kWh/a].
817
587
 
818
- The field is set to \`null\` if the maximal electricity generation per year is unknown.
819
-
820
- <br /><br />**Datasources / Datenquellen:**<br /><br />
821
-
822
- - Photovoltaics Potential on Roofs (NRW) <br />
823
- \xA9 Landesamt f\xFCr Natur, Umwelt und Verbraucherschutz (LANUV) NRW (2024) <br />
824
- [Datasources / Datenquellen](https://www.opengeodata.nrw.de/produkte/umwelt_klima/klima/solarkataster/photovoltaik/)`,
588
+ The field is set to \`null\` if the maximal electricity generation per year is unknown.`,
825
589
  example: 6401
826
590
  },
827
591
  nominal_power: {
@@ -830,13 +594,7 @@ The field is set to \`null\` if the maximal electricity generation per year is u
830
594
  description: `
831
595
  The \`nominal_power\` field specifies the nominal power a photovoltaics system could have at this building per year [kWp].
832
596
 
833
- The field is set to \`null\` if the the nominal power is unknown.
834
-
835
- <br /><br />**Datasources / Datenquellen:**<br /><br />
836
-
837
- - Photovoltaics Potential on Roofs (NRW) <br />
838
- \xA9 Landesamt f\xFCr Natur, Umwelt und Verbraucherschutz (LANUV) NRW (2024) <br />
839
- [Datasources / Datenquellen](https://www.opengeodata.nrw.de/produkte/umwelt_klima/klima/solarkataster/photovoltaik/)`,
597
+ The field is set to \`null\` if the the nominal power is unknown.`,
840
598
  example: 7.5
841
599
  }
842
600
  },
@@ -851,13 +609,7 @@ The field is set to \`null\` if the the nominal power is unknown.
851
609
  description: `
852
610
  The \`st_suitable_roof_area\` field specifies the roof area suited for solarthermie [m^2].
853
611
 
854
- The field is set to \`null\` if the roof area suited for solarthermie is unknown.
855
-
856
- <br /><br />**Datasources / Datenquellen:**<br /><br />
857
-
858
- - Solarthermal Potential (NRW) <br />
859
- \xA9 Landesamt f\xFCr Natur, Umwelt und Verbraucherschutz (LANUV) NRW (2024) <br />
860
- [Datasources / Datenquellen](https://www.opengeodata.nrw.de/produkte/umwelt_klima/klima/solarkataster/photovoltaik/)`,
612
+ The field is set to \`null\` if the roof area suited for solarthermie is unknown.`,
861
613
  example: 90
862
614
  },
863
615
  heat_generation: {
@@ -866,13 +618,7 @@ The field is set to \`null\` if the roof area suited for solarthermie is unknown
866
618
  description: `
867
619
  The \`st_heat_generation\` field specifies the potential solarthermic heat generation on this bulding [kWh/a].
868
620
 
869
- The field is set to \`null\` if the heat generation by solarthermie is unknown.
870
-
871
- <br /><br />**Datasources / Datenquellen:**<br /><br />
872
-
873
- - Solarthermal Potential (NRW) <br />
874
- \xA9 Landesamt f\xFCr Natur, Umwelt und Verbraucherschutz (LANUV) NRW (2024) <br />
875
- [Datasources / Datenquellen](https://www.opengeodata.nrw.de/produkte/umwelt_klima/klima/solarkataster/photovoltaik/)`,
621
+ The field is set to \`null\` if the heat generation by solarthermie is unknown.`,
876
622
  example: 25201
877
623
  },
878
624
  net_collector_area: {
@@ -881,13 +627,7 @@ The field is set to \`null\` if the heat generation by solarthermie is unknown.
881
627
  description: `
882
628
  The \`st_net_collector_area\` field specifies the maximal collector area for solarthermie [m^2].
883
629
 
884
- The field is set to \`null\` if the maximal collector area for solarthermie is unknown.
885
-
886
- <br /><br />**Datasources / Datenquellen:**<br /><br />
887
-
888
- - Solarthermal Potential (NRW) <br />
889
- \xA9 Landesamt f\xFCr Natur, Umwelt und Verbraucherschutz (LANUV) NRW (2024) <br />
890
- [Datasources / Datenquellen](https://www.opengeodata.nrw.de/produkte/umwelt_klima/klima/solarkataster/photovoltaik/) `,
630
+ The field is set to \`null\` if the maximal collector area for solarthermie is unknown.`,
891
631
  example: 25201
892
632
  }
893
633
  },
@@ -1059,11 +799,9 @@ var $LookupPropertiesV3 = {
1059
799
  street: {
1060
800
  type: ["string", "null"],
1061
801
  description: `
1062
- **Datasources / Datenquellen:**<br /><br />
802
+ The \`street\` field specifies the street name of a building.
1063
803
 
1064
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
1065
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
1066
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)`,
804
+ The field is set to \`null\` if the street is unknown.`,
1067
805
  example: "Friedrich Ebert Stra\xDFe"
1068
806
  },
1069
807
  city: {
@@ -1071,13 +809,7 @@ var $LookupPropertiesV3 = {
1071
809
  description: `
1072
810
  The \`city\` field specifies the city name of a building.
1073
811
 
1074
- The field is set to \`null\` if the city is unknown.
1075
-
1076
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1077
-
1078
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
1079
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
1080
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)`,
812
+ The field is set to \`null\` if the city is unknown.`,
1081
813
  example: "Wuppertal"
1082
814
  },
1083
815
  street_number: {
@@ -1085,13 +817,7 @@ The field is set to \`null\` if the city is unknown.
1085
817
  description: `
1086
818
  The \`street_number\` field specifies the street number name of a building.
1087
819
 
1088
- The field is set to \`null\` if the street number is unknown.
1089
-
1090
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1091
-
1092
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
1093
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
1094
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)`,
820
+ The field is set to \`null\` if the street number is unknown.`,
1095
821
  example: "107"
1096
822
  },
1097
823
  postcode: {
@@ -1099,13 +825,7 @@ The field is set to \`null\` if the street number is unknown.
1099
825
  description: `
1100
826
  The \`postcode\` field specifies the postcode of a building.
1101
827
 
1102
- The field is set to \`null\` if the postcode is unknown.
1103
-
1104
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1105
-
1106
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
1107
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
1108
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)`,
828
+ The field is set to \`null\` if the postcode is unknown.`,
1109
829
  example: "107"
1110
830
  },
1111
831
  roof_type: {
@@ -1118,13 +838,7 @@ The \`roof_type\` field specifies the type of roof of a building. This field can
1118
838
  - **pitched**: Pitched roof
1119
839
  - **mixed**: Mixed types of roofs
1120
840
 
1121
- The field is set to \`null\` if the building type is unknown.
1122
-
1123
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1124
-
1125
- - Solarthermal Potential (NRW) <br />
1126
- \xA9 Landesamt f\xFCr Natur, Umwelt und Verbraucherschutz (LANUV) NRW (2024) <br />
1127
- [Datasources / Datenquellen](https://www.opengeodata.nrw.de/produkte/umwelt_klima/klima/solarkataster/photovoltaik/)`,
841
+ The field is set to \`null\` if the building type is unknown.`,
1128
842
  example: "flat"
1129
843
  },
1130
844
  type: {
@@ -1138,13 +852,7 @@ The \`type\` field specifies the type of building. This field can have one of th
1138
852
  - **non_residential**: Non-residential building
1139
853
  - **mixed_use**: Mixed-use building
1140
854
 
1141
- The field is set to \`null\` if the building type is unknown.
1142
-
1143
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1144
-
1145
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
1146
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
1147
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)`,
855
+ The field is set to \`null\` if the building type is unknown.`,
1148
856
  example: "single_family"
1149
857
  },
1150
858
  type_class: {
@@ -1159,13 +867,7 @@ The \`type_class\` field specifies the class of the building type. This field ca
1159
867
  - **3**: Non-residential building
1160
868
  - **4**: Mixed-use building
1161
869
 
1162
- The field is set to \`null\` if the building type is unknown.
1163
-
1164
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1165
-
1166
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
1167
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
1168
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)`,
870
+ The field is set to \`null\` if the building type is unknown.`,
1169
871
  example: 1
1170
872
  },
1171
873
  water_protected: {
@@ -1173,22 +875,7 @@ The field is set to \`null\` if the building type is unknown.
1173
875
  description: `
1174
876
  The \`water_protected\` field specifies whether the building is within a water protection area.
1175
877
 
1176
- If the field is set to \`null\`, no water protection area could be assigned.
1177
-
1178
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1179
-
1180
- - Water Protection Areas (Germany ex. Rheinland-Pfalz, Baden-W\xFCrtemberg, NRW) <br />
1181
- \xA9 WasserBLIcK/BfG & Zust\xE4ndige Beh\xF6rden der L\xE4nder (2024) <br />
1182
- [Datasources / Datenquellen](https://geoportal.bafg.de/inspire/download/AM/waterProtectionArea/datasetfeed.xml)
1183
- - Water Protection Areas (Rheinland-Pfalz) <br />
1184
- \xA9 Landesamt f\xFCr Umwelt (LfU) (2024) <br />
1185
- [Datasources / Datenquellen](https://geodienste-wasser.rlp-umwelt.de/geonetwork/srv/ger/catalog.search;jsessionid=7E55E5AFBC8BF10DBE2ABEE3FA110723#/metadata/17a6a735-8bd0-4258-ae32-883c8a8f4af5)
1186
- - Water Protection Areas (Baden-W\xFCrtemberg) <br />
1187
- \xA9 Landesanstalt f\xFCr Umwelt Baden-W\xFCrtemberg (LUBW) (2024) <br />
1188
- [Datasources / Datenquellen](https://rips-metadaten.lubw.de/trefferanzeige?docuuid=ec2d7bcc-1f56-4596-bbc0-459ddb6a1a82)
1189
- - Water Protection Areas (Nordrhein-Westfalen) <br />
1190
- \xA9 Landesamt f\xFCr Natur, Umwelt und Verbraucherschutz (LANUV) NRW <br />
1191
- Fachbereich 56: Wasserwirtschaftlicher Datenverbund, ELWAS-Gesch\xE4ftsstelle, 2024`,
878
+ If the field is set to \`null\`, no water protection area could be assigned.`,
1192
879
  example: true
1193
880
  },
1194
881
  heated: {
@@ -1196,13 +883,7 @@ If the field is set to \`null\`, no water protection area could be assigned.
1196
883
  description: `
1197
884
  The \`heated\` field specifies whether the building is heated or not.
1198
885
 
1199
- The field is set to \`null\` if the heating status is unknown.
1200
-
1201
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1202
-
1203
- - Geb\xE4udefunktionsklasse (GFK) (Manual Assignment of the Heating Status) <br />
1204
- \xA9 Geodateninfrastruktur Deutschland (2024) <br />
1205
- [Datasources / Datenquellen](https://repository.gdi-de.org/schemas/adv/citygml/Codelisten/BuildingFunctionTypeAdV.xml)`,
886
+ The field is set to \`null\` if the heating status is unknown.`,
1206
887
  example: true
1207
888
  },
1208
889
  heat_demand: {
@@ -1211,13 +892,7 @@ The field is set to \`null\` if the heating status is unknown.
1211
892
  description: `
1212
893
  The \`heat_demand\` field specifies the heat demand of the building in [kWh/m\xB2a].
1213
894
 
1214
- The field is set to \`null\` if the heat demand is unknown.
1215
-
1216
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1217
-
1218
- - Kommunale W\xE4rmeplanung NRW (KWP-NRW) <br />
1219
- \xA9 Landesamt f\xFCr Natur, Umwelt und Verbraucherschutz (LANUV) NRW (2024)<br />
1220
- [Datasources / Datenquellen]https://www.opengeodata.nrw.de/produkte/umwelt_klima/klima/kwp/)`,
895
+ The field is set to \`null\` if the heat demand is unknown.`,
1221
896
  example: 127.42
1222
897
  },
1223
898
  levels: {
@@ -1226,15 +901,7 @@ The field is set to \`null\` if the heat demand is unknown.
1226
901
  description: `
1227
902
  The \`levels\` field specifies the number of levels in the building.
1228
903
 
1229
- The field is set to \`null\` if the number of levels is unknown.
1230
-
1231
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1232
-
1233
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
1234
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
1235
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)
1236
- - Additionally, this field is enhanced using a proprietary machine learning model developed to estimate levels
1237
- where explicit data is unavailable.`,
904
+ The field is set to \`null\` if the number of levels is unknown.`,
1238
905
  example: 4
1239
906
  },
1240
907
  household_count: {
@@ -1243,13 +910,7 @@ The field is set to \`null\` if the number of levels is unknown.
1243
910
  description: `
1244
911
  The \`household_count\` field specifies the number of households in the building.
1245
912
 
1246
- The field is set to \`null\` if the number of households is unknown.
1247
-
1248
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1249
-
1250
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
1251
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
1252
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)`,
913
+ The field is set to \`null\` if the number of households is unknown.`,
1253
914
  example: 3
1254
915
  },
1255
916
  net_area: {
@@ -1291,13 +952,7 @@ various types of residential and non-residential buildings. This field can have
1291
952
  - **office_other**: Office or other building
1292
953
  - **factory_warehouse**: Factory or warehouse building
1293
954
 
1294
- If the characteristics is unknown, the field is set to \`null\`.
1295
-
1296
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1297
-
1298
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
1299
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
1300
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)`,
955
+ If the characteristics is unknown, the field is set to \`null\`.`,
1301
956
  example: "residential_block"
1302
957
  },
1303
958
  characteristics_class: {
@@ -1318,13 +973,7 @@ various types of residential and non-residential buildings. This field can have
1318
973
  - **8**: Office or other building
1319
974
  - **9**: Factory or warehouse building
1320
975
 
1321
- If the characteristics_class is unknown, the field is set to \`null\`.
1322
-
1323
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1324
-
1325
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
1326
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
1327
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)`,
976
+ If the characteristics_class is unknown, the field is set to \`null\`.`,
1328
977
  example: 1
1329
978
  },
1330
979
  development_layout: {
@@ -1397,13 +1046,7 @@ values: the lower and upper bound of the construction year and can have one of t
1397
1046
  - **[2011, 2015]**
1398
1047
  - **[2016, 2024]**
1399
1048
 
1400
- If the construction year class is unknown, the field is set to \`null\`.
1401
-
1402
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1403
-
1404
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
1405
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
1406
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)`,
1049
+ If the construction year class is unknown, the field is set to \`null\`.`,
1407
1050
  example: [1990, 1995]
1408
1051
  },
1409
1052
  construction_year_range_class: {
@@ -1426,13 +1069,7 @@ The \`construction_year_range_class\` field specifies the approximate constructi
1426
1069
  - **11**: 2011 - 2015
1427
1070
  - **12**: 2016 - 2024
1428
1071
 
1429
- If the construction year range class is unknown, the field is set to \`null\`.
1430
-
1431
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1432
-
1433
- - HH-EW-Bund (Haushalte Einwohner Bund) <br />
1434
- \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie (2024) <br />
1435
- [Datasources / Datenquellen](https://sg.geodatenzentrum.de/web_public/Datenquellen_HH-EW-Bund.pdf)`,
1072
+ If the construction year range class is unknown, the field is set to \`null\`.`,
1436
1073
  example: 1
1437
1074
  },
1438
1075
  construction_year: {
@@ -1458,13 +1095,7 @@ The field is set to \`null\` if the heritage status is unknown.`,
1458
1095
  description: `
1459
1096
  The \`geo_conductivity_100\` field specifies the geothermal conductivity in 100 m depth.
1460
1097
 
1461
- The field is set to \`null\` if the geothermal conductivity is unknown.
1462
-
1463
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1464
-
1465
- - Geothermic Potential in 100 m depth (NRW) <br />
1466
- \xA9 Geologischer Dienst (GD) NRW (2024) <br />
1467
- [Datasources / Datenquellen](https://open.nrw/dataset/912ad0a6-5eb4-4df3-a19f-908c33650964)`,
1098
+ The field is set to \`null\` if the geothermal conductivity is unknown.`,
1468
1099
  example: 2
1469
1100
  },
1470
1101
  heat_pump_air_possible: {
@@ -1474,16 +1105,7 @@ The \`heat_pump_air_possible\` field indicates whether an air-source heat pump i
1474
1105
 
1475
1106
  - Set to \`true\` if an air-source heat pump is feasible.
1476
1107
  - Set to \`false\` if an air-source heat pump is not feasible.
1477
- - Set to \`null\` if the information is unknown.
1478
-
1479
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1480
-
1481
- - 3D-Geb\xE4udemodelle LoD2 Deutschland (LoD2-DE) <br />
1482
- \xA9 GeoBasis-DE / BKG (2024)<br />
1483
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)
1484
- - Flurst\xFCcksinformationen Deutschland (FS-DE) <br />
1485
- \xA9 GeoBasis-DE / BKG (2024)<br />
1486
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)`,
1108
+ - Set to \`null\` if the information is unknown.`,
1487
1109
  example: true
1488
1110
  },
1489
1111
  heat_pump_maximal_distance_drillings: {
@@ -1493,16 +1115,7 @@ The \`heat_pump_air_possible\` field indicates whether an air-source heat pump i
1493
1115
  The \`heat_pump_maximal_distance_drillings\` field specifies the maximum allowable distance between drillings for a heat pump installation, measured in meters.
1494
1116
  This field will be deprecated in future versions. Please use \`heat_pump_maximal_distance_drillings_5m\` instead.
1495
1117
 
1496
- The field is set to \`null\` if the information is unknown.
1497
-
1498
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1499
-
1500
- - 3D-Geb\xE4udemodelle LoD2 Deutschland (LoD2-DE) <br />
1501
- \xA9 GeoBasis-DE / BKG (2024)<br />
1502
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)
1503
- - Flurst\xFCcksinformationen Deutschland (FS-DE) <br />
1504
- \xA9 GeoBasis-DE / BKG (2024)<br />
1505
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)`,
1118
+ The field is set to \`null\` if the information is unknown.`,
1506
1119
  example: 100
1507
1120
  },
1508
1121
  heat_pump_maximal_distance_drillings_5m: {
@@ -1511,16 +1124,7 @@ The field is set to \`null\` if the information is unknown.
1511
1124
  description: `
1512
1125
  The \`heat_pump_maximal_distance_drillings_5m\` field specifies the maximum allowable distance between drillings for a heat pump installation, measured in meters.
1513
1126
 
1514
- The field is set to \`null\` if the information is unknown.
1515
-
1516
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1517
-
1518
- - 3D-Geb\xE4udemodelle LoD2 Deutschland (LoD2-DE) <br />
1519
- \xA9 GeoBasis-DE / BKG (2024)<br />
1520
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)
1521
- - Flurst\xFCcksinformationen Deutschland (FS-DE) <br />
1522
- \xA9 GeoBasis-DE / BKG (2024)<br />
1523
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)`,
1127
+ The field is set to \`null\` if the information is unknown.`,
1524
1128
  example: 100.35
1525
1129
  },
1526
1130
  heat_pump_minimal_number_possible_drillings: {
@@ -1536,16 +1140,7 @@ The field is set to \`null\` if the information is unknown.
1536
1140
 
1537
1141
  <br /><br />**Deprecation Warning:**<br /><br />
1538
1142
 
1539
- Please use \`heat_pump_minimal_number_possible_drillings_5m\` instead of this field.
1540
-
1541
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1542
-
1543
- - 3D-Geb\xE4udemodelle LoD2 Deutschland (LoD2-DE) <br />
1544
- \xA9 GeoBasis-DE / BKG (2024)<br />
1545
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)
1546
- - Flurst\xFCcksinformationen Deutschland (FS-DE) <br />
1547
- \xA9 GeoBasis-DE / BKG (2024)<br />
1548
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)`,
1143
+ Please use \`heat_pump_minimal_number_possible_drillings_5m\` instead of this field.`,
1549
1144
  example: 1,
1550
1145
  deprecated: true
1551
1146
  },
@@ -1557,16 +1152,7 @@ The \`heat_pump_minimal_number_possible_drillings_5m\` field specifies the minim
1557
1152
  number of drillings required for a heat pump installation with a distance of 5m
1558
1153
  to the parcel border.
1559
1154
 
1560
- The field is set to \`null\` if the information is unknown.
1561
-
1562
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1563
-
1564
- - 3D-Geb\xE4udemodelle LoD2 Deutschland (LoD2-DE) <br />
1565
- \xA9 GeoBasis-DE / BKG (2024)<br />
1566
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)
1567
- - Flurst\xFCcksinformationen Deutschland (FS-DE) <br />
1568
- \xA9 GeoBasis-DE / BKG (2024)<br />
1569
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)`,
1155
+ The field is set to \`null\` if the information is unknown.`,
1570
1156
  example: 1
1571
1157
  },
1572
1158
  heat_pump_minimal_number_possible_drillings_2m: {
@@ -1577,16 +1163,7 @@ The \`heat_pump_minimal_number_possible_drillings_2m\` field specifies the minim
1577
1163
  number of drillings required for a heat pump installation with a distance of 2m
1578
1164
  to the parcel border.
1579
1165
 
1580
- The field is set to \`null\` if the information is unknown.
1581
-
1582
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1583
-
1584
- - 3D-Geb\xE4udemodelle LoD2 Deutschland (LoD2-DE) <br />
1585
- \xA9 GeoBasis-DE / BKG (2024)<br />
1586
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)
1587
- - Flurst\xFCcksinformationen Deutschland (FS-DE) <br />
1588
- \xA9 GeoBasis-DE / BKG (2024)<br />
1589
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)`,
1166
+ The field is set to \`null\` if the information is unknown.`,
1590
1167
  example: 1
1591
1168
  },
1592
1169
  heat_pump_minimal_number_possible_drillings_no_distance: {
@@ -1596,16 +1173,7 @@ The field is set to \`null\` if the information is unknown.
1596
1173
  The \`heat_pump_minimal_number_possible_drillings_no_distance\` field specifies the minimum
1597
1174
  number of drillings required for a heat pump installation with no distance to the parcel border.
1598
1175
 
1599
- The field is set to \`null\` if the information is unknown.
1600
-
1601
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1602
-
1603
- - 3D-Geb\xE4udemodelle LoD2 Deutschland (LoD2-DE) <br />
1604
- \xA9 GeoBasis-DE / BKG (2024)<br />
1605
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)
1606
- - Flurst\xFCcksinformationen Deutschland (FS-DE) <br />
1607
- \xA9 GeoBasis-DE / BKG (2024)<br />
1608
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)`,
1176
+ The field is set to \`null\` if the information is unknown.`,
1609
1177
  example: 1
1610
1178
  },
1611
1179
  heat_pump_collector_free_area: {
@@ -1615,17 +1183,7 @@ The field is set to \`null\` if the information is unknown.
1615
1183
  The \`heat_pump_collector_free_area\` field specifies the sum of the free area suitable
1616
1184
  for a collector heat pump on parcels associated to a building.
1617
1185
 
1618
- The field is set to \`null\` if the information is unknown.
1619
-
1620
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1621
-
1622
- - 3D-Geb\xE4udemodelle LoD2 Deutschland (LoD2-DE) <br />
1623
- \xA9 GeoBasis-DE / BKG (2024)<br />
1624
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)
1625
- - Flurst\xFCcksinformationen Deutschland (FS-DE) <br />
1626
- \xA9 GeoBasis-DE / BKG (2024)<br />
1627
- [Terms of Use](https://sg.geodatenzentrum.de/web_public/nutzungsbedingungen.pdf)
1628
- `,
1186
+ The field is set to \`null\` if the information is unknown.`,
1629
1187
  example: 100
1630
1188
  },
1631
1189
  flood_potential: {
@@ -1664,13 +1222,7 @@ location. The objects in the array can contain the following fields:
1664
1222
  A value of \`true\` means flood defenses are present, while \`false\` indicates the absence of such
1665
1223
  measures.
1666
1224
 
1667
- If this array is set to \`null\`, it means that no data regarding flood potential is available for the location.
1668
-
1669
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1670
-
1671
- - Flood hazard area (\xDCberflutungsfl\xE4chen-DE) <br />
1672
- \xA9 WasserBLIcK/BfG & Zust\xE4ndige Beh\xF6rden der L\xE4nder (2022) <br />
1673
- [Terms of Use / Nutzungsbedingungen](https://www.gesetze-im-internet.de/geonutzv/GeoNutzV.pdf)`,
1225
+ If this array is set to \`null\`, it means that no data regarding flood potential is available for the location.`,
1674
1226
  example: [
1675
1227
  {
1676
1228
  min_recurrence: 100,
@@ -1693,13 +1245,7 @@ If this array is set to \`null\`, it means that no data regarding flood potentia
1693
1245
  description: `
1694
1246
  The \`suitable_roof_area\` field specifies the roof area suited for photovoltaics [m^2].
1695
1247
 
1696
- The field is set to \`null\` if the roof area suited for photovoltaics is unknown.
1697
-
1698
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1699
-
1700
- - Photovoltaics Potential on Roofs (NRW) <br />
1701
- \xA9 Landesamt f\xFCr Natur, Umwelt und Verbraucherschutz (LANUV) NRW (2024) <br />
1702
- [Datasources / Datenquellen](https://www.opengeodata.nrw.de/produkte/umwelt_klima/klima/solarkataster/photovoltaik/)`,
1248
+ The field is set to \`null\` if the roof area suited for photovoltaics is unknown.`,
1703
1249
  example: 77
1704
1250
  },
1705
1251
  gross_collector_area: {
@@ -1708,13 +1254,7 @@ The field is set to \`null\` if the roof area suited for photovoltaics is unknow
1708
1254
  description: `
1709
1255
  The \`gross_collector_area\` field specifies the maximal collector area for photovoltaics including module frames [m^2].
1710
1256
 
1711
- The field is set to \`null\` if the maximal collector area for photovoltaics is unknown.
1712
-
1713
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1714
-
1715
- - Photovoltaics Potential on Roofs (NRW) <br />
1716
- \xA9 Landesamt f\xFCr Natur, Umwelt und Verbraucherschutz (LANUV) NRW (2024) <br />
1717
- [Datasources / Datenquellen](https://www.opengeodata.nrw.de/produkte/umwelt_klima/klima/solarkataster/photovoltaik/)`,
1257
+ The field is set to \`null\` if the maximal collector area for photovoltaics is unknown.`,
1718
1258
  example: 48
1719
1259
  },
1720
1260
  net_collector_area: {
@@ -1723,13 +1263,7 @@ The field is set to \`null\` if the maximal collector area for photovoltaics is
1723
1263
  description: `
1724
1264
  The \`net_collector_area\` field specifies the maximal collector area for photovoltaics excluding module frames [m^2].
1725
1265
 
1726
- The field is set to \`null\` if the maximal collector area for photovoltaics excluding module frames is unknown.
1727
-
1728
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1729
-
1730
- - Photovoltaics Potential on Roofs (NRW) <br />
1731
- \xA9 Landesamt f\xFCr Natur, Umwelt und Verbraucherschutz (LANUV) NRW (2024) <br />
1732
- [Datasources / Datenquellen](https://www.opengeodata.nrw.de/produkte/umwelt_klima/klima/solarkataster/photovoltaik/)`,
1266
+ The field is set to \`null\` if the maximal collector area for photovoltaics excluding module frames is unknown.`,
1733
1267
  example: 48
1734
1268
  },
1735
1269
  electricity_generation: {
@@ -1738,13 +1272,7 @@ The field is set to \`null\` if the maximal collector area for photovoltaics exc
1738
1272
  description: `
1739
1273
  The \`electricity_generation\` field specifies the maximal electricity generation from photovoltaics of the building per year [kWh/a].
1740
1274
 
1741
- The field is set to \`null\` if the maximal electricity generation per year is unknown.
1742
-
1743
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1744
-
1745
- - Photovoltaics Potential on Roofs (NRW) <br />
1746
- \xA9 Landesamt f\xFCr Natur, Umwelt und Verbraucherschutz (LANUV) NRW (2024) <br />
1747
- [Datasources / Datenquellen](https://www.opengeodata.nrw.de/produkte/umwelt_klima/klima/solarkataster/photovoltaik/)`,
1275
+ The field is set to \`null\` if the maximal electricity generation per year is unknown.`,
1748
1276
  example: 6401
1749
1277
  },
1750
1278
  nominal_power: {
@@ -1753,13 +1281,7 @@ The field is set to \`null\` if the maximal electricity generation per year is u
1753
1281
  description: `
1754
1282
  The \`nominal_power\` field specifies the nominal power a photovoltaics system could have at this building per year [kWp].
1755
1283
 
1756
- The field is set to \`null\` if the the nominal power is unknown.
1757
-
1758
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1759
-
1760
- - Photovoltaics Potential on Roofs (NRW) <br />
1761
- \xA9 Landesamt f\xFCr Natur, Umwelt und Verbraucherschutz (LANUV) NRW (2024) <br />
1762
- [Datasources / Datenquellen](https://www.opengeodata.nrw.de/produkte/umwelt_klima/klima/solarkataster/photovoltaik/)`,
1284
+ The field is set to \`null\` if the the nominal power is unknown.`,
1763
1285
  example: 7.5
1764
1286
  }
1765
1287
  },
@@ -1774,13 +1296,7 @@ The field is set to \`null\` if the the nominal power is unknown.
1774
1296
  description: `
1775
1297
  The \`st_suitable_roof_area\` field specifies the roof area suited for solarthermie [m^2].
1776
1298
 
1777
- The field is set to \`null\` if the roof area suited for solarthermie is unknown.
1778
-
1779
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1780
-
1781
- - Solarthermal Potential (NRW) <br />
1782
- \xA9 Landesamt f\xFCr Natur, Umwelt und Verbraucherschutz (LANUV) NRW (2024) <br />
1783
- [Datasources / Datenquellen](https://www.opengeodata.nrw.de/produkte/umwelt_klima/klima/solarkataster/photovoltaik/)`,
1299
+ The field is set to \`null\` if the roof area suited for solarthermie is unknown.`,
1784
1300
  example: 90
1785
1301
  },
1786
1302
  heat_generation: {
@@ -1789,13 +1305,7 @@ The field is set to \`null\` if the roof area suited for solarthermie is unknown
1789
1305
  description: `
1790
1306
  The \`st_heat_generation\` field specifies the potential solarthermic heat generation on this bulding [kWh/a].
1791
1307
 
1792
- The field is set to \`null\` if the heat generation by solarthermie is unknown.
1793
-
1794
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1795
-
1796
- - Solarthermal Potential (NRW) <br />
1797
- \xA9 Landesamt f\xFCr Natur, Umwelt und Verbraucherschutz (LANUV) NRW (2024) <br />
1798
- [Datasources / Datenquellen](https://www.opengeodata.nrw.de/produkte/umwelt_klima/klima/solarkataster/photovoltaik/)`,
1308
+ The field is set to \`null\` if the heat generation by solarthermie is unknown.`,
1799
1309
  example: 25201
1800
1310
  },
1801
1311
  net_collector_area: {
@@ -1804,13 +1314,7 @@ The field is set to \`null\` if the heat generation by solarthermie is unknown.
1804
1314
  description: `
1805
1315
  The \`st_net_collector_area\` field specifies the maximal collector area for solarthermie [m^2].
1806
1316
 
1807
- The field is set to \`null\` if the maximal collector area for solarthermie is unknown.
1808
-
1809
- <br /><br />**Datasources / Datenquellen:**<br /><br />
1810
-
1811
- - Solarthermal Potential (NRW) <br />
1812
- \xA9 Landesamt f\xFCr Natur, Umwelt und Verbraucherschutz (LANUV) NRW (2024) <br />
1813
- [Datasources / Datenquellen](https://www.opengeodata.nrw.de/produkte/umwelt_klima/klima/solarkataster/photovoltaik/) `,
1317
+ The field is set to \`null\` if the maximal collector area for solarthermie is unknown.`,
1814
1318
  example: 25201
1815
1319
  }
1816
1320
  },
@@ -2486,6 +1990,36 @@ This value is typically expressed as an annual amount per person or household an
2486
1990
 
2487
1991
  The field is set to \`null\` if the purchasing power is unknown.`,
2488
1992
  example: 14e3
1993
+ },
1994
+ building_volume_ratio_weighted: {
1995
+ type: ["number", "null"],
1996
+ minimum: 0,
1997
+ description: `
1998
+ The \`building_volume_ratio_weighted\` field specifies the weighted building volume ratio (also known as "Baumassezahl") of the building. This value represents the density context a building is situated in, rather than isolating its individual volume contribution.
1999
+
2000
+ The building volume ratio is conceptually defined as building volume divided by parcel area, where building volume is calculated as footprint area multiplied by roof height (estimated as the average of ridge_above_ground_weighted and eave_above_ground_weighted).
2001
+
2002
+ Since our data is associated with buildings rather than parcels, this weighted calculation accounts for cases where buildings share parcels. The value is computed by:
2003
+ 1. Summing the building volume per parcel across all associated buildings
2004
+ 2. Dividing by the sum of corresponding parcel areas across all associated buildings
2005
+
2006
+ If \`number_parcels_per_building == 1\`, then this value is equivalent to an unaggregated building volume ratio.
2007
+
2008
+ The field is set to \`null\` if the building volume ratio is unknown.`,
2009
+ example: 1.23
2010
+ },
2011
+ number_parcels_per_building: {
2012
+ type: ["number", "null"],
2013
+ minimum: 0,
2014
+ description: `
2015
+ The \`number_parcels_per_building\` field specifies the number of parcels a building is associated with. This value provides context for the weighted nature of the \`building_volume_ratio_weighted\` attribute.
2016
+
2017
+ When \`number_parcels_per_building == 1\`, the \`building_volume_ratio_weighted\` is equivalent to an unaggregated building volume ratio. When the value is greater than 1, it indicates that the building is situated on multiple parcels, and the weighted calculation accounts for this shared context.
2018
+
2019
+ This information is useful for understanding the density context of a building and interpreting the weighted building volume ratio calculation.
2020
+
2021
+ The field is set to \`null\` if the number of parcels is unknown.`,
2022
+ example: 2
2489
2023
  }
2490
2024
  },
2491
2025
  required: ["street", "city", "street_number", "postcode", "roof_type", "type", "type_class", "water_protected", "heated", "heat_demand", "levels", "household_count", "net_area", "footprint_area", "characteristics", "characteristics_class", "development_layout", "development_layout_class", "construction_year_range", "construction_year_range_class", "construction_year", "heritage", "geo_conductivity_100", "heat_pump_air_possible", "heat_pump_maximal_distance_drillings", "heat_pump_maximal_distance_drillings_5m", "heat_pump_minimal_number_possible_drillings", "heat_pump_minimal_number_possible_drillings_5m", "heat_pump_minimal_number_possible_drillings_2m", "heat_pump_minimal_number_possible_drillings_no_distance", "heat_pump_collector_free_area", "flood_potential", "photovoltaic_potential", "solarthermal_potential", "matching_addresses", "eave_above_ground_weighted", "eave_above_ground_min", "eave_above_ground_max", "ridge_above_ground_weighted", "ridge_above_ground_min", "ridge_above_ground_max", "number_original_geometries", "roof_area", "outer_wall_area_free", "outer_wall_area_shared_heated", "outer_wall_area_shared_non_heated", "plinth_length_free", "plinth_length_shared_heated", "plinth_length_shared_non_heated", "ogc_fid", "esg", "fuelling_types", "location_rating"]