@viadukt/connect 2.13.0-next.1 → 3.0.0-next.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.
package/dist/index.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import { Options } from '@hey-api/client-fetch';
2
2
  export { createClient } from '@hey-api/client-fetch';
3
3
 
4
- declare const $LookupPropertiesV2: {
4
+ declare const $LookupPropertiesV3: {
5
5
  readonly type: "object";
6
6
  readonly properties: {
7
7
  readonly street: {
@@ -60,21 +60,6 @@ declare const $LookupPropertiesV2: {
60
60
  readonly example: 127.42;
61
61
  readonly deprecated: true;
62
62
  };
63
- readonly height_category: {
64
- readonly type: readonly ["string", "null"];
65
- readonly enum: readonly ["<= 5m", "<= 7.5m", "<= 10m", "<= 12.5m", "<= 15m", "> 15m"];
66
- readonly description: "\nThe `height_category` field specifies the height category of the building. The height category is a\nnumber between 1 and 6, where 1 is the lowest and 6 is the highest category.\n\n### Classifications\n\n- **1**: <= 5m\n- **2**: <= 7.5m\n- **3**: <= 10m\n- **4**: <= 12.5m\n- **5**: <= 15m\n- **6**: > 15m\n\nIf the height category is unknown, the field is set to `null`.\n\n<br /><br />**Warning:**<br /><br />\n\nThis 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.\n ";
67
- readonly example: "<= 5m";
68
- readonly deprecated: true;
69
- };
70
- readonly height_category_class: {
71
- readonly type: readonly ["number", "null"];
72
- readonly minimum: 1;
73
- readonly maximum: 6;
74
- readonly description: "\nThe `height_category_class` field specifies the height category of the building. The height category is a\nnumber between 1 and 6, where 1 is the lowest and 6 is the highest category.\n\n### Classifications\n\n- **1**: <= 5m\n- **2**: <= 7.5m\n- **3**: <= 10m\n- **4**: <= 12.5m\n- **5**: <= 15m\n- **6**: > 15m\n\nThe field is set to `null` if the number of height category is unknown.\n\n<br /><br />**Warning:**<br /><br />\n\nThis field is deprecated and will be no longer supported in future datasets.";
75
- readonly example: 1;
76
- readonly deprecated: true;
77
- };
78
63
  readonly levels: {
79
64
  readonly type: readonly ["number", "null"];
80
65
  readonly minimum: 1;
@@ -90,7 +75,7 @@ declare const $LookupPropertiesV2: {
90
75
  readonly net_area: {
91
76
  readonly type: readonly ["number", "null"];
92
77
  readonly minimum: 0;
93
- readonly description: "\nThe `net_area` field specifies the net area of the building in m².\n\nThe field is set to `null` if the net area is unknown.\n\nThe `net_area` was modeled according to the Raumwärmebedarfsmodell NRW as: \n`footprint_area` * `levels` * factors between 0.7 (inhabited) and 0.8 (non-inhabited)\nthe latter was done to concider e.g., inner wall area or staircases.";
78
+ readonly description: "\nThe `net_area` field specifies the net area of the building in m².\n\nThe field is set to `null` if the net area is unknown.\n\nThe `net_area` was modeled according to the Raumwärmebedarfsmodell NRW as:\n`footprint_area` * `levels` * factors between 0.7 (inhabited) and 0.8 (non-inhabited)\nthe latter was done to consider e.g., inner wall area or staircases.";
94
79
  readonly example: 127.42;
95
80
  };
96
81
  readonly footprint_area: {
@@ -99,32 +84,17 @@ declare const $LookupPropertiesV2: {
99
84
  readonly description: "\nThe `footprint_area` field specifies the footprint area of the building in m².\n\nThe field is set to `null` if the footprint area is unknown.";
100
85
  readonly example: 127.42;
101
86
  };
102
- readonly usage: {
103
- readonly type: readonly ["string", "null"];
104
- readonly enum: readonly ["residential", "non_residential", "mixed_use"];
105
- readonly description: "\nThe `usage` field specifies the usage of the building. This field can have one of the following values:\n\n- **residential**: Residential building\n- **non_residential**: Non-residential building\n- **mixed_use**: Mixed-use building\n\nIf the usage is unknown, the field is set to `null`.\n\n<br /><br />**Warning:**<br /><br />\n\nThis 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.";
106
- readonly example: "residential";
107
- readonly deprecated: true;
108
- };
109
- readonly usage_class: {
110
- readonly type: readonly ["number", "null"];
111
- readonly minimum: 1;
112
- readonly maximum: 3;
113
- readonly description: "\nThe `usage_class` field specifies the usage of the building. This field can have one of the following values:\n\n- **1**: Residential building\n- **2**: Non-residential building\n- **3**: Mixed-use building\n\nIf the usage is unknown, the field is set to `null`.\n\n<br /><br />**Warning:**<br /><br />\n\nThis 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.";
114
- readonly example: 1;
115
- readonly deprecated: true;
116
- };
117
87
  readonly characteristics: {
118
88
  readonly type: readonly ["string", "null"];
119
89
  readonly enum: readonly ["single_two_family", "row_semi_detached", "multi_family", "residential_block", "high_rise", "terrace", "farmhouse", "office_other", "factory_warehouse"];
120
- readonly description: "\nThe `characteristics` field defines the different types of building characteristics. This classification includes \nvarious types of residential and non-residential buildings. This field can have one of the following values:\n\n- **single_two_family**: Single- or two-family house\n- **row_semi_detached**: Row or semi-detached house\n- **multi_family**: Multi-family house\n- **residential_block**: Residential block\n- **high_rise**: High-rise residential building\n- **terrace**: Terrace house\n- **farmhouse**: Farmhouse\n- **office_other**: Office or other building\n- **factory_warehouse**: Factory or warehouse building\n\nIf the characteristics is unknown, the field is set to `null`.";
90
+ readonly description: "\nThe `characteristics` field defines the different types of building characteristics. This classification includes\nvarious types of residential and non-residential buildings. This field can have one of the following values:\n\n- **single_two_family**: Single- or two-family house\n- **row_semi_detached**: Row or semi-detached house\n- **multi_family**: Multi-family house\n- **residential_block**: Residential block\n- **high_rise**: High-rise residential building\n- **terrace**: Terrace house\n- **farmhouse**: Farmhouse\n- **office_other**: Office or other building\n- **factory_warehouse**: Factory or warehouse building\n\nIf the characteristics is unknown, the field is set to `null`.";
121
91
  readonly example: "residential_block";
122
92
  };
123
93
  readonly characteristics_class: {
124
94
  readonly type: readonly ["number", "null"];
125
95
  readonly minimum: 1;
126
96
  readonly maximum: 9;
127
- readonly description: "\nThe `characteristics_class` field defines the different types of building characteristics. This classification includes \nvarious types of residential and non-residential buildings. This field can have one of the following values:\n\n- **1**: Single- or two-family house\n- **2**: Row or semi-detached house\n- **3**: Multi-family house\n- **4**: Residential block\n- **5**: High-rise residential building\n- **6**: Terrace house\n- **7**: Farmhouse\n- **8**: Office or other building\n- **9**: Factory or warehouse building\n\nIf the characteristics_class is unknown, the field is set to `null`.";
97
+ readonly description: "\nThe `characteristics_class` field defines the different types of building characteristics. This classification includes\nvarious types of residential and non-residential buildings. This field can have one of the following values:\n\n- **1**: Single- or two-family house\n- **2**: Row or semi-detached house\n- **3**: Multi-family house\n- **4**: Residential block\n- **5**: High-rise residential building\n- **6**: Terrace house\n- **7**: Farmhouse\n- **8**: Office or other building\n- **9**: Factory or warehouse building\n\nIf the characteristics_class is unknown, the field is set to `null`.";
128
98
  readonly example: 1;
129
99
  };
130
100
  readonly development_layout: {
@@ -154,7 +124,7 @@ declare const $LookupPropertiesV2: {
154
124
  readonly type: readonly ["number", "null"];
155
125
  readonly minimum: 1;
156
126
  readonly maximum: 12;
157
- readonly description: "\nThe `construction_year_range_class` field specifies the approximate construction year of the building and can have one of the following values: \n\n- **1**: < 1899\n- **2**: 1900 - 1945\n- **3**: 1946 - 1960\n- **4**: 1961 - 1970\n- **5**: 1971 - 1980\n- **6**: 1981 - 1985\n- **7**: 1986 - 1995\n- **8**: 1996 - 2000\n- **9**: 2001 - 2005\n- **10**: 2006 - 2010\n- **11**: 2011 - 2015\n- **12**: 2016 - 2024\n\nIf the construction year range class is unknown, the field is set to `null`.";
127
+ readonly description: "\nThe `construction_year_range_class` field specifies the approximate construction year of the building and can have one of the following values:\n\n- **1**: < 1899\n- **2**: 1900 - 1945\n- **3**: 1946 - 1960\n- **4**: 1961 - 1970\n- **5**: 1971 - 1980\n- **6**: 1981 - 1985\n- **7**: 1986 - 1995\n- **8**: 1996 - 2000\n- **9**: 2001 - 2005\n- **10**: 2006 - 2010\n- **11**: 2011 - 2015\n- **12**: 2016 - 2024\n\nIf the construction year range class is unknown, the field is set to `null`.";
158
128
  readonly example: 1;
159
129
  };
160
130
  readonly construction_year: {
@@ -194,32 +164,32 @@ declare const $LookupPropertiesV2: {
194
164
  readonly heat_pump_minimal_number_possible_drillings: {
195
165
  readonly type: readonly ["number", "null"];
196
166
  readonly minimum: 0;
197
- readonly description: "\nThe `heat_pump_minimal_number_possible_drillings` field specifies the minimum \nnumber of drillings required for a heat pump installation with a distance of 5m \nto the parcel border.\nThis field will be deprecated in future versions. Please use `heat_pump_minimal_number_possible_drillings_5m` instead.\n\nThe field is set to `null` if the information is unknown.\n\n<br /><br />**Deprecation Warning:**<br /><br />\n\nPlease use `heat_pump_minimal_number_possible_drillings_5m` instead of this field.";
167
+ readonly description: "\nThe `heat_pump_minimal_number_possible_drillings` field specifies the minimum\nnumber of drillings required for a heat pump installation with a distance of 5m\nto the parcel border.\nThis field will be deprecated in future versions. Please use `heat_pump_minimal_number_possible_drillings_5m` instead.\n\nThe field is set to `null` if the information is unknown.\n\n<br /><br />**Deprecation Warning:**<br /><br />\n\nPlease use `heat_pump_minimal_number_possible_drillings_5m` instead of this field.";
198
168
  readonly example: 1;
199
169
  readonly deprecated: true;
200
170
  };
201
171
  readonly heat_pump_minimal_number_possible_drillings_5m: {
202
172
  readonly type: readonly ["number", "null"];
203
173
  readonly minimum: 0;
204
- readonly description: "\nThe `heat_pump_minimal_number_possible_drillings_5m` field specifies the minimum \nnumber of drillings required for a heat pump installation with a distance of 5m \nto the parcel border.\n\nThe field is set to `null` if the information is unknown.";
174
+ readonly description: "\nThe `heat_pump_minimal_number_possible_drillings_5m` field specifies the minimum\nnumber of drillings required for a heat pump installation with a distance of 5m\nto the parcel border.\n\nThe field is set to `null` if the information is unknown.";
205
175
  readonly example: 1;
206
176
  };
207
177
  readonly heat_pump_minimal_number_possible_drillings_2m: {
208
178
  readonly type: readonly ["number", "null"];
209
179
  readonly minimum: 0;
210
- readonly description: "\nThe `heat_pump_minimal_number_possible_drillings_2m` field specifies the minimum \nnumber of drillings required for a heat pump installation with a distance of 2m \nto the parcel border.\n\nThe field is set to `null` if the information is unknown.";
180
+ readonly description: "\nThe `heat_pump_minimal_number_possible_drillings_2m` field specifies the minimum\nnumber of drillings required for a heat pump installation with a distance of 2m\nto the parcel border.\n\nThe field is set to `null` if the information is unknown.";
211
181
  readonly example: 1;
212
182
  };
213
183
  readonly heat_pump_minimal_number_possible_drillings_no_distance: {
214
184
  readonly type: readonly ["number", "null"];
215
185
  readonly minimum: 0;
216
- readonly description: "\nThe `heat_pump_minimal_number_possible_drillings_no_distance` field specifies the minimum \nnumber of drillings required for a heat pump installation with no distance to the parcel border.\n\nThe field is set to `null` if the information is unknown.";
186
+ readonly description: "\nThe `heat_pump_minimal_number_possible_drillings_no_distance` field specifies the minimum\nnumber of drillings required for a heat pump installation with no distance to the parcel border.\n\nThe field is set to `null` if the information is unknown.";
217
187
  readonly example: 1;
218
188
  };
219
189
  readonly heat_pump_collector_free_area: {
220
190
  readonly type: readonly ["number", "null"];
221
191
  readonly minimum: 0;
222
- readonly description: "\nThe `heat_pump_collector_free_area` field specifies the sum of the free area suitable \nfor a collector heat pump on parcels associated to a building.\n\nThe field is set to `null` if the information is unknown.";
192
+ readonly description: "\nThe `heat_pump_collector_free_area` field specifies the sum of the free area suitable\nfor a collector heat pump on parcels associated to a building.\n\nThe field is set to `null` if the information is unknown.";
223
193
  readonly example: 100;
224
194
  };
225
195
  readonly flood_potential: {
@@ -241,7 +211,7 @@ declare const $LookupPropertiesV2: {
241
211
  };
242
212
  };
243
213
  readonly minItems: 1;
244
- readonly description: "\nThe `flood_potential` field is an array representing different flood risk scenarios for a given \nlocation. The objects in the array can contain the following fields:\n\n- `min_reccurence`: The minimum expected recurrence interval for flooding, measured in years. \n This field is optional and can be `null` if the data is unavailable. A lower value indicates more \n frequent flooding.\n \n- `max_reccurence`: The maximum expected recurrence interval for flooding, also in years. This \n field is optional and can be `null`. If provided, this value represents the upper bound of the \n flood risk interval. This field allows the specification of a range of recurrence intervals.\n \n- `protection_against_floods`: A boolean flag indicating whether flood protection measures are in \n place for the area. This field is optional and can be `null` if the information is not available. \n A value of `true` means flood defenses are present, while `false` indicates the absence of such \n measures.\n\nIf this array is set to `null`, it means that no data regarding flood potential is available for the location.";
214
+ readonly description: "\nThe `flood_potential` field is an array representing different flood risk scenarios for a given\nlocation. The objects in the array can contain the following fields:\n\n- `min_recurrence`: The minimum expected recurrence interval for flooding, measured in years.\n This field is optional and can be `null` if the data is unavailable. A lower value indicates more\n frequent flooding.\n\n- `max_recurrence`: The maximum expected recurrence interval for flooding, also in years. This\n field is optional and can be `null`. If provided, this value represents the upper bound of the\n flood risk interval. This field allows the specification of a range of recurrence intervals.\n\n- `protection_against_floods`: A boolean flag indicating whether flood protection measures are in\n place for the area. This field is optional and can be `null` if the information is not available.\n A value of `true` means flood defenses are present, while `false` indicates the absence of such\n measures.\n\nIf this array is set to `null`, it means that no data regarding flood potential is available for the location.";
245
215
  readonly example: readonly [{
246
216
  readonly min_recurrence: 100;
247
217
  readonly max_recurrence: null;
@@ -321,37 +291,37 @@ declare const $LookupPropertiesV2: {
321
291
  readonly eave_above_ground_weighted: {
322
292
  readonly type: readonly ["number", "null"];
323
293
  readonly minimum: 0;
324
- readonly description: "\nThe `eave_above_ground_weighted` field specifies the weighted average height of the eave above ground [meters]. For weighting \nthe `footprint_area` of sub-geometries was used, if a building consists of multiple. This can be traced on the basis of the \nfield `number_original_geometries`. \n\n\nThe field is set to `null` if the height is unknown.";
294
+ readonly description: "\nThe `eave_above_ground_weighted` field specifies the weighted average height of the eave above ground [meters]. For weighting\nthe `footprint_area` of sub-geometries was used, if a building consists of multiple. This can be traced on the basis of the\nfield `number_original_geometries`.\n\n\nThe field is set to `null` if the height is unknown.";
325
295
  readonly example: 11.398919537428867;
326
296
  };
327
297
  readonly eave_above_ground_min: {
328
298
  readonly type: readonly ["number", "null"];
329
299
  readonly minimum: 0;
330
- readonly description: "\nThe `eave_above_ground_min` field specifies the minimum height of the eave above ground [meters]. This is the minimal \n`eave_above_ground` within a group of sub-geometries, if a building consists of multiple. This can be traced on the basis \nof the field `number_original_geometries`.\n\nThe field is set to `null` if the height is unknown.";
300
+ readonly description: "\nThe `eave_above_ground_min` field specifies the minimum height of the eave above ground [meters]. This is the minimal\n`eave_above_ground` within a group of sub-geometries, if a building consists of multiple. This can be traced on the basis\nof the field `number_original_geometries`.\n\nThe field is set to `null` if the height is unknown.";
331
301
  readonly example: 5.7899932861328125;
332
302
  };
333
303
  readonly eave_above_ground_max: {
334
304
  readonly type: readonly ["number", "null"];
335
305
  readonly minimum: 0;
336
- readonly description: "\nThe `eave_above_ground_max` field specifies the maximum height of the eave above ground [meters]. This is the maximal \n`eave_above_ground` within a group of sub-geometries, if a building consists of multiple. This can be traced on the basis of \nthe field `number_original_geometries`.\n\n\nThe field is set to `null` if the height is unknown.";
306
+ readonly description: "\nThe `eave_above_ground_max` field specifies the maximum height of the eave above ground [meters]. This is the maximal\n`eave_above_ground` within a group of sub-geometries, if a building consists of multiple. This can be traced on the basis of\nthe field `number_original_geometries`.\n\n\nThe field is set to `null` if the height is unknown.";
337
307
  readonly example: 13.722991943359375;
338
308
  };
339
309
  readonly ridge_above_ground_weighted: {
340
310
  readonly type: readonly ["number", "null"];
341
311
  readonly minimum: 0;
342
- readonly description: "\nThe `ridge_above_ground_weighted` field specifies the weighted average height of the ridge above ground [meters]. For \nweighting the `footprint_area` of sub-geometries was used, if a building consists of multiple. This can be traced on the basis \nof the field `number_original_geometries`. \n\nThe field is set to `null` if the height is unknown.";
312
+ readonly description: "\nThe `ridge_above_ground_weighted` field specifies the weighted average height of the ridge above ground [meters]. For\nweighting the `footprint_area` of sub-geometries was used, if a building consists of multiple. This can be traced on the basis\nof the field `number_original_geometries`.\n\nThe field is set to `null` if the height is unknown.";
343
313
  readonly example: 13.619256575276214;
344
314
  };
345
315
  readonly ridge_above_ground_min: {
346
316
  readonly type: readonly ["number", "null"];
347
317
  readonly minimum: 0;
348
- readonly description: "\nThe `ridge_above_ground_min` field specifies the minimum height of the ridge above ground [meters]. This is the minimal \n`ridge_above_ground within` a group of sub-geometries, if a building consists of multiple. This can be traced on the basis of the \nfield `number_original_geometries`. \n\nThe field is set to `null` if the height is unknown.";
318
+ readonly description: "\nThe `ridge_above_ground_min` field specifies the minimum height of the ridge above ground [meters]. This is the minimal\n`ridge_above_ground within` a group of sub-geometries, if a building consists of multiple. This can be traced on the basis of the\nfield `number_original_geometries`.\n\nThe field is set to `null` if the height is unknown.";
349
319
  readonly example: 6.64300537109375;
350
320
  };
351
321
  readonly ridge_above_ground_max: {
352
322
  readonly type: readonly ["number", "null"];
353
323
  readonly minimum: 0;
354
- readonly description: "\nThe `ridge_above_ground_max` field specifies the maximum height of the ridge above ground [meters]. This is the maximal \n`ridge_above_ground` within a group of sub-geometries, if a building consists of multiple. This can be traced on the basis of the \nfield `number_original_geometries`. \n\nThe field is set to `null` if the height is unknown.";
324
+ readonly description: "\nThe `ridge_above_ground_max` field specifies the maximum height of the ridge above ground [meters]. This is the maximal\n`ridge_above_ground` within a group of sub-geometries, if a building consists of multiple. This can be traced on the basis of the\nfield `number_original_geometries`.\n\nThe field is set to `null` if the height is unknown.";
355
325
  readonly example: 16.987991333007812;
356
326
  };
357
327
  readonly number_original_geometries: {
@@ -366,21 +336,16 @@ declare const $LookupPropertiesV2: {
366
336
  readonly description: "\nThe `roof_area` field specifies the total roof area of the building [square meters].\n\nThe field is set to `null` if the roof area is unknown.";
367
337
  readonly example: 355.37342071533203;
368
338
  };
369
- readonly ogc_fid: {
370
- readonly type: readonly ["string", "null"];
371
- readonly description: "\nThe `ogc_fid` field specifies a unique identifier from the LOD2 dataset.\n\nThe field is set to `null` if the identifier is unavailable.";
372
- readonly example: "DENW29AL1000FzW2";
373
- };
374
339
  readonly outer_wall_area_free: {
375
340
  readonly type: readonly ["number", "null"];
376
341
  readonly minimum: 0;
377
- readonly description: "\nThe `outer_wall_area_free` field specifies the facade area free of adjacent structures [square meters]. \n\nThe field is set to `null` if the area is unknown.";
342
+ readonly description: "\nThe `outer_wall_area_free` field specifies the facade area free of adjacent structures [square meters].\n\nThe field is set to `null` if the area is unknown.";
378
343
  readonly example: 690.5686635568186;
379
344
  };
380
345
  readonly outer_wall_area_shared_heated: {
381
346
  readonly type: readonly ["number", "null"];
382
347
  readonly minimum: 0;
383
- readonly description: "\nThe `outer_wall_area_shared_heated` field specifies the facade area shared with heated adjacent structures [square meters]. \n\nThe field is set to `null` if the area is unknown.";
348
+ readonly description: "\nThe `outer_wall_area_shared_heated` field specifies the facade area shared with heated adjacent structures [square meters].\n\nThe field is set to `null` if the area is unknown.";
384
349
  readonly example: 202.10705297163204;
385
350
  };
386
351
  readonly outer_wall_area_shared_non_heated: {
@@ -418,423 +383,38 @@ declare const $LookupPropertiesV2: {
418
383
  readonly description: "\nThe `building_function_class` field specifies the standardized English classification of the building function according to the German GFK (Gebäudefunktionsklasse) standard.\n\nThis field categorizes buildings by their primary use or purpose, such as residential, commercial, industrial, public, or mixed-use functions.\n\nThe field is set to `null` if the building function class is unknown.";
419
384
  readonly example: "residential_building";
420
385
  };
421
- };
422
- readonly required: readonly ["street", "city", "street_number", "postcode", "roof_type", "type", "type_class", "water_protected", "heated", "heat_demand", "height_category", "height_category_class", "levels", "household_count", "net_area", "footprint_area", "usage", "usage_class", "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", "ogc_fid", "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", "building_function", "building_function_class"];
423
- };
424
- declare const $LookupPropertiesV3: {
425
- readonly type: "object";
426
- readonly properties: {
427
- readonly street: {
428
- readonly type: readonly ["string", "null"];
429
- readonly description: "\nThe `street` field specifies the street name of a building.\n\nThe field is set to `null` if the street is unknown.";
430
- readonly example: "Friedrich Ebert Straße";
431
- };
432
- readonly city: {
433
- readonly type: readonly ["string", "null"];
434
- readonly description: "\nThe `city` field specifies the city name of a building.\n\nThe field is set to `null` if the city is unknown.";
435
- readonly example: "Wuppertal";
436
- };
437
- readonly street_number: {
438
- readonly type: readonly ["string", "null"];
439
- readonly description: "\nThe `street_number` field specifies the street number name of a building.\n\nThe field is set to `null` if the street number is unknown.";
440
- readonly example: "107";
441
- };
442
- readonly postcode: {
443
- readonly type: readonly ["string", "null"];
444
- readonly description: "\nThe `postcode` field specifies the postcode of a building.\n\nThe field is set to `null` if the postcode is unknown.";
445
- readonly example: "107";
446
- };
447
- readonly roof_type: {
448
- readonly type: readonly ["string", "null"];
449
- readonly enum: readonly ["flat", "pitched", "mixed"];
450
- readonly description: "\nThe `roof_type` field specifies the type of roof of a building. This field can have one of the following values:\n\n- **flat**: Flat roof\n- **pitched**: Pitched roof\n- **mixed**: Mixed types of roofs\n\nThe field is set to `null` if the building type is unknown.";
451
- readonly example: "flat";
386
+ readonly grouping_strategy: {
387
+ readonly type: "string";
388
+ readonly enum: readonly ["proximity", "property"];
389
+ readonly default: "proximity";
390
+ readonly description: "The grouping strategy used to aggregate buildings in this result. Currently supports: proximity (cadastral based clustering) and property (cadastral, address, construction year, and roof type based grouping). Defaults to `proximity` when no strategy is specified in the request.";
391
+ readonly example: "proximity";
452
392
  };
453
- readonly type: {
393
+ readonly ogc_fid: {
454
394
  readonly type: readonly ["string", "null"];
455
- readonly enum: readonly ["single_family", "multi_family", "non_residential", "mixed_use"];
456
- readonly description: "\nThe `type` field specifies the type of building. This field can have one of the following values:\n\n- **single_family**: Single-family house\n- **multi_family**: Multi-family house\n- **non_residential**: Non-residential building\n- **mixed_use**: Mixed-use building\n\nThe field is set to `null` if the building type is unknown.";
457
- readonly example: "single_family";
458
- };
459
- readonly type_class: {
460
- readonly type: readonly ["number", "null"];
461
- readonly minimum: 1;
462
- readonly maximum: 4;
463
- readonly description: "\nThe `type_class` field specifies the class of the building type. This field can have one of the following values:\n\n- **1**: Single-family house\n- **2**: Multi-family house\n- **3**: Non-residential building\n- **4**: Mixed-use building\n\nThe field is set to `null` if the building type is unknown.";
464
- readonly example: 1;
465
- };
466
- readonly water_protected: {
467
- readonly type: readonly ["boolean", "null"];
468
- readonly description: "\nThe `water_protected` field specifies whether the building is within a water protection area.\n\nIf the field is set to `null`, no water protection area could be assigned.";
469
- readonly example: true;
470
- };
471
- readonly heated: {
472
- readonly type: readonly ["boolean", "null"];
473
- readonly description: "\nThe `heated` field specifies whether the building is heated or not.\n\nThe field is set to `null` if the heating status is unknown.";
474
- readonly example: true;
475
- };
476
- readonly heat_demand: {
477
- readonly type: readonly ["number", "null"];
478
- readonly minimum: 0;
479
- readonly description: "\nThe `heat_demand` field specifies the heat demand of the building in [kWh/m²a].\n\nThis attribute is deprecated and thus always set to `null`.\n\n<br /><br />**Warning:**<br /><br />\n\nThis 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.\n ";
480
- readonly example: 127.42;
395
+ readonly description: "\nThe `ogc_fid` field specifies a unique identifier from the LOD2 dataset. **This field is deprecated** and should no longer be used for identifying buildings.\n\nFor current and future use, refer to `building_id` (for the building geometry) or `building_address_id` (for a unique building-address combination) instead.\n\nThe field is set to `null` if the identifier is unavailable.";
396
+ readonly example: "DENW29AL1000FzW2";
481
397
  readonly deprecated: true;
482
398
  };
483
- readonly levels: {
484
- readonly type: readonly ["number", "null"];
485
- readonly minimum: 1;
486
- readonly description: "\nThe `levels` field specifies the number of levels in the building.\n\nThe field is set to `null` if the number of levels is unknown.";
487
- readonly example: 4;
488
- };
489
- readonly household_count: {
490
- readonly type: readonly ["number", "null"];
491
- readonly minimum: 0;
492
- readonly description: "\nThe `household_count` field specifies the number of households in the building.\n\nThe field is set to `null` if the number of households is unknown.";
493
- readonly example: 3;
494
- };
495
- readonly net_area: {
496
- readonly type: readonly ["number", "null"];
497
- readonly minimum: 0;
498
- readonly description: "\nThe `net_area` field specifies the net area of the building in m².\n\nThe field is set to `null` if the net area is unknown.\n\nThe `net_area` was modeled according to the Raumwärmebedarfsmodell NRW as: \n`footprint_area` * `levels` * factors between 0.7 (inhabited) and 0.8 (non-inhabited)\nthe latter was done to concider e.g., inner wall area or staircases.";
499
- readonly example: 127.42;
500
- };
501
- readonly footprint_area: {
502
- readonly type: readonly ["number", "null"];
503
- readonly minimum: 0;
504
- readonly description: "\nThe `footprint_area` field specifies the footprint area of the building in m².\n\nThe field is set to `null` if the footprint area is unknown.";
505
- readonly example: 127.42;
506
- };
507
- readonly characteristics: {
399
+ readonly federal_state: {
508
400
  readonly type: readonly ["string", "null"];
509
- readonly enum: readonly ["single_two_family", "row_semi_detached", "multi_family", "residential_block", "high_rise", "terrace", "farmhouse", "office_other", "factory_warehouse"];
510
- readonly description: "\nThe `characteristics` field defines the different types of building characteristics. This classification includes \nvarious types of residential and non-residential buildings. This field can have one of the following values:\n\n- **single_two_family**: Single- or two-family house\n- **row_semi_detached**: Row or semi-detached house\n- **multi_family**: Multi-family house\n- **residential_block**: Residential block\n- **high_rise**: High-rise residential building\n- **terrace**: Terrace house\n- **farmhouse**: Farmhouse\n- **office_other**: Office or other building\n- **factory_warehouse**: Factory or warehouse building\n\nIf the characteristics is unknown, the field is set to `null`.";
511
- readonly example: "residential_block";
512
- };
513
- readonly characteristics_class: {
514
- readonly type: readonly ["number", "null"];
515
- readonly minimum: 1;
516
- readonly maximum: 9;
517
- readonly description: "\nThe `characteristics_class` field defines the different types of building characteristics. This classification includes \nvarious types of residential and non-residential buildings. This field can have one of the following values:\n\n- **1**: Single- or two-family house\n- **2**: Row or semi-detached house\n- **3**: Multi-family house\n- **4**: Residential block\n- **5**: High-rise residential building\n- **6**: Terrace house\n- **7**: Farmhouse\n- **8**: Office or other building\n- **9**: Factory or warehouse building\n\nIf the characteristics_class is unknown, the field is set to `null`.";
518
- readonly example: 1;
401
+ readonly description: "\nThe `federal_state` field specifies the German federal state (Bundesland) in which the building is located.\n\nGermany is divided into 16 federal states:\n\n- Baden-Württemberg\n- Bayern (Bavaria)\n- Berlin\n- Brandenburg\n- Bremen\n- Hamburg\n- Hessen\n- Mecklenburg-Vorpommern\n- Niedersachsen (Lower Saxony)\n- Nordrhein-Westfalen (North Rhine-Westphalia)\n- Rheinland-Pfalz (Rhineland-Palatinate)\n- Saarland\n- Sachsen (Saxony)\n- Sachsen-Anhalt (Saxony-Anhalt)\n- Schleswig-Holstein\n- Thüringen (Thuringia)\n\nThe field is set to `null` if the federal state is unknown.";
402
+ readonly example: "Nordrhein-Westfalen";
519
403
  };
520
- readonly development_layout: {
404
+ readonly country_code: {
521
405
  readonly type: readonly ["string", "null"];
522
- readonly enum: readonly ["non_detached", "semi_detached", "detached"];
523
- readonly description: "\nThe `development_layout` field specifies the layout of the building. This field can have one of the following values:\n\n- **non_detached**: Non-detached building\n- **semi_detached**: Semi-detached building\n- **detached**: Detached building\n\nIf the development layout is unknown, the field is set to `null`.\n\nThe `development_layout` was modeled based on the number and length of intersections with heated (and buildings with unknown heating status)\n neighbouring buildings and the perimeter of a geometry as follows:\n\n**detached** = intersection_length / outline_length < 0.085\n**semi_detached** = intersection_length / outline_length >= 0.085 AND intersection_length / outline_length < 0.45 for buildings with exactly 1 intersection\n**semi_detached** = intersection_length / outline_length >= 0.085 AND intersection_length / outline_length < 0.15 for buildings with more than 1 intersections\n**non_detached** = for all other buildings";
524
- readonly example: "non_detached";
525
- };
526
- readonly development_layout_class: {
527
- readonly type: readonly ["number", "null"];
528
- readonly minimum: 1;
529
- readonly maximum: 3;
530
- readonly description: "\nThe `development_layout_class` field specifies the layout of the building. This field can have one of the following values:\n\n- **1**: Non-detached building\n- **2**: Semi-detached building\n- **3**: Detached building\n\nIf the development layout is unknown, the field is set to `null`.\n\nThe `development_layout_class` was modeled based on the number and length of intersections with heated (and buildings with unknown heating status)\n neighbouring buildings and the perimeter of a geometry as follows:\n\n**1** = intersection_length / outline_length < 0.085\n**2** = intersection_length / outline_length >= 0.085 AND intersection_length / outline_length < 0.45 for buildings with exactly 1 intersection\n**2** = intersection_length / outline_length >= 0.085 AND intersection_length / outline_length < 0.15 for buildings with more than 1 intersections\n**3** = for all other buildings";
531
- readonly example: 1;
532
- };
533
- readonly construction_year_range: {
534
- readonly type: readonly ["array", "null"];
535
- readonly prefixItems: readonly [{
536
- readonly type: readonly ["number", "null"];
537
- }, {
538
- readonly type: "number";
539
- }];
540
- readonly description: "\nThe `construction_year_range` field specifies the approximate construction year of the building. The field is a tuple with two\nvalues: the lower and upper bound of the construction year and can have one of the following value:\n\n- **[*null*, 1899]**: Construction year is somewhere up to 1899\n- **[1900, 1945]**\n- **[1946, 1960]**\n- **[1961, 1970]**\n- **[1971, 1980]**\n- **[1981, 1985]**\n- **[1986, 1995]**\n- **[1996, 2000]**\n- **[2001, 2005]**\n- **[2006, 2010]**\n- **[2011, 2015]**\n- **[2016, 2024]**\n\nIf the construction year class is unknown, the field is set to `null`.";
541
- readonly example: readonly [1990, 1995];
542
- };
543
- readonly construction_year_range_class: {
544
- readonly type: readonly ["number", "null"];
545
- readonly minimum: 1;
546
- readonly maximum: 12;
547
- readonly description: "\nThe `construction_year_range_class` field specifies the approximate construction year of the building and can have one of the following values: \n\n- **1**: < 1899\n- **2**: 1900 - 1945\n- **3**: 1946 - 1960\n- **4**: 1961 - 1970\n- **5**: 1971 - 1980\n- **6**: 1981 - 1985\n- **7**: 1986 - 1995\n- **8**: 1996 - 2000\n- **9**: 2001 - 2005\n- **10**: 2006 - 2010\n- **11**: 2011 - 2015\n- **12**: 2016 - 2024\n\nIf the construction year range class is unknown, the field is set to `null`.";
548
- readonly example: 1;
549
- };
550
- readonly construction_year: {
551
- readonly type: readonly ["number", "null"];
552
- readonly minimum: 0;
553
- readonly description: "\nThe `construction_year` field specifies the construction year of the building.\n\nIf the construction year is unknown, the field is set to `null`.";
554
- readonly example: 1993;
555
- };
556
- readonly heritage: {
557
- readonly type: readonly ["boolean", "null"];
558
- readonly description: "\nThe `heritage` field specifies whether the building is under monumental protection.\n\nThe field is set to `null` if the heritage status is unknown.";
559
- readonly example: true;
560
- };
561
- readonly geo_conductivity_100: {
562
- readonly type: readonly ["number", "null"];
563
- readonly minimum: 0;
564
- readonly description: "\nThe `geo_conductivity_100` field specifies the geothermal conductivity in 100 m depth.\n\nThe field is set to `null` if the geothermal conductivity is unknown.";
565
- readonly example: 2;
566
- };
567
- readonly heat_pump_air_possible: {
568
- readonly type: readonly ["boolean", "null"];
569
- readonly description: "\nThe `heat_pump_air_possible` field indicates whether an air-source heat pump is a viable option for the building.\n\n- Set to `true` if an air-source heat pump is feasible.\n- Set to `false` if an air-source heat pump is not feasible.\n- Set to `null` if the information is unknown.";
570
- readonly example: true;
571
- };
572
- readonly heat_pump_maximal_distance_drillings: {
573
- readonly type: readonly ["number", "null"];
574
- readonly minimum: 0;
575
- readonly description: "\nThe `heat_pump_maximal_distance_drillings` field specifies the maximum allowable distance between drillings for a heat pump installation, measured in meters.\nThis field will be deprecated in future versions. Please use `heat_pump_maximal_distance_drillings_5m` instead.\n\nThe field is set to `null` if the information is unknown.";
576
- readonly example: 100;
577
- };
578
- readonly heat_pump_maximal_distance_drillings_5m: {
579
- readonly type: readonly ["number", "null"];
580
- readonly minimum: 0;
581
- readonly description: "\nThe `heat_pump_maximal_distance_drillings_5m` field specifies the maximum allowable distance between drillings for a heat pump installation, measured in meters.\n\nThe field is set to `null` if the information is unknown.";
582
- readonly example: 100.35;
583
- };
584
- readonly heat_pump_minimal_number_possible_drillings: {
585
- readonly type: readonly ["number", "null"];
586
- readonly minimum: 0;
587
- readonly description: "\nThe `heat_pump_minimal_number_possible_drillings` field specifies the minimum \nnumber of drillings required for a heat pump installation with a distance of 5m \nto the parcel border.\nThis field will be deprecated in future versions. Please use `heat_pump_minimal_number_possible_drillings_5m` instead.\n\nThe field is set to `null` if the information is unknown.\n\n<br /><br />**Deprecation Warning:**<br /><br />\n\nPlease use `heat_pump_minimal_number_possible_drillings_5m` instead of this field.";
588
- readonly example: 1;
589
- readonly deprecated: true;
590
- };
591
- readonly heat_pump_minimal_number_possible_drillings_5m: {
592
- readonly type: readonly ["number", "null"];
593
- readonly minimum: 0;
594
- readonly description: "\nThe `heat_pump_minimal_number_possible_drillings_5m` field specifies the minimum \nnumber of drillings required for a heat pump installation with a distance of 5m \nto the parcel border.\n\nThe field is set to `null` if the information is unknown.";
595
- readonly example: 1;
596
- };
597
- readonly heat_pump_minimal_number_possible_drillings_2m: {
598
- readonly type: readonly ["number", "null"];
599
- readonly minimum: 0;
600
- readonly description: "\nThe `heat_pump_minimal_number_possible_drillings_2m` field specifies the minimum \nnumber of drillings required for a heat pump installation with a distance of 2m \nto the parcel border.\n\nThe field is set to `null` if the information is unknown.";
601
- readonly example: 1;
602
- };
603
- readonly heat_pump_minimal_number_possible_drillings_no_distance: {
604
- readonly type: readonly ["number", "null"];
605
- readonly minimum: 0;
606
- readonly description: "\nThe `heat_pump_minimal_number_possible_drillings_no_distance` field specifies the minimum \nnumber of drillings required for a heat pump installation with no distance to the parcel border.\n\nThe field is set to `null` if the information is unknown.";
607
- readonly example: 1;
608
- };
609
- readonly heat_pump_collector_free_area: {
610
- readonly type: readonly ["number", "null"];
611
- readonly minimum: 0;
612
- readonly description: "\nThe `heat_pump_collector_free_area` field specifies the sum of the free area suitable \nfor a collector heat pump on parcels associated to a building.\n\nThe field is set to `null` if the information is unknown.";
613
- readonly example: 100;
614
- };
615
- readonly flood_potential: {
616
- readonly type: readonly ["array", "null"];
617
- readonly items: {
618
- readonly type: "object";
619
- readonly properties: {
620
- readonly min_recurrence: {
621
- readonly type: readonly ["number", "null"];
622
- readonly minimum: 0;
623
- };
624
- readonly max_recurrence: {
625
- readonly type: readonly ["number", "null"];
626
- readonly minimum: 0;
627
- };
628
- readonly protection_against_floods: {
629
- readonly type: readonly ["boolean", "null"];
630
- };
631
- };
632
- };
633
- readonly minItems: 1;
634
- readonly description: "\nThe `flood_potential` field is an array representing different flood risk scenarios for a given \nlocation. The objects in the array can contain the following fields:\n\n- `min_reccurence`: The minimum expected recurrence interval for flooding, measured in years. \n This field is optional and can be `null` if the data is unavailable. A lower value indicates more \n frequent flooding.\n \n- `max_reccurence`: The maximum expected recurrence interval for flooding, also in years. This \n field is optional and can be `null`. If provided, this value represents the upper bound of the \n flood risk interval. This field allows the specification of a range of recurrence intervals.\n \n- `protection_against_floods`: A boolean flag indicating whether flood protection measures are in \n place for the area. This field is optional and can be `null` if the information is not available. \n A value of `true` means flood defenses are present, while `false` indicates the absence of such \n measures.\n\nIf this array is set to `null`, it means that no data regarding flood potential is available for the location.";
635
- readonly example: readonly [{
636
- readonly min_recurrence: 100;
637
- readonly max_recurrence: null;
638
- readonly protection_against_floods: true;
639
- }, {
640
- readonly min_recurrence: 101;
641
- readonly max_recurrence: 1000;
642
- readonly protection_against_floods: false;
643
- }];
406
+ readonly description: "\nThe `country_code` field specifies the ISO 3166-1 alpha-2 country code of the country in which the building is located.\n\nThe field is set to `null` if the country code is unknown.";
407
+ readonly example: "DE";
644
408
  };
645
- readonly photovoltaic_potential: {
409
+ readonly esg: {
646
410
  readonly type: "object";
647
411
  readonly properties: {
648
- readonly suitable_roof_area: {
412
+ readonly overall_class: {
649
413
  readonly type: readonly ["number", "null"];
650
- readonly minimum: 0;
651
- readonly description: "\nThe `suitable_roof_area` field specifies the roof area suited for photovoltaics [m^2].\n\nThe field is set to `null` if the roof area suited for photovoltaics is unknown.";
652
- readonly example: 77;
653
- };
654
- readonly gross_collector_area: {
655
- readonly type: readonly ["number", "null"];
656
- readonly minimum: 0;
657
- readonly description: "\nThe `gross_collector_area` field specifies the maximal collector area for photovoltaics including module frames [m^2].\n\nThe field is set to `null` if the maximal collector area for photovoltaics is unknown.";
658
- readonly example: 48;
659
- };
660
- readonly net_collector_area: {
661
- readonly type: readonly ["number", "null"];
662
- readonly minimum: 0;
663
- readonly description: "\nThe `net_collector_area` field specifies the maximal collector area for photovoltaics excluding module frames [m^2].\n\nThe field is set to `null` if the maximal collector area for photovoltaics excluding module frames is unknown.";
664
- readonly example: 48;
665
- };
666
- readonly electricity_generation: {
667
- readonly type: readonly ["number", "null"];
668
- readonly minimum: 0;
669
- readonly description: "\nThe `electricity_generation` field specifies the maximal electricity generation from photovoltaics of the building per year [kWh/a].\n\nThe field is set to `null` if the maximal electricity generation per year is unknown.";
670
- readonly example: 6401;
671
- };
672
- readonly nominal_power: {
673
- readonly type: readonly ["number", "null"];
674
- readonly minimum: 0;
675
- readonly description: "\nThe `nominal_power` field specifies the nominal power a photovoltaics system could have at this building per year [kWp].\n\nThe field is set to `null` if the the nominal power is unknown.";
676
- readonly example: 7.5;
677
- };
678
- };
679
- readonly required: readonly ["suitable_roof_area", "gross_collector_area", "net_collector_area", "electricity_generation", "nominal_power"];
680
- };
681
- readonly solarthermal_potential: {
682
- readonly type: "object";
683
- readonly properties: {
684
- readonly suitable_roof_area: {
685
- readonly type: readonly ["number", "null"];
686
- readonly minimum: 0;
687
- readonly description: "\nThe `st_suitable_roof_area` field specifies the roof area suited for solarthermie [m^2].\n\nThe field is set to `null` if the roof area suited for solarthermie is unknown.";
688
- readonly example: 90;
689
- };
690
- readonly heat_generation: {
691
- readonly type: readonly ["number", "null"];
692
- readonly minimum: 0;
693
- readonly description: "\nThe `st_heat_generation` field specifies the potential solarthermic heat generation on this bulding [kWh/a].\n\nThe field is set to `null` if the heat generation by solarthermie is unknown.";
694
- readonly example: 25201;
695
- };
696
- readonly net_collector_area: {
697
- readonly type: readonly ["number", "null"];
698
- readonly minimum: 0;
699
- readonly description: "\nThe `st_net_collector_area` field specifies the maximal collector area for solarthermie [m^2].\n\nThe field is set to `null` if the maximal collector area for solarthermie is unknown.";
700
- readonly example: 25201;
701
- };
702
- };
703
- readonly required: readonly ["suitable_roof_area", "heat_generation", "net_collector_area"];
704
- };
705
- readonly matching_addresses: {
706
- readonly type: readonly ["number", "null"];
707
- readonly minimum: 0;
708
- readonly description: "\nThe `matching_addresses` field indicates the number of addresses associated with the geometry.\n\nThe field is set to `null` if no matching addresses are found.";
709
- readonly example: 1;
710
- };
711
- readonly eave_above_ground_weighted: {
712
- readonly type: readonly ["number", "null"];
713
- readonly minimum: 0;
714
- readonly description: "\nThe `eave_above_ground_weighted` field specifies the weighted average height of the eave above ground [meters]. For weighting \nthe `footprint_area` of sub-geometries was used, if a building consists of multiple. This can be traced on the basis of the \nfield `number_original_geometries`. \n\n\nThe field is set to `null` if the height is unknown.";
715
- readonly example: 11.398919537428867;
716
- };
717
- readonly eave_above_ground_min: {
718
- readonly type: readonly ["number", "null"];
719
- readonly minimum: 0;
720
- readonly description: "\nThe `eave_above_ground_min` field specifies the minimum height of the eave above ground [meters]. This is the minimal \n`eave_above_ground` within a group of sub-geometries, if a building consists of multiple. This can be traced on the basis \nof the field `number_original_geometries`.\n\nThe field is set to `null` if the height is unknown.";
721
- readonly example: 5.7899932861328125;
722
- };
723
- readonly eave_above_ground_max: {
724
- readonly type: readonly ["number", "null"];
725
- readonly minimum: 0;
726
- readonly description: "\nThe `eave_above_ground_max` field specifies the maximum height of the eave above ground [meters]. This is the maximal \n`eave_above_ground` within a group of sub-geometries, if a building consists of multiple. This can be traced on the basis of \nthe field `number_original_geometries`.\n\n\nThe field is set to `null` if the height is unknown.";
727
- readonly example: 13.722991943359375;
728
- };
729
- readonly ridge_above_ground_weighted: {
730
- readonly type: readonly ["number", "null"];
731
- readonly minimum: 0;
732
- readonly description: "\nThe `ridge_above_ground_weighted` field specifies the weighted average height of the ridge above ground [meters]. For \nweighting the `footprint_area` of sub-geometries was used, if a building consists of multiple. This can be traced on the basis \nof the field `number_original_geometries`. \n\nThe field is set to `null` if the height is unknown.";
733
- readonly example: 13.619256575276214;
734
- };
735
- readonly ridge_above_ground_min: {
736
- readonly type: readonly ["number", "null"];
737
- readonly minimum: 0;
738
- readonly description: "\nThe `ridge_above_ground_min` field specifies the minimum height of the ridge above ground [meters]. This is the minimal \n`ridge_above_ground within` a group of sub-geometries, if a building consists of multiple. This can be traced on the basis of the \nfield `number_original_geometries`. \n\nThe field is set to `null` if the height is unknown.";
739
- readonly example: 6.64300537109375;
740
- };
741
- readonly ridge_above_ground_max: {
742
- readonly type: readonly ["number", "null"];
743
- readonly minimum: 0;
744
- readonly description: "\nThe `ridge_above_ground_max` field specifies the maximum height of the ridge above ground [meters]. This is the maximal \n`ridge_above_ground` within a group of sub-geometries, if a building consists of multiple. This can be traced on the basis of the \nfield `number_original_geometries`. \n\nThe field is set to `null` if the height is unknown.";
745
- readonly example: 16.987991333007812;
746
- };
747
- readonly number_original_geometries: {
748
- readonly type: readonly ["number", "null"];
749
- readonly minimum: 0;
750
- readonly description: "\nThe `number_original_geometries` field specifies the number of original geometries used for weighted calculations.\n\nThe field is set to `null` if the count is unknown.";
751
- readonly example: 3;
752
- };
753
- readonly roof_area: {
754
- readonly type: readonly ["number", "null"];
755
- readonly minimum: 0;
756
- readonly description: "\nThe `roof_area` field specifies the total roof area of the building [square meters].\n\nThe field is set to `null` if the roof area is unknown.";
757
- readonly example: 355.37342071533203;
758
- };
759
- readonly outer_wall_area_free: {
760
- readonly type: readonly ["number", "null"];
761
- readonly minimum: 0;
762
- readonly description: "\nThe `outer_wall_area_free` field specifies the facade area free of adjacent structures [square meters]. \n\nThe field is set to `null` if the area is unknown.";
763
- readonly example: 690.5686635568186;
764
- };
765
- readonly outer_wall_area_shared_heated: {
766
- readonly type: readonly ["number", "null"];
767
- readonly minimum: 0;
768
- readonly description: "\nThe `outer_wall_area_shared_heated` field specifies the facade area shared with heated adjacent structures [square meters]. \n\nThe field is set to `null` if the area is unknown.";
769
- readonly example: 202.10705297163204;
770
- };
771
- readonly outer_wall_area_shared_non_heated: {
772
- readonly type: readonly ["number", "null"];
773
- readonly minimum: 0;
774
- readonly description: "\nThe `outer_wall_area_shared_non_heated` field specifies the facade area shared with non-heated adjacent structures [square meters].\n\nThe field is set to `null` if the area is unknown.";
775
- readonly example: 298.6121580931941;
776
- };
777
- readonly plinth_length_free: {
778
- readonly type: readonly ["number", "null"];
779
- readonly minimum: 0;
780
- readonly description: "\nThe `plinth_length_free` field specifies the length of the building's plinth that is not shared with adjacent structures [meters].\n\nThe field is set to `null` if the length is unknown.";
781
- readonly example: 48.672734987814366;
782
- };
783
- readonly plinth_length_shared_heated: {
784
- readonly type: readonly ["number", "null"];
785
- readonly minimum: 0;
786
- readonly description: "\nThe `plinth_length_shared_heated` field specifies the length of the building's plinth shared with heated adjacent structures [meters].\n\nThe field is set to `null` if the length is unknown.";
787
- readonly example: 13.16187444425839;
788
- };
789
- readonly plinth_length_shared_non_heated: {
790
- readonly type: readonly ["number", "null"];
791
- readonly minimum: 0;
792
- readonly description: "\nThe `plinth_length_shared_non_heated` field specifies the length of the building's plinth shared with non-heated adjacent structures [meters].\n\nThe field is set to `null` if the length is unknown.";
793
- readonly example: 31.994775355440325;
794
- };
795
- readonly building_function: {
796
- readonly type: readonly ["string", "null"];
797
- readonly description: "\nThe `building_function` field contains the original German building function name (GFK - Gebäudefunktionsklasse) from the source data.\n\nThis is the raw German value. For the standardized English classification, use the `building_function_class` field.\n\nThe field is set to `null` if the building function is unknown.";
798
- readonly example: "Wohngebäude";
799
- };
800
- readonly building_function_class: {
801
- readonly type: readonly ["string", "null"];
802
- readonly enum: readonly ["residential_building", "residential_house", "dormitory", "childrens_home", "nursing_home", "nurses_dormitory", "student_dormitory", "school_country_home", "mixed_use_building_with_residential", "residential_building_with_public_amenities", "residential_building_with_commerce_services", "residential_and_administrative_building", "residential_and_office_building", "residential_and_commercial_building", "residential_commercial_industrial_building", "agricultural_forestry_residential_building", "agricultural_forestry_residential_commercial_building", "farmhouse", "residential_and_agricultural_building", "forest_house", "leisure_facility_building", "holiday_home", "weekend_house", "garden_house", "commercial_building", "commercial_and_service_building", "office_building", "credit_institution", "insurance_office", "department_store", "shopping_center", "market_hall", "shop", "kiosk", "pharmacy", "exhibition_hall", "accommodation_building", "hotel_motel_guesthouse", "youth_hostel", "hut_with_overnight_stay", "campground_building", "catering_building", "restaurant", "hut_no_overnight_stay", "canteen", "leisure_and_entertainment_venue", "banquet_hall", "cinema", "bowling_alley", "casino", "arcade", "commercial_and_industrial_building", "production_building", "factory", "operations_building", "brewery", "distillery", "workshop", "sawmill", "gas_station", "car_wash", "storage_building", "cold_storage", "warehouse", "freight_forwarding_building", "research_building", "raw_material_extraction_building", "mine", "saltworks", "company_social_facility_building", "other_commercial_industrial_building", "mill", "windmill", "watermill", "pumping_station", "weather_station", "commercial_service_residential_building", "commercial_industrial_residential_building", "traffic_facility_operations_building_general", "road_traffic_operations_building", "road_maintenance_depot", "waiting_hall", "rail_traffic_operations_building", "railroad_crossing_keeper_house", "locomotive_shed_carriage_hall", "signal_box_block_post", "freight_yard_operations_building", "air_traffic_operations_building", "aircraft_hangar", "maritime_traffic_operations_building", "shipyard_hall", "dock_hall", "lock_operations_building", "boathouse", "cable_car_operations_building", "cable_car_tensioning_station", "parking_building", "parking_garage", "garage", "vehicle_hall", "supply_building", "energy_supply_building", "water_supply_building", "waterworks", "water_reservoir", "electricity_supply_building", "power_plant", "substation", "transformer", "reactor_building", "turbine_house", "boiler_house", "telecommunications_building", "building_at_underground_lines", "gas_supply_building", "gas_works", "heating_plant", "utility_building", "pumping_station_non_water_supply", "disposal_building", "wastewater_treatment_building", "sewage_treatment_plant_building", "public_toilet", "waste_treatment_building", "waste_bunker", "waste_incineration_plant", "landfill_building", "agricultural_forestry_building", "agricultural_forestry_commercial_building", "barn", "shed", "stable", "barn_and_stable", "large_scale_animal_housing", "riding_hall", "alpine_hut", "hunting_lodge_cabin", "greenhouse", "moveable_greenhouse", "public_building", "administrative_building", "parliament_building", "town_hall", "post_office", "customs_office", "court_building", "embassy_consulate", "district_administration", "regional_government", "tax_office", "education_research_building", "general_education_school", "vocational_school", "higher_education_building_university", "research_institute", "cultural_building", "palace", "theater_opera", "concert_hall", "museum", "broadcasting_television", "event_building", "library", "castle_fortress", "religious_building", "church", "synagogue", "chapel", "community_hall", "house_of_worship", "mosque", "temple", "monastery", "healthcare_building", "hospital", "sanatorium_nursing_home_nursing_station", "doctors_office_polyclinic", "rescue_station", "social_services_building", "youth_center", "leisure_club_community_center", "senior_center", "homeless_shelter", "daycare_kindergarten", "refugee_shelter", "security_and_order_building", "police_station", "fire_station", "barracks", "air_raid_shelter", "correctional_facility", "cemetery_building", "funeral_hall", "crematorium", "reception_building", "railway_station_building", "airport_building", "subway_station_building", "suburban_railway_station_building", "bus_station_building", "maritime_terminal_building", "public_purpose_residential_building", "recreational_building", "sports_building", "sports_gymnasium", "sports_field_building", "bathhouse", "indoor_swimming_pool", "outdoor_pool_building", "stadium_building", "spa_facility_building", "medical_bath_building", "sanatorium", "zoo_building", "zoo_entrance_building", "aquarium_terrarium_aviary", "animal_exhibition_building", "zoo_stable", "botanical_garden_building", "botanical_garden_entrance_building", "botanical_greenhouse", "conservatory", "other_recreational_facility_building", "mountain_hut_shelter", "tourist_information_center", "not_specified_due_to_source_situation", "water_tower", "church_tower", "observation_tower", "control_tower", "cooling_tower", "lighthouse", "fire_watchtower", "transmission_radio_tower", "city_gate_tower", "winding_tower", "drilling_tower", "castle_tower", "other", "biogas_plant", "wind_turbine", "solar_panels", "mast", "power_line_mast", "radio_mast", "radio_telescope", "chimney", "crane", "slewing_crane", "gantry_crane", "traveling_crane", "blast_furnace", "silo", "tank", "gasometer", "grandstand", "covered_grandstand", "uncovered_grandstand", "stadium", "covered_stadium", "uncovered_stadium", "ski_jump_inrun", "graduation_tower", "historic_water_pipeline", "watchtower", "fortification_castle_ruin", "historic_wall", "city_wall", "other_historic_wall", "canopy", "carport", "wall", "monument", "ship_lift", "chamber_lock", "bridge", "swing_bridge", "lifting_bridge", "drawbridge", "elevated_railway_elevated_road", "lock_chamber", "dam", "weir", "security_gate", "sewer_drain", "barrage"];
803
- readonly description: "\nThe `building_function_class` field specifies the standardized English classification of the building function according to the German GFK (Gebäudefunktionsklasse) standard.\n\nThis field categorizes buildings by their primary use or purpose, such as residential, commercial, industrial, public, or mixed-use functions.\n\nThe field is set to `null` if the building function class is unknown.";
804
- readonly example: "residential_building";
805
- };
806
- readonly grouping_strategy: {
807
- readonly type: "string";
808
- readonly enum: readonly ["proximity", "property"];
809
- readonly default: "proximity";
810
- readonly description: "The grouping strategy used to aggregate buildings in this result. Currently supports: proximity (cadastral based clustering) and property (cadastral, address, construction year, and roof type based grouping). Defaults to `proximity` when no strategy is specified in the request.";
811
- readonly example: "proximity";
812
- };
813
- readonly ogc_fid: {
814
- readonly type: readonly ["string", "null"];
815
- readonly description: "\nThe `ogc_fid` field specifies a unique identifier from the LOD2 dataset. **This field is deprecated** and should no longer be used for identifying buildings. \n\nFor current and future use, refer to `building_id` (for the building geometry) or `building_address_id` (for a unique building-address combination) instead. \n\nThe field is set to `null` if the identifier is unavailable.";
816
- readonly example: "DENW29AL1000FzW2";
817
- readonly deprecated: true;
818
- };
819
- readonly federal_state: {
820
- readonly type: readonly ["string", "null"];
821
- readonly description: "\nThe `federal_state` field specifies the German federal state (Bundesland) in which the building is located.\n\nGermany is divided into 16 federal states:\n\n- Baden-Württemberg\n- Bayern (Bavaria)\n- Berlin\n- Brandenburg\n- Bremen\n- Hamburg\n- Hessen\n- Mecklenburg-Vorpommern\n- Niedersachsen (Lower Saxony)\n- Nordrhein-Westfalen (North Rhine-Westphalia)\n- Rheinland-Pfalz (Rhineland-Palatinate)\n- Saarland\n- Sachsen (Saxony)\n- Sachsen-Anhalt (Saxony-Anhalt)\n- Schleswig-Holstein\n- Thüringen (Thuringia)\n\nThe field is set to `null` if the federal state is unknown.";
822
- readonly example: "Nordrhein-Westfalen";
823
- };
824
- readonly country_code: {
825
- readonly type: readonly ["string", "null"];
826
- readonly description: "\nThe `country_code` field specifies the ISO 3166-1 alpha-2 country code of the country in which the building is located.\n\nThe field is set to `null` if the country code is unknown.";
827
- readonly example: "DE";
828
- };
829
- readonly esg: {
830
- readonly type: "object";
831
- readonly properties: {
832
- readonly overall_class: {
833
- readonly type: readonly ["number", "null"];
834
- readonly minimum: 1;
835
- readonly maximum: 5;
836
- readonly description: "\nThe `overall_class` field specifies the overall ESG rating class of the building. This field can have one of the following values:\n\n- **1**: Negative\n- **2**: Rather negative\n- **3**: Average\n- **4**: Rather positive\n- **5**: Positive\n\nThe field is set to `null` if the overall ESG rating class is unknown.";
837
- readonly example: 1;
414
+ readonly minimum: 1;
415
+ readonly maximum: 5;
416
+ readonly description: "\nThe `overall_class` field specifies the overall ESG rating class of the building. This field can have one of the following values:\n\n- **1**: Negative\n- **2**: Rather negative\n- **3**: Average\n- **4**: Rather positive\n- **5**: Positive\n\nThe field is set to `null` if the overall ESG rating class is unknown.";
417
+ readonly example: 1;
838
418
  };
839
419
  readonly overall: {
840
420
  readonly type: readonly ["string", "null"];
@@ -1359,7 +939,7 @@ declare const $BuildingGeometryResponseV4: {
1359
939
  readonly required: readonly ["type", "features"];
1360
940
  };
1361
941
 
1362
- type LookupPropertiesV2 = {
942
+ type LookupPropertiesV3 = {
1363
943
  /**
1364
944
  *
1365
945
  * The `street` field specifies the street name of a building.
@@ -1450,51 +1030,6 @@ type LookupPropertiesV2 = {
1450
1030
  * @deprecated
1451
1031
  */
1452
1032
  heat_demand: number | null;
1453
- /**
1454
- *
1455
- * The `height_category` field specifies the height category of the building. The height category is a
1456
- * number between 1 and 6, where 1 is the lowest and 6 is the highest category.
1457
- *
1458
- * ### Classifications
1459
- *
1460
- * - **1**: <= 5m
1461
- * - **2**: <= 7.5m
1462
- * - **3**: <= 10m
1463
- * - **4**: <= 12.5m
1464
- * - **5**: <= 15m
1465
- * - **6**: > 15m
1466
- *
1467
- * If the height category is unknown, the field is set to `null`.
1468
- *
1469
- * <br /><br />**Warning:**<br /><br />
1470
- *
1471
- * 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.
1472
- *
1473
- * @deprecated
1474
- */
1475
- height_category: '<= 5m' | '<= 7.5m' | '<= 10m' | '<= 12.5m' | '<= 15m' | '> 15m' | null;
1476
- /**
1477
- *
1478
- * The `height_category_class` field specifies the height category of the building. The height category is a
1479
- * number between 1 and 6, where 1 is the lowest and 6 is the highest category.
1480
- *
1481
- * ### Classifications
1482
- *
1483
- * - **1**: <= 5m
1484
- * - **2**: <= 7.5m
1485
- * - **3**: <= 10m
1486
- * - **4**: <= 12.5m
1487
- * - **5**: <= 15m
1488
- * - **6**: > 15m
1489
- *
1490
- * The field is set to `null` if the number of height category is unknown.
1491
- *
1492
- * <br /><br />**Warning:**<br /><br />
1493
- *
1494
- * This field is deprecated and will be no longer supported in future datasets.
1495
- * @deprecated
1496
- */
1497
- height_category_class: number | null;
1498
1033
  /**
1499
1034
  *
1500
1035
  * The `levels` field specifies the number of levels in the building.
@@ -1517,7 +1052,7 @@ type LookupPropertiesV2 = {
1517
1052
  *
1518
1053
  * The `net_area` was modeled according to the Raumwärmebedarfsmodell NRW as:
1519
1054
  * `footprint_area` * `levels` * factors between 0.7 (inhabited) and 0.8 (non-inhabited)
1520
- * the latter was done to concider e.g., inner wall area or staircases.
1055
+ * the latter was done to consider e.g., inner wall area or staircases.
1521
1056
  */
1522
1057
  net_area: number | null;
1523
1058
  /**
@@ -1527,38 +1062,6 @@ type LookupPropertiesV2 = {
1527
1062
  * The field is set to `null` if the footprint area is unknown.
1528
1063
  */
1529
1064
  footprint_area: number | null;
1530
- /**
1531
- *
1532
- * The `usage` field specifies the usage of the building. This field can have one of the following values:
1533
- *
1534
- * - **residential**: Residential building
1535
- * - **non_residential**: Non-residential building
1536
- * - **mixed_use**: Mixed-use building
1537
- *
1538
- * If the usage is unknown, the field is set to `null`.
1539
- *
1540
- * <br /><br />**Warning:**<br /><br />
1541
- *
1542
- * 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.
1543
- * @deprecated
1544
- */
1545
- usage: 'residential' | 'non_residential' | 'mixed_use' | null;
1546
- /**
1547
- *
1548
- * The `usage_class` field specifies the usage of the building. This field can have one of the following values:
1549
- *
1550
- * - **1**: Residential building
1551
- * - **2**: Non-residential building
1552
- * - **3**: Mixed-use building
1553
- *
1554
- * If the usage is unknown, the field is set to `null`.
1555
- *
1556
- * <br /><br />**Warning:**<br /><br />
1557
- *
1558
- * 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.
1559
- * @deprecated
1560
- */
1561
- usage_class: number | null;
1562
1065
  /**
1563
1066
  *
1564
1067
  * The `characteristics` field defines the different types of building characteristics. This classification includes
@@ -1773,681 +1276,11 @@ type LookupPropertiesV2 = {
1773
1276
  * The `flood_potential` field is an array representing different flood risk scenarios for a given
1774
1277
  * location. The objects in the array can contain the following fields:
1775
1278
  *
1776
- * - `min_reccurence`: The minimum expected recurrence interval for flooding, measured in years.
1279
+ * - `min_recurrence`: The minimum expected recurrence interval for flooding, measured in years.
1777
1280
  * This field is optional and can be `null` if the data is unavailable. A lower value indicates more
1778
1281
  * frequent flooding.
1779
1282
  *
1780
- * - `max_reccurence`: The maximum expected recurrence interval for flooding, also in years. This
1781
- * field is optional and can be `null`. If provided, this value represents the upper bound of the
1782
- * flood risk interval. This field allows the specification of a range of recurrence intervals.
1783
- *
1784
- * - `protection_against_floods`: A boolean flag indicating whether flood protection measures are in
1785
- * place for the area. This field is optional and can be `null` if the information is not available.
1786
- * A value of `true` means flood defenses are present, while `false` indicates the absence of such
1787
- * measures.
1788
- *
1789
- * If this array is set to `null`, it means that no data regarding flood potential is available for the location.
1790
- */
1791
- flood_potential: Array<{
1792
- min_recurrence?: number | null;
1793
- max_recurrence?: number | null;
1794
- protection_against_floods?: boolean | null;
1795
- }> | null;
1796
- photovoltaic_potential: {
1797
- /**
1798
- *
1799
- * The `suitable_roof_area` field specifies the roof area suited for photovoltaics [m^2].
1800
- *
1801
- * The field is set to `null` if the roof area suited for photovoltaics is unknown.
1802
- */
1803
- suitable_roof_area: number | null;
1804
- /**
1805
- *
1806
- * The `gross_collector_area` field specifies the maximal collector area for photovoltaics including module frames [m^2].
1807
- *
1808
- * The field is set to `null` if the maximal collector area for photovoltaics is unknown.
1809
- */
1810
- gross_collector_area: number | null;
1811
- /**
1812
- *
1813
- * The `net_collector_area` field specifies the maximal collector area for photovoltaics excluding module frames [m^2].
1814
- *
1815
- * The field is set to `null` if the maximal collector area for photovoltaics excluding module frames is unknown.
1816
- */
1817
- net_collector_area: number | null;
1818
- /**
1819
- *
1820
- * The `electricity_generation` field specifies the maximal electricity generation from photovoltaics of the building per year [kWh/a].
1821
- *
1822
- * The field is set to `null` if the maximal electricity generation per year is unknown.
1823
- */
1824
- electricity_generation: number | null;
1825
- /**
1826
- *
1827
- * The `nominal_power` field specifies the nominal power a photovoltaics system could have at this building per year [kWp].
1828
- *
1829
- * The field is set to `null` if the the nominal power is unknown.
1830
- */
1831
- nominal_power: number | null;
1832
- };
1833
- solarthermal_potential: {
1834
- /**
1835
- *
1836
- * The `st_suitable_roof_area` field specifies the roof area suited for solarthermie [m^2].
1837
- *
1838
- * The field is set to `null` if the roof area suited for solarthermie is unknown.
1839
- */
1840
- suitable_roof_area: number | null;
1841
- /**
1842
- *
1843
- * The `st_heat_generation` field specifies the potential solarthermic heat generation on this bulding [kWh/a].
1844
- *
1845
- * The field is set to `null` if the heat generation by solarthermie is unknown.
1846
- */
1847
- heat_generation: number | null;
1848
- /**
1849
- *
1850
- * The `st_net_collector_area` field specifies the maximal collector area for solarthermie [m^2].
1851
- *
1852
- * The field is set to `null` if the maximal collector area for solarthermie is unknown.
1853
- */
1854
- net_collector_area: number | null;
1855
- };
1856
- /**
1857
- *
1858
- * The `matching_addresses` field indicates the number of addresses associated with the geometry.
1859
- *
1860
- * The field is set to `null` if no matching addresses are found.
1861
- */
1862
- matching_addresses: number | null;
1863
- /**
1864
- *
1865
- * The `eave_above_ground_weighted` field specifies the weighted average height of the eave above ground [meters]. For weighting
1866
- * the `footprint_area` of sub-geometries was used, if a building consists of multiple. This can be traced on the basis of the
1867
- * field `number_original_geometries`.
1868
- *
1869
- *
1870
- * The field is set to `null` if the height is unknown.
1871
- */
1872
- eave_above_ground_weighted: number | null;
1873
- /**
1874
- *
1875
- * The `eave_above_ground_min` field specifies the minimum height of the eave above ground [meters]. This is the minimal
1876
- * `eave_above_ground` within a group of sub-geometries, if a building consists of multiple. This can be traced on the basis
1877
- * of the field `number_original_geometries`.
1878
- *
1879
- * The field is set to `null` if the height is unknown.
1880
- */
1881
- eave_above_ground_min: number | null;
1882
- /**
1883
- *
1884
- * The `eave_above_ground_max` field specifies the maximum height of the eave above ground [meters]. This is the maximal
1885
- * `eave_above_ground` within a group of sub-geometries, if a building consists of multiple. This can be traced on the basis of
1886
- * the field `number_original_geometries`.
1887
- *
1888
- *
1889
- * The field is set to `null` if the height is unknown.
1890
- */
1891
- eave_above_ground_max: number | null;
1892
- /**
1893
- *
1894
- * The `ridge_above_ground_weighted` field specifies the weighted average height of the ridge above ground [meters]. For
1895
- * weighting the `footprint_area` of sub-geometries was used, if a building consists of multiple. This can be traced on the basis
1896
- * of the field `number_original_geometries`.
1897
- *
1898
- * The field is set to `null` if the height is unknown.
1899
- */
1900
- ridge_above_ground_weighted: number | null;
1901
- /**
1902
- *
1903
- * The `ridge_above_ground_min` field specifies the minimum height of the ridge above ground [meters]. This is the minimal
1904
- * `ridge_above_ground within` a group of sub-geometries, if a building consists of multiple. This can be traced on the basis of the
1905
- * field `number_original_geometries`.
1906
- *
1907
- * The field is set to `null` if the height is unknown.
1908
- */
1909
- ridge_above_ground_min: number | null;
1910
- /**
1911
- *
1912
- * The `ridge_above_ground_max` field specifies the maximum height of the ridge above ground [meters]. This is the maximal
1913
- * `ridge_above_ground` within a group of sub-geometries, if a building consists of multiple. This can be traced on the basis of the
1914
- * field `number_original_geometries`.
1915
- *
1916
- * The field is set to `null` if the height is unknown.
1917
- */
1918
- ridge_above_ground_max: number | null;
1919
- /**
1920
- *
1921
- * The `number_original_geometries` field specifies the number of original geometries used for weighted calculations.
1922
- *
1923
- * The field is set to `null` if the count is unknown.
1924
- */
1925
- number_original_geometries: number | null;
1926
- /**
1927
- *
1928
- * The `roof_area` field specifies the total roof area of the building [square meters].
1929
- *
1930
- * The field is set to `null` if the roof area is unknown.
1931
- */
1932
- roof_area: number | null;
1933
- /**
1934
- *
1935
- * The `ogc_fid` field specifies a unique identifier from the LOD2 dataset.
1936
- *
1937
- * The field is set to `null` if the identifier is unavailable.
1938
- */
1939
- ogc_fid: string | null;
1940
- /**
1941
- *
1942
- * The `outer_wall_area_free` field specifies the facade area free of adjacent structures [square meters].
1943
- *
1944
- * The field is set to `null` if the area is unknown.
1945
- */
1946
- outer_wall_area_free: number | null;
1947
- /**
1948
- *
1949
- * The `outer_wall_area_shared_heated` field specifies the facade area shared with heated adjacent structures [square meters].
1950
- *
1951
- * The field is set to `null` if the area is unknown.
1952
- */
1953
- outer_wall_area_shared_heated: number | null;
1954
- /**
1955
- *
1956
- * The `outer_wall_area_shared_non_heated` field specifies the facade area shared with non-heated adjacent structures [square meters].
1957
- *
1958
- * The field is set to `null` if the area is unknown.
1959
- */
1960
- outer_wall_area_shared_non_heated: number | null;
1961
- /**
1962
- *
1963
- * The `plinth_length_free` field specifies the length of the building's plinth that is not shared with adjacent structures [meters].
1964
- *
1965
- * The field is set to `null` if the length is unknown.
1966
- */
1967
- plinth_length_free: number | null;
1968
- /**
1969
- *
1970
- * The `plinth_length_shared_heated` field specifies the length of the building's plinth shared with heated adjacent structures [meters].
1971
- *
1972
- * The field is set to `null` if the length is unknown.
1973
- */
1974
- plinth_length_shared_heated: number | null;
1975
- /**
1976
- *
1977
- * The `plinth_length_shared_non_heated` field specifies the length of the building's plinth shared with non-heated adjacent structures [meters].
1978
- *
1979
- * The field is set to `null` if the length is unknown.
1980
- */
1981
- plinth_length_shared_non_heated: number | null;
1982
- /**
1983
- *
1984
- * The `building_function` field contains the original German building function name (GFK - Gebäudefunktionsklasse) from the source data.
1985
- *
1986
- * This is the raw German value. For the standardized English classification, use the `building_function_class` field.
1987
- *
1988
- * The field is set to `null` if the building function is unknown.
1989
- */
1990
- building_function: string | null;
1991
- /**
1992
- *
1993
- * The `building_function_class` field specifies the standardized English classification of the building function according to the German GFK (Gebäudefunktionsklasse) standard.
1994
- *
1995
- * This field categorizes buildings by their primary use or purpose, such as residential, commercial, industrial, public, or mixed-use functions.
1996
- *
1997
- * The field is set to `null` if the building function class is unknown.
1998
- */
1999
- building_function_class: 'residential_building' | 'residential_house' | 'dormitory' | 'childrens_home' | 'nursing_home' | 'nurses_dormitory' | 'student_dormitory' | 'school_country_home' | 'mixed_use_building_with_residential' | 'residential_building_with_public_amenities' | 'residential_building_with_commerce_services' | 'residential_and_administrative_building' | 'residential_and_office_building' | 'residential_and_commercial_building' | 'residential_commercial_industrial_building' | 'agricultural_forestry_residential_building' | 'agricultural_forestry_residential_commercial_building' | 'farmhouse' | 'residential_and_agricultural_building' | 'forest_house' | 'leisure_facility_building' | 'holiday_home' | 'weekend_house' | 'garden_house' | 'commercial_building' | 'commercial_and_service_building' | 'office_building' | 'credit_institution' | 'insurance_office' | 'department_store' | 'shopping_center' | 'market_hall' | 'shop' | 'kiosk' | 'pharmacy' | 'exhibition_hall' | 'accommodation_building' | 'hotel_motel_guesthouse' | 'youth_hostel' | 'hut_with_overnight_stay' | 'campground_building' | 'catering_building' | 'restaurant' | 'hut_no_overnight_stay' | 'canteen' | 'leisure_and_entertainment_venue' | 'banquet_hall' | 'cinema' | 'bowling_alley' | 'casino' | 'arcade' | 'commercial_and_industrial_building' | 'production_building' | 'factory' | 'operations_building' | 'brewery' | 'distillery' | 'workshop' | 'sawmill' | 'gas_station' | 'car_wash' | 'storage_building' | 'cold_storage' | 'warehouse' | 'freight_forwarding_building' | 'research_building' | 'raw_material_extraction_building' | 'mine' | 'saltworks' | 'company_social_facility_building' | 'other_commercial_industrial_building' | 'mill' | 'windmill' | 'watermill' | 'pumping_station' | 'weather_station' | 'commercial_service_residential_building' | 'commercial_industrial_residential_building' | 'traffic_facility_operations_building_general' | 'road_traffic_operations_building' | 'road_maintenance_depot' | 'waiting_hall' | 'rail_traffic_operations_building' | 'railroad_crossing_keeper_house' | 'locomotive_shed_carriage_hall' | 'signal_box_block_post' | 'freight_yard_operations_building' | 'air_traffic_operations_building' | 'aircraft_hangar' | 'maritime_traffic_operations_building' | 'shipyard_hall' | 'dock_hall' | 'lock_operations_building' | 'boathouse' | 'cable_car_operations_building' | 'cable_car_tensioning_station' | 'parking_building' | 'parking_garage' | 'garage' | 'vehicle_hall' | 'supply_building' | 'energy_supply_building' | 'water_supply_building' | 'waterworks' | 'water_reservoir' | 'electricity_supply_building' | 'power_plant' | 'substation' | 'transformer' | 'reactor_building' | 'turbine_house' | 'boiler_house' | 'telecommunications_building' | 'building_at_underground_lines' | 'gas_supply_building' | 'gas_works' | 'heating_plant' | 'utility_building' | 'pumping_station_non_water_supply' | 'disposal_building' | 'wastewater_treatment_building' | 'sewage_treatment_plant_building' | 'public_toilet' | 'waste_treatment_building' | 'waste_bunker' | 'waste_incineration_plant' | 'landfill_building' | 'agricultural_forestry_building' | 'agricultural_forestry_commercial_building' | 'barn' | 'shed' | 'stable' | 'barn_and_stable' | 'large_scale_animal_housing' | 'riding_hall' | 'alpine_hut' | 'hunting_lodge_cabin' | 'greenhouse' | 'moveable_greenhouse' | 'public_building' | 'administrative_building' | 'parliament_building' | 'town_hall' | 'post_office' | 'customs_office' | 'court_building' | 'embassy_consulate' | 'district_administration' | 'regional_government' | 'tax_office' | 'education_research_building' | 'general_education_school' | 'vocational_school' | 'higher_education_building_university' | 'research_institute' | 'cultural_building' | 'palace' | 'theater_opera' | 'concert_hall' | 'museum' | 'broadcasting_television' | 'event_building' | 'library' | 'castle_fortress' | 'religious_building' | 'church' | 'synagogue' | 'chapel' | 'community_hall' | 'house_of_worship' | 'mosque' | 'temple' | 'monastery' | 'healthcare_building' | 'hospital' | 'sanatorium_nursing_home_nursing_station' | 'doctors_office_polyclinic' | 'rescue_station' | 'social_services_building' | 'youth_center' | 'leisure_club_community_center' | 'senior_center' | 'homeless_shelter' | 'daycare_kindergarten' | 'refugee_shelter' | 'security_and_order_building' | 'police_station' | 'fire_station' | 'barracks' | 'air_raid_shelter' | 'correctional_facility' | 'cemetery_building' | 'funeral_hall' | 'crematorium' | 'reception_building' | 'railway_station_building' | 'airport_building' | 'subway_station_building' | 'suburban_railway_station_building' | 'bus_station_building' | 'maritime_terminal_building' | 'public_purpose_residential_building' | 'recreational_building' | 'sports_building' | 'sports_gymnasium' | 'sports_field_building' | 'bathhouse' | 'indoor_swimming_pool' | 'outdoor_pool_building' | 'stadium_building' | 'spa_facility_building' | 'medical_bath_building' | 'sanatorium' | 'zoo_building' | 'zoo_entrance_building' | 'aquarium_terrarium_aviary' | 'animal_exhibition_building' | 'zoo_stable' | 'botanical_garden_building' | 'botanical_garden_entrance_building' | 'botanical_greenhouse' | 'conservatory' | 'other_recreational_facility_building' | 'mountain_hut_shelter' | 'tourist_information_center' | 'not_specified_due_to_source_situation' | 'water_tower' | 'church_tower' | 'observation_tower' | 'control_tower' | 'cooling_tower' | 'lighthouse' | 'fire_watchtower' | 'transmission_radio_tower' | 'city_gate_tower' | 'winding_tower' | 'drilling_tower' | 'castle_tower' | 'other' | 'biogas_plant' | 'wind_turbine' | 'solar_panels' | 'mast' | 'power_line_mast' | 'radio_mast' | 'radio_telescope' | 'chimney' | 'crane' | 'slewing_crane' | 'gantry_crane' | 'traveling_crane' | 'blast_furnace' | 'silo' | 'tank' | 'gasometer' | 'grandstand' | 'covered_grandstand' | 'uncovered_grandstand' | 'stadium' | 'covered_stadium' | 'uncovered_stadium' | 'ski_jump_inrun' | 'graduation_tower' | 'historic_water_pipeline' | 'watchtower' | 'fortification_castle_ruin' | 'historic_wall' | 'city_wall' | 'other_historic_wall' | 'canopy' | 'carport' | 'wall' | 'monument' | 'ship_lift' | 'chamber_lock' | 'bridge' | 'swing_bridge' | 'lifting_bridge' | 'drawbridge' | 'elevated_railway_elevated_road' | 'lock_chamber' | 'dam' | 'weir' | 'security_gate' | 'sewer_drain' | 'barrage' | null;
2000
- };
2001
- /**
2002
- *
2003
- * The `roof_type` field specifies the type of roof of a building. This field can have one of the following values:
2004
- *
2005
- * - **flat**: Flat roof
2006
- * - **pitched**: Pitched roof
2007
- * - **mixed**: Mixed types of roofs
2008
- *
2009
- * The field is set to `null` if the building type is unknown.
2010
- */
2011
- type roof_type = 'flat' | 'pitched' | 'mixed';
2012
- /**
2013
- *
2014
- * The `type` field specifies the type of building. This field can have one of the following values:
2015
- *
2016
- * - **single_family**: Single-family house
2017
- * - **multi_family**: Multi-family house
2018
- * - **non_residential**: Non-residential building
2019
- * - **mixed_use**: Mixed-use building
2020
- *
2021
- * The field is set to `null` if the building type is unknown.
2022
- */
2023
- type type = 'single_family' | 'multi_family' | 'non_residential' | 'mixed_use';
2024
- /**
2025
- *
2026
- * The `height_category` field specifies the height category of the building. The height category is a
2027
- * number between 1 and 6, where 1 is the lowest and 6 is the highest category.
2028
- *
2029
- * ### Classifications
2030
- *
2031
- * - **1**: <= 5m
2032
- * - **2**: <= 7.5m
2033
- * - **3**: <= 10m
2034
- * - **4**: <= 12.5m
2035
- * - **5**: <= 15m
2036
- * - **6**: > 15m
2037
- *
2038
- * If the height category is unknown, the field is set to `null`.
2039
- *
2040
- * <br /><br />**Warning:**<br /><br />
2041
- *
2042
- * 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.
2043
- *
2044
- * @deprecated
2045
- */
2046
- type height_category = '<= 5m' | '<= 7.5m' | '<= 10m' | '<= 12.5m' | '<= 15m' | '> 15m';
2047
- /**
2048
- *
2049
- * The `usage` field specifies the usage of the building. This field can have one of the following values:
2050
- *
2051
- * - **residential**: Residential building
2052
- * - **non_residential**: Non-residential building
2053
- * - **mixed_use**: Mixed-use building
2054
- *
2055
- * If the usage is unknown, the field is set to `null`.
2056
- *
2057
- * <br /><br />**Warning:**<br /><br />
2058
- *
2059
- * 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.
2060
- * @deprecated
2061
- */
2062
- type usage = 'residential' | 'non_residential' | 'mixed_use';
2063
- /**
2064
- *
2065
- * The `characteristics` field defines the different types of building characteristics. This classification includes
2066
- * various types of residential and non-residential buildings. This field can have one of the following values:
2067
- *
2068
- * - **single_two_family**: Single- or two-family house
2069
- * - **row_semi_detached**: Row or semi-detached house
2070
- * - **multi_family**: Multi-family house
2071
- * - **residential_block**: Residential block
2072
- * - **high_rise**: High-rise residential building
2073
- * - **terrace**: Terrace house
2074
- * - **farmhouse**: Farmhouse
2075
- * - **office_other**: Office or other building
2076
- * - **factory_warehouse**: Factory or warehouse building
2077
- *
2078
- * If the characteristics is unknown, the field is set to `null`.
2079
- */
2080
- type characteristics = 'single_two_family' | 'row_semi_detached' | 'multi_family' | 'residential_block' | 'high_rise' | 'terrace' | 'farmhouse' | 'office_other' | 'factory_warehouse';
2081
- /**
2082
- *
2083
- * The `development_layout` field specifies the layout of the building. This field can have one of the following values:
2084
- *
2085
- * - **non_detached**: Non-detached building
2086
- * - **semi_detached**: Semi-detached building
2087
- * - **detached**: Detached building
2088
- *
2089
- * If the development layout is unknown, the field is set to `null`.
2090
- *
2091
- * The `development_layout` was modeled based on the number and length of intersections with heated (and buildings with unknown heating status)
2092
- * neighbouring buildings and the perimeter of a geometry as follows:
2093
- *
2094
- * **detached** = intersection_length / outline_length < 0.085
2095
- * **semi_detached** = intersection_length / outline_length >= 0.085 AND intersection_length / outline_length < 0.45 for buildings with exactly 1 intersection
2096
- * **semi_detached** = intersection_length / outline_length >= 0.085 AND intersection_length / outline_length < 0.15 for buildings with more than 1 intersections
2097
- * **non_detached** = for all other buildings
2098
- */
2099
- type development_layout = 'non_detached' | 'semi_detached' | 'detached';
2100
- /**
2101
- *
2102
- * The `building_function_class` field specifies the standardized English classification of the building function according to the German GFK (Gebäudefunktionsklasse) standard.
2103
- *
2104
- * This field categorizes buildings by their primary use or purpose, such as residential, commercial, industrial, public, or mixed-use functions.
2105
- *
2106
- * The field is set to `null` if the building function class is unknown.
2107
- */
2108
- type building_function_class = 'residential_building' | 'residential_house' | 'dormitory' | 'childrens_home' | 'nursing_home' | 'nurses_dormitory' | 'student_dormitory' | 'school_country_home' | 'mixed_use_building_with_residential' | 'residential_building_with_public_amenities' | 'residential_building_with_commerce_services' | 'residential_and_administrative_building' | 'residential_and_office_building' | 'residential_and_commercial_building' | 'residential_commercial_industrial_building' | 'agricultural_forestry_residential_building' | 'agricultural_forestry_residential_commercial_building' | 'farmhouse' | 'residential_and_agricultural_building' | 'forest_house' | 'leisure_facility_building' | 'holiday_home' | 'weekend_house' | 'garden_house' | 'commercial_building' | 'commercial_and_service_building' | 'office_building' | 'credit_institution' | 'insurance_office' | 'department_store' | 'shopping_center' | 'market_hall' | 'shop' | 'kiosk' | 'pharmacy' | 'exhibition_hall' | 'accommodation_building' | 'hotel_motel_guesthouse' | 'youth_hostel' | 'hut_with_overnight_stay' | 'campground_building' | 'catering_building' | 'restaurant' | 'hut_no_overnight_stay' | 'canteen' | 'leisure_and_entertainment_venue' | 'banquet_hall' | 'cinema' | 'bowling_alley' | 'casino' | 'arcade' | 'commercial_and_industrial_building' | 'production_building' | 'factory' | 'operations_building' | 'brewery' | 'distillery' | 'workshop' | 'sawmill' | 'gas_station' | 'car_wash' | 'storage_building' | 'cold_storage' | 'warehouse' | 'freight_forwarding_building' | 'research_building' | 'raw_material_extraction_building' | 'mine' | 'saltworks' | 'company_social_facility_building' | 'other_commercial_industrial_building' | 'mill' | 'windmill' | 'watermill' | 'pumping_station' | 'weather_station' | 'commercial_service_residential_building' | 'commercial_industrial_residential_building' | 'traffic_facility_operations_building_general' | 'road_traffic_operations_building' | 'road_maintenance_depot' | 'waiting_hall' | 'rail_traffic_operations_building' | 'railroad_crossing_keeper_house' | 'locomotive_shed_carriage_hall' | 'signal_box_block_post' | 'freight_yard_operations_building' | 'air_traffic_operations_building' | 'aircraft_hangar' | 'maritime_traffic_operations_building' | 'shipyard_hall' | 'dock_hall' | 'lock_operations_building' | 'boathouse' | 'cable_car_operations_building' | 'cable_car_tensioning_station' | 'parking_building' | 'parking_garage' | 'garage' | 'vehicle_hall' | 'supply_building' | 'energy_supply_building' | 'water_supply_building' | 'waterworks' | 'water_reservoir' | 'electricity_supply_building' | 'power_plant' | 'substation' | 'transformer' | 'reactor_building' | 'turbine_house' | 'boiler_house' | 'telecommunications_building' | 'building_at_underground_lines' | 'gas_supply_building' | 'gas_works' | 'heating_plant' | 'utility_building' | 'pumping_station_non_water_supply' | 'disposal_building' | 'wastewater_treatment_building' | 'sewage_treatment_plant_building' | 'public_toilet' | 'waste_treatment_building' | 'waste_bunker' | 'waste_incineration_plant' | 'landfill_building' | 'agricultural_forestry_building' | 'agricultural_forestry_commercial_building' | 'barn' | 'shed' | 'stable' | 'barn_and_stable' | 'large_scale_animal_housing' | 'riding_hall' | 'alpine_hut' | 'hunting_lodge_cabin' | 'greenhouse' | 'moveable_greenhouse' | 'public_building' | 'administrative_building' | 'parliament_building' | 'town_hall' | 'post_office' | 'customs_office' | 'court_building' | 'embassy_consulate' | 'district_administration' | 'regional_government' | 'tax_office' | 'education_research_building' | 'general_education_school' | 'vocational_school' | 'higher_education_building_university' | 'research_institute' | 'cultural_building' | 'palace' | 'theater_opera' | 'concert_hall' | 'museum' | 'broadcasting_television' | 'event_building' | 'library' | 'castle_fortress' | 'religious_building' | 'church' | 'synagogue' | 'chapel' | 'community_hall' | 'house_of_worship' | 'mosque' | 'temple' | 'monastery' | 'healthcare_building' | 'hospital' | 'sanatorium_nursing_home_nursing_station' | 'doctors_office_polyclinic' | 'rescue_station' | 'social_services_building' | 'youth_center' | 'leisure_club_community_center' | 'senior_center' | 'homeless_shelter' | 'daycare_kindergarten' | 'refugee_shelter' | 'security_and_order_building' | 'police_station' | 'fire_station' | 'barracks' | 'air_raid_shelter' | 'correctional_facility' | 'cemetery_building' | 'funeral_hall' | 'crematorium' | 'reception_building' | 'railway_station_building' | 'airport_building' | 'subway_station_building' | 'suburban_railway_station_building' | 'bus_station_building' | 'maritime_terminal_building' | 'public_purpose_residential_building' | 'recreational_building' | 'sports_building' | 'sports_gymnasium' | 'sports_field_building' | 'bathhouse' | 'indoor_swimming_pool' | 'outdoor_pool_building' | 'stadium_building' | 'spa_facility_building' | 'medical_bath_building' | 'sanatorium' | 'zoo_building' | 'zoo_entrance_building' | 'aquarium_terrarium_aviary' | 'animal_exhibition_building' | 'zoo_stable' | 'botanical_garden_building' | 'botanical_garden_entrance_building' | 'botanical_greenhouse' | 'conservatory' | 'other_recreational_facility_building' | 'mountain_hut_shelter' | 'tourist_information_center' | 'not_specified_due_to_source_situation' | 'water_tower' | 'church_tower' | 'observation_tower' | 'control_tower' | 'cooling_tower' | 'lighthouse' | 'fire_watchtower' | 'transmission_radio_tower' | 'city_gate_tower' | 'winding_tower' | 'drilling_tower' | 'castle_tower' | 'other' | 'biogas_plant' | 'wind_turbine' | 'solar_panels' | 'mast' | 'power_line_mast' | 'radio_mast' | 'radio_telescope' | 'chimney' | 'crane' | 'slewing_crane' | 'gantry_crane' | 'traveling_crane' | 'blast_furnace' | 'silo' | 'tank' | 'gasometer' | 'grandstand' | 'covered_grandstand' | 'uncovered_grandstand' | 'stadium' | 'covered_stadium' | 'uncovered_stadium' | 'ski_jump_inrun' | 'graduation_tower' | 'historic_water_pipeline' | 'watchtower' | 'fortification_castle_ruin' | 'historic_wall' | 'city_wall' | 'other_historic_wall' | 'canopy' | 'carport' | 'wall' | 'monument' | 'ship_lift' | 'chamber_lock' | 'bridge' | 'swing_bridge' | 'lifting_bridge' | 'drawbridge' | 'elevated_railway_elevated_road' | 'lock_chamber' | 'dam' | 'weir' | 'security_gate' | 'sewer_drain' | 'barrage';
2109
- type LookupPropertiesV3 = {
2110
- /**
2111
- *
2112
- * The `street` field specifies the street name of a building.
2113
- *
2114
- * The field is set to `null` if the street is unknown.
2115
- */
2116
- street: string | null;
2117
- /**
2118
- *
2119
- * The `city` field specifies the city name of a building.
2120
- *
2121
- * The field is set to `null` if the city is unknown.
2122
- */
2123
- city: string | null;
2124
- /**
2125
- *
2126
- * The `street_number` field specifies the street number name of a building.
2127
- *
2128
- * The field is set to `null` if the street number is unknown.
2129
- */
2130
- street_number: string | null;
2131
- /**
2132
- *
2133
- * The `postcode` field specifies the postcode of a building.
2134
- *
2135
- * The field is set to `null` if the postcode is unknown.
2136
- */
2137
- postcode: string | null;
2138
- /**
2139
- *
2140
- * The `roof_type` field specifies the type of roof of a building. This field can have one of the following values:
2141
- *
2142
- * - **flat**: Flat roof
2143
- * - **pitched**: Pitched roof
2144
- * - **mixed**: Mixed types of roofs
2145
- *
2146
- * The field is set to `null` if the building type is unknown.
2147
- */
2148
- roof_type: 'flat' | 'pitched' | 'mixed' | null;
2149
- /**
2150
- *
2151
- * The `type` field specifies the type of building. This field can have one of the following values:
2152
- *
2153
- * - **single_family**: Single-family house
2154
- * - **multi_family**: Multi-family house
2155
- * - **non_residential**: Non-residential building
2156
- * - **mixed_use**: Mixed-use building
2157
- *
2158
- * The field is set to `null` if the building type is unknown.
2159
- */
2160
- type: 'single_family' | 'multi_family' | 'non_residential' | 'mixed_use' | null;
2161
- /**
2162
- *
2163
- * The `type_class` field specifies the class of the building type. This field can have one of the following values:
2164
- *
2165
- * - **1**: Single-family house
2166
- * - **2**: Multi-family house
2167
- * - **3**: Non-residential building
2168
- * - **4**: Mixed-use building
2169
- *
2170
- * The field is set to `null` if the building type is unknown.
2171
- */
2172
- type_class: number | null;
2173
- /**
2174
- *
2175
- * The `water_protected` field specifies whether the building is within a water protection area.
2176
- *
2177
- * If the field is set to `null`, no water protection area could be assigned.
2178
- */
2179
- water_protected: boolean | null;
2180
- /**
2181
- *
2182
- * The `heated` field specifies whether the building is heated or not.
2183
- *
2184
- * The field is set to `null` if the heating status is unknown.
2185
- */
2186
- heated: boolean | null;
2187
- /**
2188
- *
2189
- * The `heat_demand` field specifies the heat demand of the building in [kWh/m²a].
2190
- *
2191
- * This attribute is deprecated and thus always set to `null`.
2192
- *
2193
- * <br /><br />**Warning:**<br /><br />
2194
- *
2195
- * 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.
2196
- *
2197
- * @deprecated
2198
- */
2199
- heat_demand: number | null;
2200
- /**
2201
- *
2202
- * The `levels` field specifies the number of levels in the building.
2203
- *
2204
- * The field is set to `null` if the number of levels is unknown.
2205
- */
2206
- levels: number | null;
2207
- /**
2208
- *
2209
- * The `household_count` field specifies the number of households in the building.
2210
- *
2211
- * The field is set to `null` if the number of households is unknown.
2212
- */
2213
- household_count: number | null;
2214
- /**
2215
- *
2216
- * The `net_area` field specifies the net area of the building in m².
2217
- *
2218
- * The field is set to `null` if the net area is unknown.
2219
- *
2220
- * The `net_area` was modeled according to the Raumwärmebedarfsmodell NRW as:
2221
- * `footprint_area` * `levels` * factors between 0.7 (inhabited) and 0.8 (non-inhabited)
2222
- * the latter was done to concider e.g., inner wall area or staircases.
2223
- */
2224
- net_area: number | null;
2225
- /**
2226
- *
2227
- * The `footprint_area` field specifies the footprint area of the building in m².
2228
- *
2229
- * The field is set to `null` if the footprint area is unknown.
2230
- */
2231
- footprint_area: number | null;
2232
- /**
2233
- *
2234
- * The `characteristics` field defines the different types of building characteristics. This classification includes
2235
- * various types of residential and non-residential buildings. This field can have one of the following values:
2236
- *
2237
- * - **single_two_family**: Single- or two-family house
2238
- * - **row_semi_detached**: Row or semi-detached house
2239
- * - **multi_family**: Multi-family house
2240
- * - **residential_block**: Residential block
2241
- * - **high_rise**: High-rise residential building
2242
- * - **terrace**: Terrace house
2243
- * - **farmhouse**: Farmhouse
2244
- * - **office_other**: Office or other building
2245
- * - **factory_warehouse**: Factory or warehouse building
2246
- *
2247
- * If the characteristics is unknown, the field is set to `null`.
2248
- */
2249
- characteristics: 'single_two_family' | 'row_semi_detached' | 'multi_family' | 'residential_block' | 'high_rise' | 'terrace' | 'farmhouse' | 'office_other' | 'factory_warehouse' | null;
2250
- /**
2251
- *
2252
- * The `characteristics_class` field defines the different types of building characteristics. This classification includes
2253
- * various types of residential and non-residential buildings. This field can have one of the following values:
2254
- *
2255
- * - **1**: Single- or two-family house
2256
- * - **2**: Row or semi-detached house
2257
- * - **3**: Multi-family house
2258
- * - **4**: Residential block
2259
- * - **5**: High-rise residential building
2260
- * - **6**: Terrace house
2261
- * - **7**: Farmhouse
2262
- * - **8**: Office or other building
2263
- * - **9**: Factory or warehouse building
2264
- *
2265
- * If the characteristics_class is unknown, the field is set to `null`.
2266
- */
2267
- characteristics_class: number | null;
2268
- /**
2269
- *
2270
- * The `development_layout` field specifies the layout of the building. This field can have one of the following values:
2271
- *
2272
- * - **non_detached**: Non-detached building
2273
- * - **semi_detached**: Semi-detached building
2274
- * - **detached**: Detached building
2275
- *
2276
- * If the development layout is unknown, the field is set to `null`.
2277
- *
2278
- * The `development_layout` was modeled based on the number and length of intersections with heated (and buildings with unknown heating status)
2279
- * neighbouring buildings and the perimeter of a geometry as follows:
2280
- *
2281
- * **detached** = intersection_length / outline_length < 0.085
2282
- * **semi_detached** = intersection_length / outline_length >= 0.085 AND intersection_length / outline_length < 0.45 for buildings with exactly 1 intersection
2283
- * **semi_detached** = intersection_length / outline_length >= 0.085 AND intersection_length / outline_length < 0.15 for buildings with more than 1 intersections
2284
- * **non_detached** = for all other buildings
2285
- */
2286
- development_layout: 'non_detached' | 'semi_detached' | 'detached' | null;
2287
- /**
2288
- *
2289
- * The `development_layout_class` field specifies the layout of the building. This field can have one of the following values:
2290
- *
2291
- * - **1**: Non-detached building
2292
- * - **2**: Semi-detached building
2293
- * - **3**: Detached building
2294
- *
2295
- * If the development layout is unknown, the field is set to `null`.
2296
- *
2297
- * The `development_layout_class` was modeled based on the number and length of intersections with heated (and buildings with unknown heating status)
2298
- * neighbouring buildings and the perimeter of a geometry as follows:
2299
- *
2300
- * **1** = intersection_length / outline_length < 0.085
2301
- * **2** = intersection_length / outline_length >= 0.085 AND intersection_length / outline_length < 0.45 for buildings with exactly 1 intersection
2302
- * **2** = intersection_length / outline_length >= 0.085 AND intersection_length / outline_length < 0.15 for buildings with more than 1 intersections
2303
- * **3** = for all other buildings
2304
- */
2305
- development_layout_class: number | null;
2306
- /**
2307
- *
2308
- * The `construction_year_range` field specifies the approximate construction year of the building. The field is a tuple with two
2309
- * values: the lower and upper bound of the construction year and can have one of the following value:
2310
- *
2311
- * - **[*null*, 1899]**: Construction year is somewhere up to 1899
2312
- * - **[1900, 1945]**
2313
- * - **[1946, 1960]**
2314
- * - **[1961, 1970]**
2315
- * - **[1971, 1980]**
2316
- * - **[1981, 1985]**
2317
- * - **[1986, 1995]**
2318
- * - **[1996, 2000]**
2319
- * - **[2001, 2005]**
2320
- * - **[2006, 2010]**
2321
- * - **[2011, 2015]**
2322
- * - **[2016, 2024]**
2323
- *
2324
- * If the construction year class is unknown, the field is set to `null`.
2325
- */
2326
- construction_year_range: unknown[] | null;
2327
- /**
2328
- *
2329
- * The `construction_year_range_class` field specifies the approximate construction year of the building and can have one of the following values:
2330
- *
2331
- * - **1**: < 1899
2332
- * - **2**: 1900 - 1945
2333
- * - **3**: 1946 - 1960
2334
- * - **4**: 1961 - 1970
2335
- * - **5**: 1971 - 1980
2336
- * - **6**: 1981 - 1985
2337
- * - **7**: 1986 - 1995
2338
- * - **8**: 1996 - 2000
2339
- * - **9**: 2001 - 2005
2340
- * - **10**: 2006 - 2010
2341
- * - **11**: 2011 - 2015
2342
- * - **12**: 2016 - 2024
2343
- *
2344
- * If the construction year range class is unknown, the field is set to `null`.
2345
- */
2346
- construction_year_range_class: number | null;
2347
- /**
2348
- *
2349
- * The `construction_year` field specifies the construction year of the building.
2350
- *
2351
- * If the construction year is unknown, the field is set to `null`.
2352
- */
2353
- construction_year: number | null;
2354
- /**
2355
- *
2356
- * The `heritage` field specifies whether the building is under monumental protection.
2357
- *
2358
- * The field is set to `null` if the heritage status is unknown.
2359
- */
2360
- heritage: boolean | null;
2361
- /**
2362
- *
2363
- * The `geo_conductivity_100` field specifies the geothermal conductivity in 100 m depth.
2364
- *
2365
- * The field is set to `null` if the geothermal conductivity is unknown.
2366
- */
2367
- geo_conductivity_100: number | null;
2368
- /**
2369
- *
2370
- * The `heat_pump_air_possible` field indicates whether an air-source heat pump is a viable option for the building.
2371
- *
2372
- * - Set to `true` if an air-source heat pump is feasible.
2373
- * - Set to `false` if an air-source heat pump is not feasible.
2374
- * - Set to `null` if the information is unknown.
2375
- */
2376
- heat_pump_air_possible: boolean | null;
2377
- /**
2378
- *
2379
- * The `heat_pump_maximal_distance_drillings` field specifies the maximum allowable distance between drillings for a heat pump installation, measured in meters.
2380
- * This field will be deprecated in future versions. Please use `heat_pump_maximal_distance_drillings_5m` instead.
2381
- *
2382
- * The field is set to `null` if the information is unknown.
2383
- */
2384
- heat_pump_maximal_distance_drillings: number | null;
2385
- /**
2386
- *
2387
- * The `heat_pump_maximal_distance_drillings_5m` field specifies the maximum allowable distance between drillings for a heat pump installation, measured in meters.
2388
- *
2389
- * The field is set to `null` if the information is unknown.
2390
- */
2391
- heat_pump_maximal_distance_drillings_5m: number | null;
2392
- /**
2393
- *
2394
- * The `heat_pump_minimal_number_possible_drillings` field specifies the minimum
2395
- * number of drillings required for a heat pump installation with a distance of 5m
2396
- * to the parcel border.
2397
- * This field will be deprecated in future versions. Please use `heat_pump_minimal_number_possible_drillings_5m` instead.
2398
- *
2399
- * The field is set to `null` if the information is unknown.
2400
- *
2401
- * <br /><br />**Deprecation Warning:**<br /><br />
2402
- *
2403
- * Please use `heat_pump_minimal_number_possible_drillings_5m` instead of this field.
2404
- * @deprecated
2405
- */
2406
- heat_pump_minimal_number_possible_drillings: number | null;
2407
- /**
2408
- *
2409
- * The `heat_pump_minimal_number_possible_drillings_5m` field specifies the minimum
2410
- * number of drillings required for a heat pump installation with a distance of 5m
2411
- * to the parcel border.
2412
- *
2413
- * The field is set to `null` if the information is unknown.
2414
- */
2415
- heat_pump_minimal_number_possible_drillings_5m: number | null;
2416
- /**
2417
- *
2418
- * The `heat_pump_minimal_number_possible_drillings_2m` field specifies the minimum
2419
- * number of drillings required for a heat pump installation with a distance of 2m
2420
- * to the parcel border.
2421
- *
2422
- * The field is set to `null` if the information is unknown.
2423
- */
2424
- heat_pump_minimal_number_possible_drillings_2m: number | null;
2425
- /**
2426
- *
2427
- * The `heat_pump_minimal_number_possible_drillings_no_distance` field specifies the minimum
2428
- * number of drillings required for a heat pump installation with no distance to the parcel border.
2429
- *
2430
- * The field is set to `null` if the information is unknown.
2431
- */
2432
- heat_pump_minimal_number_possible_drillings_no_distance: number | null;
2433
- /**
2434
- *
2435
- * The `heat_pump_collector_free_area` field specifies the sum of the free area suitable
2436
- * for a collector heat pump on parcels associated to a building.
2437
- *
2438
- * The field is set to `null` if the information is unknown.
2439
- */
2440
- heat_pump_collector_free_area: number | null;
2441
- /**
2442
- *
2443
- * The `flood_potential` field is an array representing different flood risk scenarios for a given
2444
- * location. The objects in the array can contain the following fields:
2445
- *
2446
- * - `min_reccurence`: The minimum expected recurrence interval for flooding, measured in years.
2447
- * This field is optional and can be `null` if the data is unavailable. A lower value indicates more
2448
- * frequent flooding.
2449
- *
2450
- * - `max_reccurence`: The maximum expected recurrence interval for flooding, also in years. This
1283
+ * - `max_recurrence`: The maximum expected recurrence interval for flooding, also in years. This
2451
1284
  * field is optional and can be `null`. If provided, this value represents the upper bound of the
2452
1285
  * flood risk interval. This field allows the specification of a range of recurrence intervals.
2453
1286
  *
@@ -3212,6 +2045,75 @@ type LookupPropertiesV3 = {
3212
2045
  */
3213
2046
  biosphere_reserve: boolean | null;
3214
2047
  };
2048
+ /**
2049
+ *
2050
+ * The `roof_type` field specifies the type of roof of a building. This field can have one of the following values:
2051
+ *
2052
+ * - **flat**: Flat roof
2053
+ * - **pitched**: Pitched roof
2054
+ * - **mixed**: Mixed types of roofs
2055
+ *
2056
+ * The field is set to `null` if the building type is unknown.
2057
+ */
2058
+ type roof_type = 'flat' | 'pitched' | 'mixed';
2059
+ /**
2060
+ *
2061
+ * The `type` field specifies the type of building. This field can have one of the following values:
2062
+ *
2063
+ * - **single_family**: Single-family house
2064
+ * - **multi_family**: Multi-family house
2065
+ * - **non_residential**: Non-residential building
2066
+ * - **mixed_use**: Mixed-use building
2067
+ *
2068
+ * The field is set to `null` if the building type is unknown.
2069
+ */
2070
+ type type = 'single_family' | 'multi_family' | 'non_residential' | 'mixed_use';
2071
+ /**
2072
+ *
2073
+ * The `characteristics` field defines the different types of building characteristics. This classification includes
2074
+ * various types of residential and non-residential buildings. This field can have one of the following values:
2075
+ *
2076
+ * - **single_two_family**: Single- or two-family house
2077
+ * - **row_semi_detached**: Row or semi-detached house
2078
+ * - **multi_family**: Multi-family house
2079
+ * - **residential_block**: Residential block
2080
+ * - **high_rise**: High-rise residential building
2081
+ * - **terrace**: Terrace house
2082
+ * - **farmhouse**: Farmhouse
2083
+ * - **office_other**: Office or other building
2084
+ * - **factory_warehouse**: Factory or warehouse building
2085
+ *
2086
+ * If the characteristics is unknown, the field is set to `null`.
2087
+ */
2088
+ type characteristics = 'single_two_family' | 'row_semi_detached' | 'multi_family' | 'residential_block' | 'high_rise' | 'terrace' | 'farmhouse' | 'office_other' | 'factory_warehouse';
2089
+ /**
2090
+ *
2091
+ * The `development_layout` field specifies the layout of the building. This field can have one of the following values:
2092
+ *
2093
+ * - **non_detached**: Non-detached building
2094
+ * - **semi_detached**: Semi-detached building
2095
+ * - **detached**: Detached building
2096
+ *
2097
+ * If the development layout is unknown, the field is set to `null`.
2098
+ *
2099
+ * The `development_layout` was modeled based on the number and length of intersections with heated (and buildings with unknown heating status)
2100
+ * neighbouring buildings and the perimeter of a geometry as follows:
2101
+ *
2102
+ * **detached** = intersection_length / outline_length < 0.085
2103
+ * **semi_detached** = intersection_length / outline_length >= 0.085 AND intersection_length / outline_length < 0.45 for buildings with exactly 1 intersection
2104
+ * **semi_detached** = intersection_length / outline_length >= 0.085 AND intersection_length / outline_length < 0.15 for buildings with more than 1 intersections
2105
+ * **non_detached** = for all other buildings
2106
+ */
2107
+ type development_layout = 'non_detached' | 'semi_detached' | 'detached';
2108
+ /**
2109
+ *
2110
+ * The `building_function_class` field specifies the standardized English classification of the building function according to the German GFK (Gebäudefunktionsklasse) standard.
2111
+ *
2112
+ * This field categorizes buildings by their primary use or purpose, such as residential, commercial, industrial, public, or mixed-use functions.
2113
+ *
2114
+ * The field is set to `null` if the building function class is unknown.
2115
+ */
2116
+ type building_function_class = 'residential_building' | 'residential_house' | 'dormitory' | 'childrens_home' | 'nursing_home' | 'nurses_dormitory' | 'student_dormitory' | 'school_country_home' | 'mixed_use_building_with_residential' | 'residential_building_with_public_amenities' | 'residential_building_with_commerce_services' | 'residential_and_administrative_building' | 'residential_and_office_building' | 'residential_and_commercial_building' | 'residential_commercial_industrial_building' | 'agricultural_forestry_residential_building' | 'agricultural_forestry_residential_commercial_building' | 'farmhouse' | 'residential_and_agricultural_building' | 'forest_house' | 'leisure_facility_building' | 'holiday_home' | 'weekend_house' | 'garden_house' | 'commercial_building' | 'commercial_and_service_building' | 'office_building' | 'credit_institution' | 'insurance_office' | 'department_store' | 'shopping_center' | 'market_hall' | 'shop' | 'kiosk' | 'pharmacy' | 'exhibition_hall' | 'accommodation_building' | 'hotel_motel_guesthouse' | 'youth_hostel' | 'hut_with_overnight_stay' | 'campground_building' | 'catering_building' | 'restaurant' | 'hut_no_overnight_stay' | 'canteen' | 'leisure_and_entertainment_venue' | 'banquet_hall' | 'cinema' | 'bowling_alley' | 'casino' | 'arcade' | 'commercial_and_industrial_building' | 'production_building' | 'factory' | 'operations_building' | 'brewery' | 'distillery' | 'workshop' | 'sawmill' | 'gas_station' | 'car_wash' | 'storage_building' | 'cold_storage' | 'warehouse' | 'freight_forwarding_building' | 'research_building' | 'raw_material_extraction_building' | 'mine' | 'saltworks' | 'company_social_facility_building' | 'other_commercial_industrial_building' | 'mill' | 'windmill' | 'watermill' | 'pumping_station' | 'weather_station' | 'commercial_service_residential_building' | 'commercial_industrial_residential_building' | 'traffic_facility_operations_building_general' | 'road_traffic_operations_building' | 'road_maintenance_depot' | 'waiting_hall' | 'rail_traffic_operations_building' | 'railroad_crossing_keeper_house' | 'locomotive_shed_carriage_hall' | 'signal_box_block_post' | 'freight_yard_operations_building' | 'air_traffic_operations_building' | 'aircraft_hangar' | 'maritime_traffic_operations_building' | 'shipyard_hall' | 'dock_hall' | 'lock_operations_building' | 'boathouse' | 'cable_car_operations_building' | 'cable_car_tensioning_station' | 'parking_building' | 'parking_garage' | 'garage' | 'vehicle_hall' | 'supply_building' | 'energy_supply_building' | 'water_supply_building' | 'waterworks' | 'water_reservoir' | 'electricity_supply_building' | 'power_plant' | 'substation' | 'transformer' | 'reactor_building' | 'turbine_house' | 'boiler_house' | 'telecommunications_building' | 'building_at_underground_lines' | 'gas_supply_building' | 'gas_works' | 'heating_plant' | 'utility_building' | 'pumping_station_non_water_supply' | 'disposal_building' | 'wastewater_treatment_building' | 'sewage_treatment_plant_building' | 'public_toilet' | 'waste_treatment_building' | 'waste_bunker' | 'waste_incineration_plant' | 'landfill_building' | 'agricultural_forestry_building' | 'agricultural_forestry_commercial_building' | 'barn' | 'shed' | 'stable' | 'barn_and_stable' | 'large_scale_animal_housing' | 'riding_hall' | 'alpine_hut' | 'hunting_lodge_cabin' | 'greenhouse' | 'moveable_greenhouse' | 'public_building' | 'administrative_building' | 'parliament_building' | 'town_hall' | 'post_office' | 'customs_office' | 'court_building' | 'embassy_consulate' | 'district_administration' | 'regional_government' | 'tax_office' | 'education_research_building' | 'general_education_school' | 'vocational_school' | 'higher_education_building_university' | 'research_institute' | 'cultural_building' | 'palace' | 'theater_opera' | 'concert_hall' | 'museum' | 'broadcasting_television' | 'event_building' | 'library' | 'castle_fortress' | 'religious_building' | 'church' | 'synagogue' | 'chapel' | 'community_hall' | 'house_of_worship' | 'mosque' | 'temple' | 'monastery' | 'healthcare_building' | 'hospital' | 'sanatorium_nursing_home_nursing_station' | 'doctors_office_polyclinic' | 'rescue_station' | 'social_services_building' | 'youth_center' | 'leisure_club_community_center' | 'senior_center' | 'homeless_shelter' | 'daycare_kindergarten' | 'refugee_shelter' | 'security_and_order_building' | 'police_station' | 'fire_station' | 'barracks' | 'air_raid_shelter' | 'correctional_facility' | 'cemetery_building' | 'funeral_hall' | 'crematorium' | 'reception_building' | 'railway_station_building' | 'airport_building' | 'subway_station_building' | 'suburban_railway_station_building' | 'bus_station_building' | 'maritime_terminal_building' | 'public_purpose_residential_building' | 'recreational_building' | 'sports_building' | 'sports_gymnasium' | 'sports_field_building' | 'bathhouse' | 'indoor_swimming_pool' | 'outdoor_pool_building' | 'stadium_building' | 'spa_facility_building' | 'medical_bath_building' | 'sanatorium' | 'zoo_building' | 'zoo_entrance_building' | 'aquarium_terrarium_aviary' | 'animal_exhibition_building' | 'zoo_stable' | 'botanical_garden_building' | 'botanical_garden_entrance_building' | 'botanical_greenhouse' | 'conservatory' | 'other_recreational_facility_building' | 'mountain_hut_shelter' | 'tourist_information_center' | 'not_specified_due_to_source_situation' | 'water_tower' | 'church_tower' | 'observation_tower' | 'control_tower' | 'cooling_tower' | 'lighthouse' | 'fire_watchtower' | 'transmission_radio_tower' | 'city_gate_tower' | 'winding_tower' | 'drilling_tower' | 'castle_tower' | 'other' | 'biogas_plant' | 'wind_turbine' | 'solar_panels' | 'mast' | 'power_line_mast' | 'radio_mast' | 'radio_telescope' | 'chimney' | 'crane' | 'slewing_crane' | 'gantry_crane' | 'traveling_crane' | 'blast_furnace' | 'silo' | 'tank' | 'gasometer' | 'grandstand' | 'covered_grandstand' | 'uncovered_grandstand' | 'stadium' | 'covered_stadium' | 'uncovered_stadium' | 'ski_jump_inrun' | 'graduation_tower' | 'historic_water_pipeline' | 'watchtower' | 'fortification_castle_ruin' | 'historic_wall' | 'city_wall' | 'other_historic_wall' | 'canopy' | 'carport' | 'wall' | 'monument' | 'ship_lift' | 'chamber_lock' | 'bridge' | 'swing_bridge' | 'lifting_bridge' | 'drawbridge' | 'elevated_railway_elevated_road' | 'lock_chamber' | 'dam' | 'weir' | 'security_gate' | 'sewer_drain' | 'barrage';
3215
2117
  /**
3216
2118
  * The grouping strategy used to aggregate buildings in this result. Currently supports: proximity (cadastral based clustering) and property (cadastral, address, construction year, and roof type based grouping). Defaults to `proximity` when no strategy is specified in the request.
3217
2119
  */
@@ -3388,86 +2290,6 @@ type BuildingGeometryResponseV4 = {
3388
2290
  features: Array<BuildingGeometryFeatureV4>;
3389
2291
  };
3390
2292
  type type6 = 'FeatureCollection';
3391
- type GetAddressLookupV2Data = {
3392
- query: {
3393
- city: string;
3394
- postcode: string;
3395
- street: string;
3396
- streetNumber: string;
3397
- };
3398
- };
3399
- type GetAddressLookupV2Response = {
3400
- type: 'Feature';
3401
- geometry: {
3402
- type: 'Polygon';
3403
- coordinates: Array<Array<(unknown[])>>;
3404
- } | {
3405
- type: 'MultiPolygon';
3406
- coordinates: Array<Array<Array<(unknown[])>>>;
3407
- };
3408
- properties: LookupPropertiesV2;
3409
- };
3410
- type GetAddressLookupV2Error = unknown;
3411
- type GetCoordinateLookupV2Data = {
3412
- query?: {
3413
- lat?: number | null;
3414
- lng?: number | null;
3415
- };
3416
- };
3417
- type GetCoordinateLookupV2Response = {
3418
- type: 'Feature';
3419
- geometry: {
3420
- type: 'Polygon';
3421
- coordinates: Array<Array<(unknown[])>>;
3422
- } | {
3423
- type: 'MultiPolygon';
3424
- coordinates: Array<Array<Array<(unknown[])>>>;
3425
- };
3426
- properties: LookupPropertiesV2;
3427
- };
3428
- type GetCoordinateLookupV2Error = unknown;
3429
- type PostCoordinateBatchLookupV2Data = {
3430
- /**
3431
- * Array of up to 500 geo coordinates
3432
- */
3433
- body: {
3434
- [key: string]: {
3435
- lat: number | null;
3436
- lng: number | null;
3437
- };
3438
- };
3439
- };
3440
- type PostCoordinateBatchLookupV2Response = {
3441
- type: 'FeatureCollection';
3442
- metadata: {
3443
- counts: {
3444
- total: number;
3445
- found: number;
3446
- not_found: number;
3447
- };
3448
- references: {
3449
- found: Array<(string)>;
3450
- not_found: Array<(string)>;
3451
- };
3452
- };
3453
- features: Array<{
3454
- type: 'Feature';
3455
- geometry: {
3456
- type: 'Polygon';
3457
- coordinates: Array<Array<(unknown[])>>;
3458
- } | {
3459
- type: 'MultiPolygon';
3460
- coordinates: Array<Array<Array<(unknown[])>>>;
3461
- };
3462
- properties: LookupPropertiesV2 & {
3463
- /**
3464
- * A unique identifier for the feature, which is provided by the client.
3465
- */
3466
- reference: string;
3467
- };
3468
- }>;
3469
- };
3470
- type PostCoordinateBatchLookupV2Error = unknown;
3471
2293
  type GetAddressLookupV3Data = {
3472
2294
  query: {
3473
2295
  city: string;
@@ -3517,267 +2339,83 @@ type GetCoordinateLookupV3Response = {
3517
2339
  properties: LookupPropertiesV3;
3518
2340
  }>;
3519
2341
  };
3520
- type GetCoordinateLookupV3Error = unknown;
3521
- type PostCoordinateBatchLookupV3Data = {
3522
- /**
3523
- * Array of up to 500 geo coordinates
3524
- */
3525
- body: {
3526
- [key: string]: {
3527
- lat: number | null;
3528
- lng: number | null;
3529
- };
3530
- };
3531
- query?: {
3532
- groupingStrategy?: 'proximity' | 'property';
3533
- resolution?: 'address' | 'geometry';
3534
- };
3535
- };
3536
- type PostCoordinateBatchLookupV3Response = {
3537
- type: 'FeatureCollection';
3538
- metadata: {
3539
- counts: {
3540
- total: number;
3541
- found: number;
3542
- not_found: number;
3543
- };
3544
- references: {
3545
- found: Array<(string)>;
3546
- not_found: Array<(string)>;
3547
- };
3548
- };
3549
- features: Array<{
3550
- type: 'Feature';
3551
- geometry: {
3552
- type: 'Polygon';
3553
- coordinates: Array<Array<(unknown[])>>;
3554
- } | {
3555
- type: 'MultiPolygon';
3556
- coordinates: Array<Array<Array<(unknown[])>>>;
3557
- };
3558
- properties: LookupPropertiesV3 & {
3559
- /**
3560
- * A unique identifier for the feature, which is provided by the client.
3561
- */
3562
- reference: string;
3563
- };
3564
- }>;
3565
- };
3566
- type PostCoordinateBatchLookupV3Error = unknown;
3567
- type GetParcelCoordinateLookupV4Data = {
3568
- query?: {
3569
- lat?: number | null;
3570
- lng?: number | null;
3571
- };
3572
- };
3573
- type GetParcelCoordinateLookupV4Response = {
3574
- type: 'FeatureCollection';
3575
- features: Array<{
3576
- type: 'Feature';
3577
- geometry: {
3578
- type: 'Polygon';
3579
- coordinates: Array<Array<(unknown[])>>;
3580
- } | {
3581
- type: 'MultiPolygon';
3582
- coordinates: Array<Array<Array<(unknown[])>>>;
3583
- };
3584
- properties: ParcelPropertiesV4;
3585
- }>;
3586
- };
3587
- type GetParcelCoordinateLookupV4Error = unknown;
3588
- type GetBuildingPart3dGeometryLookupV4Data = {
3589
- query: {
3590
- building_id: string;
3591
- grouping_strategy?: 'proximity' | 'property';
3592
- };
3593
- };
3594
- type GetBuildingPart3dGeometryLookupV4Response = BuildingGeometryResponseV4;
3595
- type GetBuildingPart3dGeometryLookupV4Error = unknown;
3596
- type $OpenApiTs = {
3597
- '/v2/addressLookup': {
3598
- get: {
3599
- req: GetAddressLookupV2Data;
3600
- res: {
3601
- /**
3602
- *
3603
- * Retrieves the building data based on the provided address. The response includes detailed
3604
- * information about the building. A more detailed description of the response can be found
3605
- * in the schema definition.
3606
- *
3607
- */
3608
- '200': {
3609
- type: 'Feature';
3610
- geometry: {
3611
- type: 'Polygon';
3612
- coordinates: Array<Array<(unknown[])>>;
3613
- } | {
3614
- type: 'MultiPolygon';
3615
- coordinates: Array<Array<Array<(unknown[])>>>;
3616
- };
3617
- properties: LookupPropertiesV2;
3618
- };
3619
- /**
3620
- * Invalid address
3621
- */
3622
- '400': {
3623
- /**
3624
- * Invalid address
3625
- */
3626
- error: string;
3627
- };
3628
- /**
3629
- * Address not found
3630
- */
3631
- '404': {
3632
- /**
3633
- * Address not found
3634
- */
3635
- error: string;
3636
- };
3637
- /**
3638
- * Internal server error
3639
- */
3640
- '500': {
3641
- /**
3642
- * Internal server error
3643
- */
3644
- error: string;
3645
- };
3646
- };
3647
- };
3648
- };
3649
- '/v2/coordinateLookup': {
3650
- get: {
3651
- req: GetCoordinateLookupV2Data;
3652
- res: {
3653
- /**
3654
- *
3655
- * Retrieves the building data based on the provided address. The response includes detailed
3656
- * information about the building. A more detailed description of the response can be found in
3657
- * the schema definition.
3658
- *
3659
- */
3660
- '200': {
3661
- type: 'Feature';
3662
- geometry: {
3663
- type: 'Polygon';
3664
- coordinates: Array<Array<(unknown[])>>;
3665
- } | {
3666
- type: 'MultiPolygon';
3667
- coordinates: Array<Array<Array<(unknown[])>>>;
3668
- };
3669
- properties: LookupPropertiesV2;
3670
- };
3671
- /**
3672
- * Invalid coordinate
3673
- */
3674
- '400': {
3675
- /**
3676
- * Invalid coordinate
3677
- */
3678
- error: string;
3679
- };
3680
- /**
3681
- * Unauthorized access
3682
- */
3683
- '401': {
3684
- /**
3685
- * Unauthorized access
3686
- */
3687
- error: string;
3688
- };
3689
- /**
3690
- * Coordinate not found
3691
- */
3692
- '404': {
3693
- /**
3694
- * Coordinate not found
3695
- */
3696
- error: string;
3697
- };
3698
- /**
3699
- * Internal server error
3700
- */
3701
- '500': {
3702
- /**
3703
- * Internal server error
3704
- */
3705
- error: string;
3706
- };
3707
- };
2342
+ type GetCoordinateLookupV3Error = unknown;
2343
+ type PostCoordinateBatchLookupV3Data = {
2344
+ /**
2345
+ * Array of up to 500 geo coordinates
2346
+ */
2347
+ body: {
2348
+ [key: string]: {
2349
+ lat: number | null;
2350
+ lng: number | null;
3708
2351
  };
3709
2352
  };
3710
- '/v2/coordinateBatchLookup': {
3711
- post: {
3712
- req: PostCoordinateBatchLookupV2Data;
3713
- res: {
3714
- /**
3715
- *
3716
- * Retrieves the building data for each of the provided coordinates. The response includes an array of detailed
3717
- * information about the buildings associated with each coordinate. A more detailed description of the response can be found in
3718
- * the schema definition.
3719
- *
3720
- */
3721
- '200': {
3722
- type: 'FeatureCollection';
3723
- metadata: {
3724
- counts: {
3725
- total: number;
3726
- found: number;
3727
- not_found: number;
3728
- };
3729
- references: {
3730
- found: Array<(string)>;
3731
- not_found: Array<(string)>;
3732
- };
3733
- };
3734
- features: Array<{
3735
- type: 'Feature';
3736
- geometry: {
3737
- type: 'Polygon';
3738
- coordinates: Array<Array<(unknown[])>>;
3739
- } | {
3740
- type: 'MultiPolygon';
3741
- coordinates: Array<Array<Array<(unknown[])>>>;
3742
- };
3743
- properties: LookupPropertiesV2 & {
3744
- /**
3745
- * A unique identifier for the feature, which is provided by the client.
3746
- */
3747
- reference: string;
3748
- };
3749
- }>;
3750
- };
3751
- /**
3752
- * Invalid coordinates
3753
- */
3754
- '400': {
3755
- /**
3756
- * Invalid coordinates
3757
- */
3758
- error: string;
3759
- };
3760
- /**
3761
- * Unauthorized access
3762
- */
3763
- '401': {
3764
- /**
3765
- * Unauthorized access
3766
- */
3767
- error: string;
3768
- };
3769
- /**
3770
- * Internal server error
3771
- */
3772
- '500': {
3773
- /**
3774
- * Internal server error
3775
- */
3776
- error: string;
3777
- };
3778
- };
2353
+ query?: {
2354
+ groupingStrategy?: 'proximity' | 'property';
2355
+ resolution?: 'address' | 'geometry';
2356
+ };
2357
+ };
2358
+ type PostCoordinateBatchLookupV3Response = {
2359
+ type: 'FeatureCollection';
2360
+ metadata: {
2361
+ counts: {
2362
+ total: number;
2363
+ found: number;
2364
+ not_found: number;
2365
+ };
2366
+ references: {
2367
+ found: Array<(string)>;
2368
+ not_found: Array<(string)>;
2369
+ };
2370
+ };
2371
+ features: Array<{
2372
+ type: 'Feature';
2373
+ geometry: {
2374
+ type: 'Polygon';
2375
+ coordinates: Array<Array<(unknown[])>>;
2376
+ } | {
2377
+ type: 'MultiPolygon';
2378
+ coordinates: Array<Array<Array<(unknown[])>>>;
2379
+ };
2380
+ properties: LookupPropertiesV3 & {
2381
+ /**
2382
+ * A unique identifier for the feature, which is provided by the client.
2383
+ */
2384
+ reference: string;
2385
+ };
2386
+ }>;
2387
+ };
2388
+ type PostCoordinateBatchLookupV3Error = unknown;
2389
+ type GetParcelCoordinateLookupV4Data = {
2390
+ query?: {
2391
+ lat?: number | null;
2392
+ lng?: number | null;
2393
+ };
2394
+ };
2395
+ type GetParcelCoordinateLookupV4Response = {
2396
+ type: 'FeatureCollection';
2397
+ features: Array<{
2398
+ type: 'Feature';
2399
+ geometry: {
2400
+ type: 'Polygon';
2401
+ coordinates: Array<Array<(unknown[])>>;
2402
+ } | {
2403
+ type: 'MultiPolygon';
2404
+ coordinates: Array<Array<Array<(unknown[])>>>;
3779
2405
  };
2406
+ properties: ParcelPropertiesV4;
2407
+ }>;
2408
+ };
2409
+ type GetParcelCoordinateLookupV4Error = unknown;
2410
+ type GetBuildingPart3dGeometryLookupV4Data = {
2411
+ query: {
2412
+ building_id: string;
2413
+ grouping_strategy?: 'proximity' | 'property';
3780
2414
  };
2415
+ };
2416
+ type GetBuildingPart3dGeometryLookupV4Response = BuildingGeometryResponseV4;
2417
+ type GetBuildingPart3dGeometryLookupV4Error = unknown;
2418
+ type $OpenApiTs = {
3781
2419
  '/v3/addressLookup': {
3782
2420
  get: {
3783
2421
  req: GetAddressLookupV3Data;
@@ -4059,141 +2697,6 @@ type $OpenApiTs = {
4059
2697
  };
4060
2698
  };
4061
2699
 
4062
- /**
4063
- * Retrieve building data based on a given address
4064
- *
4065
- * This endpoint allows users to retrieve detailed building data by providing an address.
4066
- * The data includes information from both public and private sources, aggregated into a
4067
- * comprehensive dataset.
4068
- *
4069
- * ### Permissions
4070
- * - `api.lookup.address.read`: This permission grants the ability
4071
- * to read and retrieve building data based on a provided address. It ensures that the
4072
- * user has access rights to query the address-based lookup endpoint.
4073
- *
4074
- * ### Address-based Lookup
4075
- * This endpoint is designed to retrieve building data based on a given address, focusing
4076
- * solely on exact matches. If the address is not found, the endpoint will return an empty
4077
- * response. For use cases involving un-geocoded addresses, we recommend using our
4078
- * coordinate-based lookup endpoint.
4079
- *
4080
- * ### Response Structure
4081
- * - **GeoJSON Type**: In v2, the response format has been simplified to a `Feature` object, representing a single feature, rather than the `FeatureCollection` type returned by v1. This change reflects the endpoint's focus on returning a single or no result based on the query.
4082
- */
4083
- declare const getAddressLookupV2: (options: Options<GetAddressLookupV2Data>) => Promise<{
4084
- error?: unknown;
4085
- data?: GetAddressLookupV2Response | undefined;
4086
- request: Request;
4087
- response: Response;
4088
- }>;
4089
- /**
4090
- * Retrieve building data based on a given coordinate
4091
- *
4092
- * This endpoint allows users to retrieve detailed building data by providing a geo coordinate.
4093
- * The data includes information from both public and private sources, aggregated into a
4094
- * comprehensive dataset.
4095
- *
4096
- * ### Key Changes in v2
4097
- * In v2, the response format has been optimized to return a `Feature` rather than a `FeatureCollection`. This adjustment reflects the endpoint’s focus on retrieving a single result or no result, rather than a collection, simplifying client-side handling.
4098
- *
4099
- * ### Permissions
4100
- * - `api.lookup.coordinate.read`: This permission grants the ability to
4101
- * read and retrieve building data based on a provided coordinate. It ensures that the user has
4102
- * access rights to query the coordinate-based lookup endpoint.
4103
- *
4104
- * ### Response Structure
4105
- * - **GeoJSON Type**: The response in v2 is now a single `Feature` object representing one building result or an empty response if no match is found. This differs from v1, which returned a `FeatureCollection` object.
4106
- */
4107
- declare const getCoordinateLookupV2: (options?: Options<GetCoordinateLookupV2Data>) => Promise<{
4108
- error?: unknown;
4109
- data?: GetCoordinateLookupV2Response | undefined;
4110
- request: Request;
4111
- response: Response;
4112
- }>;
4113
- /**
4114
- * Retrieve building data for a batch of coordinates
4115
- *
4116
- * This endpoint allows users to retrieve detailed building data by providing a batch of
4117
- * geo-coordinates. The response is a GeoJSON object containing a FeatureCollection, where each
4118
- * feature represents a building and includes additional properties for tracking back to the
4119
- * requested coordinates.
4120
- *
4121
- * ### Key Improvements in v2
4122
- *
4123
- * In v2, each coordinate can be assigned a unique reference ID in the request body, allowing for
4124
- * more precise handling of results. The response includes a metadata section that provides:
4125
- * - The total number of coordinates processed.
4126
- * - A count of found and not-found coordinates.
4127
- * - Lists of references for found and not-found coordinates, making it easier to manage unmatched
4128
- * entries without requiring complex client-side matching logic.
4129
- *
4130
- * ### Request Body Format
4131
- * The request body is structured as an object where each key is a unique reference ID for a
4132
- * coordinate:
4133
- *
4134
- * ```json
4135
- * {
4136
- * "reference_id1": { "lat": 51.252258, "lng": 7.13107 },
4137
- * "reference_id2": { "lat": 51.29342, "lng": 7.21936 },
4138
- * "reference_id3": { "lat": 51.18941, "lng": 7.14259 }
4139
- * }
4140
- * ```
4141
- *
4142
- * ### Response Structure
4143
- * - **GeoJSON Type**: The response includes a FeatureCollection containing matched features.
4144
- * - **Metadata**:
4145
- * - `counts`: Provides total, found, and not-found counts for the requested coordinates.
4146
- * - `references`: Lists reference IDs of matched (`found`) and unmatched (`not_found`)
4147
- * coordinates.
4148
- *
4149
- * #### Example Response:
4150
- * ```json
4151
- * {
4152
- * "type": "FeatureCollection",
4153
- * "metadata": {
4154
- * "counts": {
4155
- * "total": 3,
4156
- * "found": 2,
4157
- * "not_found": 1
4158
- * },
4159
- * "references": {
4160
- * "found": ["reference_id1", "reference_id2"],
4161
- * "not_found": ["reference_id3"]
4162
- * }
4163
- * },
4164
- * "features": [
4165
- * {
4166
- * "type": "Feature",
4167
- * "geometry": { * geometry details * },
4168
- * "properties": {
4169
- * "ref": "reference_id1",
4170
- * ...
4171
- * }
4172
- * },
4173
- * ...
4174
- * ]
4175
- * }
4176
- * ```
4177
- *
4178
- * ### Handling Non-Matching Coordinates
4179
- *
4180
- * For unmatched coordinates, v2 includes metadata listing these coordinates, enabling clients to
4181
- * easily filter out or handle non-matching entries. This improves upon v1, where clients had to
4182
- * manage complex matching logic without clear references for non-matching coordinates.
4183
- *
4184
- * ### Limitations
4185
- * This endpoint supports up to 500 coordinates per request. If more are needed, split into multiple
4186
- * requests.
4187
- *
4188
- * ### Permissions
4189
- * - `api.batch.lookup.coordinate.read`: Grants the ability to access this endpoint.
4190
- */
4191
- declare const postCoordinateBatchLookupV2: (options: Options<PostCoordinateBatchLookupV2Data>) => Promise<{
4192
- error?: unknown;
4193
- data?: PostCoordinateBatchLookupV2Response | undefined;
4194
- request: Request;
4195
- response: Response;
4196
- }>;
4197
2700
  /**
4198
2701
  * Retrieve building data based on a given address
4199
2702
  *
@@ -4328,7 +2831,7 @@ declare const getCoordinateLookupV3: (options?: Options<GetCoordinateLookupV3Dat
4328
2831
  *
4329
2832
  * ### Handling Non-Matching Coordinates
4330
2833
  *
4331
- * For unmatched coordinates, v2 includes metadata listing these coordinates, enabling clients to
2834
+ * For unmatched coordinates, the response includes metadata listing these coordinates, enabling clients to
4332
2835
  * easily filter out or handle non-matching entries. This improves upon v1, where clients had to
4333
2836
  * manage complex matching logic without clear references for non-matching coordinates.
4334
2837
  *
@@ -4413,4 +2916,4 @@ declare const getBuildingPart3dGeometryLookupV4: (options: Options<GetBuildingPa
4413
2916
  response: Response;
4414
2917
  }>;
4415
2918
 
4416
- export { $BuildingGeometryFeatureV4, $BuildingGeometryPropertiesV4, $BuildingGeometryResponseV4, $Geometry3D, $GeometryCollection3D, $LookupPropertiesV2, $LookupPropertiesV3, $MultiPolygon3DGeometry, type $OpenApiTs, $ParcelPropertiesV4, $Polygon3DGeometry, $Position3D, $SurfaceType, type BuildingGeometryFeatureV4, type BuildingGeometryPropertiesV4, type BuildingGeometryResponseV4, type Geometry3D, type GeometryCollection3D, type GetAddressLookupV2Data, type GetAddressLookupV2Error, type GetAddressLookupV2Response, type GetAddressLookupV3Data, type GetAddressLookupV3Error, type GetAddressLookupV3Response, type GetBuildingPart3dGeometryLookupV4Data, type GetBuildingPart3dGeometryLookupV4Error, type GetBuildingPart3dGeometryLookupV4Response, type GetCoordinateLookupV2Data, type GetCoordinateLookupV2Error, type GetCoordinateLookupV2Response, type GetCoordinateLookupV3Data, type GetCoordinateLookupV3Error, type GetCoordinateLookupV3Response, type GetParcelCoordinateLookupV4Data, type GetParcelCoordinateLookupV4Error, type GetParcelCoordinateLookupV4Response, type LookupPropertiesV2, type LookupPropertiesV3, type MultiPolygon3DGeometry, type ParcelPropertiesV4, type Polygon3DGeometry, type Position3D, type PostCoordinateBatchLookupV2Data, type PostCoordinateBatchLookupV2Error, type PostCoordinateBatchLookupV2Response, type PostCoordinateBatchLookupV3Data, type PostCoordinateBatchLookupV3Error, type PostCoordinateBatchLookupV3Response, type SurfaceType, type building_function_class, type characteristics, type development_layout, type dominant, type environment, getAddressLookupV2, getAddressLookupV3, getBuildingPart3dGeometryLookupV4, getCoordinateLookupV2, getCoordinateLookupV3, getParcelCoordinateLookupV4, type governance, type grouping_strategy, type height_category, type investment_perspective, type milieus_dominant, type modernisation_potential, type overall, postCoordinateBatchLookupV2, postCoordinateBatchLookupV3, type roof_type, type social, type type, type type2, type type3, type type4, type type5, type type6, type usage };
2919
+ export { $BuildingGeometryFeatureV4, $BuildingGeometryPropertiesV4, $BuildingGeometryResponseV4, $Geometry3D, $GeometryCollection3D, $LookupPropertiesV3, $MultiPolygon3DGeometry, type $OpenApiTs, $ParcelPropertiesV4, $Polygon3DGeometry, $Position3D, $SurfaceType, type BuildingGeometryFeatureV4, type BuildingGeometryPropertiesV4, type BuildingGeometryResponseV4, type Geometry3D, type GeometryCollection3D, type GetAddressLookupV3Data, type GetAddressLookupV3Error, type GetAddressLookupV3Response, type GetBuildingPart3dGeometryLookupV4Data, type GetBuildingPart3dGeometryLookupV4Error, type GetBuildingPart3dGeometryLookupV4Response, type GetCoordinateLookupV3Data, type GetCoordinateLookupV3Error, type GetCoordinateLookupV3Response, type GetParcelCoordinateLookupV4Data, type GetParcelCoordinateLookupV4Error, type GetParcelCoordinateLookupV4Response, type LookupPropertiesV3, type MultiPolygon3DGeometry, type ParcelPropertiesV4, type Polygon3DGeometry, type Position3D, type PostCoordinateBatchLookupV3Data, type PostCoordinateBatchLookupV3Error, type PostCoordinateBatchLookupV3Response, type SurfaceType, type building_function_class, type characteristics, type development_layout, type dominant, type environment, getAddressLookupV3, getBuildingPart3dGeometryLookupV4, getCoordinateLookupV3, getParcelCoordinateLookupV4, type governance, type grouping_strategy, type investment_perspective, type milieus_dominant, type modernisation_potential, type overall, postCoordinateBatchLookupV3, type roof_type, type social, type type, type type2, type type3, type type4, type type5, type type6 };