Building volume statistics within a bounding box

Aggregates building footprint count, volume and density within a circular bounding box around a coordinate.

POST

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

Authorization

ResApiToken
API key in header
required

Request body JSON required

lat
number
required
WGS84 latitude.
lng
number
required
WGS84 longitude.
bbox_radius
optional
number
Bounding-box radius, in metres. Must be positive.

default: 100

Returns

200

Building volume statistics.

JSON

success
optional
boolean
input
optional
object
- lat
  optional
  number
- lng
  optional
  number
- bbox_radius_m
  optional
  number
}
statistics
optional
object
- total_building_count
  optional
  integer
- buildings_with_volume
  optional
  integer
- buildings_without_volume
  optional
  integer
- total_volume_m3
  optional
  number
- avg_volume_m3
  optional
  number | null
- min_volume_m3
  optional
  number | null
- max_volume_m3
  optional
  number | null
- total_footprint_area_m2
  optional
  number
}
density
optional
object
- bbox_area_m2
  optional
  number
- volume_density_bbox_m3_per_m2
  optional
  number
- volume_density_footprint_m3_per_m2
  optional
  number
}

400

Missing or invalid token / parameters.

JSON

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

401

Wrong token.

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.

curl --request POST \ --url https://res.aireon.ch/res_api/bldg_vol_bbox \ --header 'Content-Type: application/json' \ --header 'token: <token>' \ --data ' { "lat": 0, "lng": 0, "bbox_radius": 100 } '

{ "success": true, "input": { "lat": 0, "lng": 0, "bbox_radius_m": 0 }, "statistics": { "total_building_count": 0, "buildings_with_volume": 0, "buildings_without_volume": 0, "total_volume_m3": 0, "avg_volume_m3": 0, "min_volume_m3": 0, "max_volume_m3": 0, "total_footprint_area_m2": 0 }, "density": { "bbox_area_m2": 0, "volume_density_bbox_m3_per_m2": 0, "volume_density_footprint_m3_per_m2": 0 } }