Vepler logo
v2.129.0

Buildings API: building footprints and characteristics

New Buildings product exposes building footprints, structure, construction, roof and basement data with lookup, search, batch, spatial and aggregation endpoints.

Added

  • New Buildings product. Six endpoints return building footprints and characteristics keyed by a composite buildingId in {country}:{provider}:{externalId} format (e.g. GB:NGD:abc12345-67de-89f0-1234-567890abcdef).
  • Get a single building: GET /v1/buildings/{buildingId}. Returns the full object including structure, construction, roof and basement sub-blocks.
  • Batch lookup: POST /v1/buildings/by-ids takes up to 100 buildingIds in one request. Unmatched IDs are silently omitted — compare total_count against your input length to detect misses.
  • Search: POST /v1/buildings/query supports convenience filters, an advanced query operator tree, geographic area filters (polygon, multipolygon, point+radius, containsPoint, boundingBox), sort, geoSort and offset/limit pagination.
  • Aggregations: POST /v1/buildings/aggregate runs up to 10 aggregations (terms, stats, min/max/avg/sum, cardinality, histogram, date_histogram, percentiles, geotile_grid) over the same filter set. Results are keyed by the name you give each definition.
  • Spatial and identifier lookups: GET /v1/buildings/by-point returns buildings whose footprint contains a WGS84 lat/lon (empty list, not 404, when none match), and GET /v1/buildings/by-uprn/{uprn} returns buildings linked to a uprn.
  • Heavy fields footprint, parts, addresses and _provenance are excluded by default — opt in per request via the attributes parameter (comma-separated string or array).