Building footprints with heights and volumes (GeoJSON, sync) - JSON body variant

Identical to the GET, with the filter in a JSON body. Prefer the GET when a cacheable URL is convenient.

POST

https://res.aireon.ch/res_api/building_footprints

Authorization

ResApiToken
API key in header
required

Request body JSON required

lat
optional
number
lng
optional
number
radius_m
optional
number
maximum: 500 · minimum: 1 · default: 100
bbox
optional
[minLng, minLat, maxLng, maxLat] in WGS84.
One of the following:
string
array<number>
}
egrid
optional
string
pattern: ^CH[0-9]{12}$
crs
optional
4326
or
2056
default: 4326
max_features
optional
integer
maximum: 2000 · minimum: 1 · default: 1000

Example requests

{
  "lat": 47.3769,
  "lng": 8.5417,
  "radius_m": 150,
  "crs": 2056
}

{
  "egrid": "CH727181999158"
}

Returns

200

Footprints in the requested area.

JSON

type
string
required
features
array of
object
required
- type
  string
  required
- id
  integer
  required
  res_building_id - the suite-wide stable building key (also the feature id in the bo_buildings_vol vector tiles).
- geometry
  object
  required
  A GeoJSON geometry object (Polygon or MultiPolygon here).
  
  type
  Polygon
  or
  MultiPolygon
  or
  Point
  or
  LineString
  or
  MultiLineString
  or
  MultiPoint
  +1 more
  required
  coordinates
  array of
  unknown
  required
- properties
  object
  required
  res_building_id
  optional
  integer
  egid
  optional
  integer | null
  Federal building identifier (GWR EGID).
  
  objid
  optional
  string | null
  Cadastral (AV) object id - not unique.
  
  address
  optional
  string | null
  zip
  optional
  integer | null
  city
  optional
  string | null
  canton
  optional
  string | null
  foot_area_m2
  optional
  number | null
  Footprint area in m² (computed in LV95).
  
  vol_m3
  optional
  number | null
  Building volume in m³ from the integrated cascade.
  
  vol_src
  optional
  roofer_lod22
  or
  footprint_prism
  or
  gwr_gvol
  or
  gwr_floors_prism
  or
  flat_prism
  or
  none
  +1 more
  Which estimator produced vol_m3 (roofer LoD2.2 solid → footprint prism from measured height → GWR volume → GWR floors × 3 m → flat 3 m prism).
  
  height_m
  optional
  number | null
  Building height in metres: roof 70th percentile minus ground for roofer buildings, otherwise the height the volume estimator used.
  
  h_ground_masl
  optional
  number | null
  Ground elevation at the footprint, m a.s.l. (roofer only).
  
  h_roof_70p_masl
  optional
  number | null
  Roof elevation, 70th percentile of LiDAR roof points, m a.s.l. (roofer only).
  
  h_roof_max_masl
  optional
  number | null
  h_roof_min_masl
  optional
  number | null
  h_ridge_masl
  optional
  number | null
  roof_type
  optional
  string | null
  slanted | horizontal | unknown (roofer classification).
  
  roof_planes
  optional
  integer | null
  rf_state
  optional
  ok
  or
  novol
  or
  norecon
  or
  null
  Roofer status: ok = LoD2.2 solid available; novol = reconstructed without a valid volume; norecon = not reconstructed.
  
  pc_vintage
  optional
  integer | null
  swissSURFACE3D point-cloud vintage year used by the roofer.
  
  floors
  optional
  integer | null
  GWR floor count.
  
  year
  optional
  integer | null
  GWR construction year.
  
  gstat
  optional
  integer | null
  GWR building status code (1004 = existing).
}
numberReturned
integer
required
capped
boolean
required
True when more buildings matched than max_features; narrow the area or tile the request. Capped answers are not cached.
crs
object
required
GeoJSON named CRS: urn:ogc:def:crs:EPSG::4326 (default) or urn:ogc:def:crs:EPSG::2056 when crs=2056 was requested.
- type
  optional
  string
- properties
  optional
  object
  name
  optional
  string
}
query
object
required
The normalised filter that was applied (mode point|bbox|egrid with its parameters).
source
object
required
- table
  optional
  string
- roofer_table
  optional
  string
- vol_src_counts
  optional
  map of
  integer
- height_definition
  optional
  string
}
timeStamp
optional
string
format: date-time

400

Invalid request.

JSON

error
string
required
Human-readable error description.
message
optional
string
Optional underlying error message.

401

Authentication missing or invalid.

JSON

error
string
required
Human-readable error description.
message
optional
string
Optional underlying error message.

403

Authenticated but not permitted.

JSON

error
string
required
Human-readable error description.
message
optional
string
Optional underlying error message.

500

Server error.

JSON

error
string
required
Human-readable error description.
message
optional
string
Optional underlying error message.

504

The PostGIS query exceeded the 10 s statement timeout - narrow the area.

JSON

error
optional
string
detail
optional
string

curl --request POST \ --url https://res.aireon.ch/res_api/building_footprints \ --header 'Content-Type: application/json' \ --header 'token: <token>' \ --data ' { "lat": 47.3769, "lng": 8.5417, "radius_m": 150, "crs": 2056 } '

{ "type": "FeatureCollection", "features": [ { "type": "Feature", "id": 0, "geometry": { "type": "Polygon", "coordinates": [ null ] }, "properties": { "res_building_id": 0, "egid": 0, "objid": "string", "address": "string", "zip": 0, "city": "string", "canton": "string", "foot_area_m2": 0, "vol_m3": 0, "vol_src": "roofer_lod22", "height_m": 0, "h_ground_masl": 0, "h_roof_70p_masl": 0, "h_roof_max_masl": 0, "h_roof_min_masl": 0, "h_ridge_masl": 0, "roof_type": "string", "roof_planes": 0, "rf_state": "ok", "pc_vintage": 0, "floors": 0, "year": 0, "gstat": 0 } } ], "numberReturned": 0, "capped": true, "timeStamp": "2019-08-24T14:15:22Z", "crs": { "type": "string", "properties": { "name": "string" } }, "query": {}, "source": { "table": "string", "roofer_table": "string", "vol_src_counts": { "property1": 0, "property2": 0 }, "height_definition": "string" } }