Skip to content
Sign in Book a demo

One building

GETapi.baseray.ai/v1/buildings/{building_id}

One building's record. A building the catalogue no longer holds is still returned with is_current false and, where one now stands on its ground, replaced_by_building_id.

Requires an API key. How to authenticate.

Path parameters

building_idstring (uuid)required
The building's baseray id, a UUID returned by the other building endpoints.

Response 200

OK

dataBuildingDetailrequired
building_idstring (uuid)required
The building's baseray id.
addressstring or nullrequired
Street and house number as recorded; null when the building has no address on record.
localitystring or nullrequired
Town, city or village.
countrystring or nullrequired
ISO 3166-1 alpha-2 country code.
latitudenumberrequired
Latitude of the building's centre, WGS84.
longitudenumberrequired
Longitude of the building's centre, WGS84.
categoryresidential_house | apartment_block | commercial | industrial | public | agricultural | ancillary | unknownrequired
Building category; ancillary is an annex or outbuilding.
footprint_area_m2numberrequired
Ground footprint, in m².
heightHeight or any or nullrequired
Height; null when unknown.
metresnumberrequired
Height in metres.
basismeasured | estimatedrequired
measured, or estimated (modelled).
volume_m3number or nullrequired
Volume, in m³; null when unknown.
volume_basismeasured | estimated or nullrequired
Whether the volume is measured or estimated; null with the volume.
floorsinteger or nullrequired
Floors above ground; null when unknown.
existing_solar_panelsExistingSolarPanelsrequired
Whether solar panels are already on the roof, as a dated photo of the roof shows it.
statusdetected | none_seen | unclear | not_checkedrequired
detected, none_seen, unclear, or not_checked (never checked, or the photo was too coarse to check).
photo_datestring (date) or nullrequired
Date of the photo checked; null when undated or never checked.
confidencenumber or nullrequired0–1
The check's confidence in its result, 0 to 1; null when not checked.
solar_potentialSolarPotential or any or nullrequired
Rooftop solar potential; null where the roof has not been modelled.
max_panel_countinteger or nullrequired
Solar panels that fit on the roof.
max_capacity_kwpnumber or nullrequired
Capacity of those panels, in kWp.
yearly_energy_kwhnumber or nullrequired
Energy they would produce in a year, in kWh.
usable_roof_area_m2number or nullrequired
Roof area usable for panels, in m².
co2_savings_kg_per_yearnumber or nullrequired
CO₂ the installation would save, in kg a year.
registered_business_countintegerrequired≥ 0
Active businesses whose registered office is the building's address. Never ownership or occupancy.
app_urlstring (uri)required
The building in the baseray app.
dwellingsinteger or nullrequired
Dwellings, where known; null when unknown.
entrancesinteger or nullrequired
Entrances: each listed address of the building counts as one; null when none are listed.
is_currentbooleanrequired
False once the building is no longer in the catalogue's current release.
replaced_by_building_idstring (uuid) or nullrequired
The building now standing on a retired building's ground, when there is one.

Errors

400
A parameter is missing, malformed or out of range (invalid_parameter).
401
No API key, or one that does not work: missing_api_key, invalid_api_key, revoked_api_key or expired_api_key.
403
The key may not do this: insufficient_scope, or workspace_access_revoked when the key's creator no longer belongs to its workspace.
404
No building has this id (not_found).
429
rate_limited (the key's per-minute limit) or quota_exceeded (the workspace's daily quota).
503
The building catalogue is unavailable right now (upstream_unavailable); retry after Retry-After seconds.

Every error has the same shape. Error codes.