One building

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

One building's whole record, as the baseray app's building panel shows it: the building itself, its addresses (each entrance with the dwellings behind it), what its register record says of its units floor by floor and kind by kind, the whole record as its register lays it out, the roof analysis plane by plane, the local climate with its heating degree-days and warming trend, gas and district-heating network evidence, and the heating estimate. 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

dataBuildingDetailrequired

building_idstring (uuid)required

The building's baseray id.

addressstring or nullrequired

The building's address as a record states it (address_evidence says which kind): street and house number, a Romanian village's nr. 350 where the record names no street, or a Czech municipality and number (Lhota 25), with the block where one is given. Null when no address of the building is on record; the nearest named road is then nearest_road, never this.

nearest_roadstring or nullrequired

The named road nearest the building, given only where no address of it is on record (address is then null). It helps find the building but is not its address: no house number is known.

address_evidenceaddress_record | business_listing or nullrequired

What kind of record address comes from: address_record (an address record of the building) or business_listing (a listing of a business at the building, not an address record of it). Null when address is null or the kind is unknown.

address_corroborationcorroborated | single_source | conflicting or nullrequired

How other records back the house number of address, as the address_corroboration filter reads it: corroborated (an independent record gives the same number), single_source (only one record) or conflicting (another record gives another number). Null without a house number.

postal_codestring or nullrequired

The official postcode of the building's address; null when none is 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.

Building category; ancillary is an annex or outbuilding.

category_evidenceconfirmed | corroborated | inferred | conflicting | unconfirmedrequired

How firmly category is known: confirmed (an official register states it), corroborated (several sources agree), inferred, conflicting (sources disagree) or unconfirmed (always so for unknown).

building_typestring or nullrequired

The building's granular type where a record states one, as the building_type filter reads it, e.g. office, warehouse, school, apartments; null when none is stated.

roof_shapestring or nullrequired

The roof's shape, as the roof_shape filter reads it, e.g. gabled, hipped, flat; null when unknown.

footprint_area_m2numberrequired

Area of the building's outline, in m². It is the ground footprint only where the outline is drawn at the walls (outline_reference footprint on the building's detail); an outline drawn at the roof's edge (roof_edge) takes in the eaves and is larger.

heightHeight or any or nullrequired

Height; null when unknown.

metresnumberrequired: Height in metres.
basismeasured | stated | estimatedrequired: measured (the building itself was measured), stated (a record gives it: an official building catalogue, crowd mapping or the dataset of the building's outline) 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.

floor_areaFloorArea or any or nullrequired

Floor area, with what it rests on and what it counts; null when unknown.

square_metresnumberrequired: Floor area, in m².
basismeasured | stated | estimated or nullrequired: stated (a record states it for the building) or estimated (modelled: the footprint, or a record's built area, times the floors); null when unknown.
scopegross_whole_building | net_whole_building | gross_full_storeys | gross_above_ground or nullrequired: What the figure counts: gross_whole_building (every storey, walls included), net_whole_building (the usable area of every storey, walls excluded), gross_full_storeys (the ground floor and every full storey, walls included; the basement and the attic are not counted) or gross_above_ground (the footprint times the floors above ground, walls included); null when unknown.

floorsinteger or nullrequired

Floors above ground; null when unknown.

floors_including_undergroundinteger or nullrequired

Only where floors is unknown: the floors above and below ground counted together, as a building register states them (Czechia's counts them so, a habitable attic as one). How many of them are above ground is not on record. Null otherwise.

construction_yearinteger or nullrequired

The year a register states the building was completed; null when none states it.

completed_by_yearinteger or nullrequired

Where a register dates the building only by a census period: the last year of that period, the year it stood by. Null otherwise.

dwellingsinteger or nullrequired

Dwellings, where known; null when unknown.

existing_solar_panelsExistingSolarPanelsrequired

Whether solar panels are already on the roof, as a dated photo of the roof shows it. This is the photo alone: solar_presence settles it with the registers of connected installations, which outrank a photo.

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.
analysed_onstring (date) or nullrequired: The day the photo was checked for panels; null when never checked.
photo_resolution_cmnumber or nullrequired≥ 0: How fine the photo is, in centimetres per pixel; a photo too coarse to check is why a roof stays not_checked. Null when not known.

Whether the building carries solar panels, settled across the official registers of connected solar installations and the roof photo of existing_solar_panels. A register entry is the stronger evidence: a photo may predate an installation or miss it. registered: a register states an installation at the building's address, and the building alone holds that address or its own photo shows the panels. detected: panels are seen in the photo and no register states an installation. registered_at_address: a register states an installation at an address this building shares with others (registered_solar.address_building_count of them) and its photo shows none, so the register does not say which roof carries the panels: not a plain yes. none_seen: a photo detailed enough shows no panels and no register states an installation. unclear: the photo is unclear and no register states one. unknown: neither says. A building no register names is never thereby without solar: an installation may be off the grid, or registered under an address written otherwise. The solar_presence and exclude_solar_presence filters of GET /buildings read this field.

registered_solarRegisteredSolar or any or nullrequired

The solar installations official registers state at the building's address; not null exactly when solar_presence is registered or registered_at_address. Null says nothing of the roof.

installation_countintegerrequired≥ 1: Installations registered at the address.
installed_power_kwnumber or nullrequired: Installed power in kW: the installations' sum where every one states its own, null otherwise, never a partial sum.
export_power_kwnumber or nullrequired: Power approved to feed the grid, in kW: the installations' sum where every one states its own, null otherwise.
storage_capacity_kwhnumber or nullrequired: Energy storage in kWh: the sum where every installation that stores states its capacity, null otherwise; often null even where has_storage is true.
has_storageboolean or nullrequired: True where an installation is stated to store energy, false where every installation is stated to store none, null where the register does not say. A register of generation licences does not record storage.
first_connected_onstring (date) or nullrequired: The earliest date the installations state; null when not stated, or when a register states only the year (establishment_year), which is then given as first_connected_year alone. What it dates is in kinds: a connection certificate for grid_connection, the start of the current holder's licence for generation_licence, when the plant may be older.
latest_connected_onstring (date) or nullrequired: The latest date the installations state, of the same meaning as first_connected_on, and the same date for a single installation.
first_connected_yearinteger or nullrequired: The year of the earliest date the installations state, given whenever a date is. Where a register states only the year (establishment_year in kinds) it is the only date given: first_connected_on and latest_connected_on are then null. Null when nothing is stated.
latest_connected_yearinteger or nullrequired: The year of the latest date the installations state, of the same meaning as first_connected_year, and the same year for a single installation.
address_building_countintegerrequired≥ 1: Buildings holding the address the register names, this one included. Of several installations it is the fewest: one at an address the building alone holds is its own.
shares_addressbooleanrequired: True when address_building_count is above 1: the register then does not say which of the buildings carries the panels.
kindsarray of grid_connection | generation_licence | establishment_yearrequired: What the registers record, which says what the dates mean. grid_connection: a grid operator's list of connected installations, dated by the connection certificate. generation_licence: a regulator's generation licences, dated by the start of the current holder's licence, so the plant may be older and the date is never when it was installed. establishment_year: a building register's installations, dated by the year the installation was established as an owner or a municipality states it, never by its connection; only the year is stated, so the dates are null and only first_connected_year and latest_connected_year are given. Usually one kind; empty only when the kind could not be read.
reported_throughstring (date)required: The last day of the latest month the registers report: an installation entered after it is not yet listed.

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.
basismeasured | measured_cut_to_outline | estimated or nullrequired: measured where the figures come from the roof itself as measured: a surface model read over it, or roof planes an open survey measured on the building (roof_analysis.roof_survey says how). measured_cut_to_outline where the measured roof took in the roofs attached to the building (a terraced or semi-detached house) and was cut to the building's outline: its planes and panels were measured, but each is kept or dropped whole by where its centre lies, so the figures approximate the building's own part. estimated where they are modelled from the footprint and sunshine. Null when not said.

registered_business_countintegerrequired≥ 0

Active businesses whose registered office is the building's address. Never ownership or occupancy.

registered_business_employeesstring or nullrequired

The largest stated size of a business registered at the address, as the registered_business_employees sort and filters read it: an exact count (12), a band (10–49) or an open top band (1000 or more); null when none is stated.

registered_business_turnoverTurnover or any or nullrequired

The largest latest turnover of a business registered at the address, as the registered_business_turnover sort and filters read it; null when none is on record.

amountintegerrequired: Turnover, in whole units of currency.
currencystring or nullrequired: ISO 4217 currency of the statement.
financial_yearinteger or nullrequired: The financial year of the statement.

The most frequently flooded zone of an official flood hazard map the building lies in, named by the return period of its flood; 100_year_climate_change is the 1-in-100-year flood under the climate the map projects. Null means outside every zone only where flood_zone_mapped is true; elsewhere the zone is unknown.

flood_zone_mappedbooleanrequired

True where a served flood hazard map covers the building. Flood maps are served only where their licence allows it; where none covers the building this is false and its flood zone is unknown, never "no flood risk".

flood_zone_sourcestring or nullrequired

The credit and the reading the flood map's publisher requires wherever its zone is shown, such as Denmark's "Kilde: Kystdirektoratet, Kystplanlægger.dk" with its note that the zone is a screening, never an assessment of the property. Null where no served map covers the building, or its publisher requires none.

seismic_design_acceleration_gnumber or nullrequired

The design peak ground acceleration of the building's site, in g, as the national seismic design code maps it (P100-1/2013 in Romania); null when unknown.

The seismic risk class an official list of technically assessed buildings gives the building: RsI (the highest risk) to RsIV, the urgency classes U1 (the most urgent) to U3 older assessments set, or consolidated (strengthened since). Null when the building is on no such list, which says nothing of its risk.

seismic_risk_assessment_yearinteger or nullrequired

The year of the assessment that set seismic_risk_class; null when not stated.

The kind of owner the building's property has on record, never who owns it: private_person (private persons or a partnership of them), social_housing (a non-profit social housing organisation), company, association (an association, foundation or self-owned institution), cooperative_housing (a housing co-operative), municipality, region, state, or other (any other owner, or owners of several of these kinds together; nothing more is on record). Null means unknown: no record states one kind for the building, as for a building divided into flats owned one by one.

app_urlstring (uri)required

The building in the baseray app.

entrancesinteger or nullrequired

Entrances: each listed address of the building counts as one; null when none are listed.

stated_factsarray of StatedFactrequired

Everything the building's record states, as it words it; empty when no record is on file. A floor area here is the record's own figure; the building's floor area is floor_area.

factstringrequired: What the fact is, e.g. use, construction_year, completed_by_year (the year a building stood by, where it is dated only by a period ending then), floors_above_ground, floors_below_ground, built_up_area, floor_area, enclosed_volume, dwelling_count, unit_count, heating, cadastral_number or land_book_number_as_filed (a land book number as written into the register when the building was filed: unverified, never the land book in force). New kinds of fact may appear; treat an unknown one by its label.
labelstringrequired: The fact's name, for people.
valuestring or number or array of stringrequired: A number (a count, a year, or a quantity in unit), the record's wording, or its wordings.
unitstring or nullrequired: The unit of a quantity: m2 or m3; null for counts, years and wordings.
notestring or nullrequired: How the record defines or qualifies the value; null when it adds nothing.

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.

outline_referencefootprint | roof_edge | combined or nullrequired

What the building's outline, and so footprint_area_m2, traces where the building is drawn from parts: footprint (the walls where they meet the ground), roof_edge (the roof seen from above, eaves included) or combined (parts of both kinds); null where it is not drawn from parts.

partsarray of BuildingPartrequired

The parts the building is drawn from, register parts first, then the largest; empty where it is not drawn from parts.

originregister | unregisteredrequired: register (a construction the building register records) or unregistered (a structure the register does not record; this says nothing of whether it is permitted).
record_referencestring or nullrequired: The register's own reference for the construction's record; null for a part not in the register.
labelstring or nullrequired: How the register names the construction, e.g. 62847-C1; null where it names none.
outline_referencefootprint | roof_edgerequired: What the part's outline traces: footprint (the walls where they meet the ground, as the register surveys them) or roof_edge (the roof seen from above, eaves included).
area_m2numberrequired: The area of the part's outline, in m².

eave_height_mnumber or nullrequired≥ 0

The height of the eaves; null when unknown.

has_3d_modelboolean or nullrequired

Whether a 3D model of the building's roof is on record, reconstructed from a surface model of the roof or from the analysed roof planes; it does not say which. Null when unknown.

addressesBuildingAddresses or any or nullrequired

Every address of the building, each entrance with the dwellings behind it; null when none is on record.

confirmationconfirmed | records_disagree | single_record or nullrequired

confirmed (several records give the shown street the same number), records_disagree (they give it different numbers) or single_record; null when no number was compared.

addressesarray of BuildingAddressrequired

Every address, the shown one first.

linestringrequired: The address written the country's way: street and number, then the block (bl.) and entrance (sc.) where given.
postal_codestring or nullrequired: The address's official postcode where one is known, else the one its record writes; null when none is.
localitystring or nullrequired: The town or village.
entrancestring or nullrequired: The entrance the address names; null for an address that names none.
dwellings_at_entranceinteger or nullrequired≥ 0: The dwellings counted behind this entrance, never the building's total; null for an address that is no entrance or whose dwellings are not counted.
relationshown | same_address | different_number | other_street | another_entrance or nullrequired: shown (the address the building is shown with), same_address (another record gives the shown street the same number), different_number (another record gives the shown street a different number), other_street (the building's front on another street), another_entrance (another entrance or number of the building); null when not compared.

unitsUnitsSummary or any or nullrequired

What the building's record says of its units; null when it neither lists units nor states how many there are.

listedinteger or nullrequired≥ 1

The units the record lists; null when it lists none, which says nothing of how many there are.

listed_dwellingsinteger or nullrequired≥ 0

The dwellings among the listed units; null when none are listed.

statedinteger or nullrequired≥ 0

The units the record states the building has; null when it states no total.

stated_dwellingsinteger or nullrequired≥ 0

The dwellings the record states the building has; null when it states no total.

list_is_completebooleanrequired

True when the record lists units and its list matches every total it states: a unit missing from an incomplete list may still exist.

by_floorarray of FloorUnits or nullrequired

The listed units on each floor, bottom to top; a unit whose floor is not known is on none. Null when no units are listed, never to be read as none.

by_kindarray of UnitKindCount or nullrequired

The listed units of each kind, kinds the list holds none of left out. Null when no units are listed.

entrancesarray of stringrequired

The entrances the listed units are reached by, as the record names them, in reading order.

entrance_dwellingsarray of EntranceDwellingsrequired

The dwellings the record counts behind each entrance; empty when it counts none.

entrancestringrequired: The entrance, by its address as the record writes it.
dwellingsintegerrequired≥ 0: The dwellings counted behind it.

record_sheetRecordSheet or any or nullrequired

The building's whole record as its register lays it out; null when no register record is on file.

existsboolean or nullrequired

False when the record says the building no longer stands; null where the register keeps no such mark.

validatedboolean or nullrequired

Whether the register marks the record checked; null where it keeps no such mark.

cadastral_numberstring or nullrequired

The building's cadastral number, where the record keeps one.

property_numberstring or nullrequired

The property number, where the record keeps one.

land_book_numberstring or nullrequired

Always null: the land book in force is not known. The land book number the register holds, as it was filed, is land_book_number_as_filed.

land_book_number_as_filedstring or nullrequired

The land book number as written into the register when the building was filed, where it holds one. Free text, not checked against the land book in force: often an old paper land book's number ("447 Ocna Dej"), which may since have closed or been renumbered. Never use it to order a land book extract.

read_onstring (date) or nullrequired

The day the record was last read.

sectionsarray of RecordSheetSectionrequired

Every fact on record, by section; empty when the record states none beyond its numbers.

titlestringrequired: The section's title.
rowsarray of RecordSheetRowrequired: The facts in the section.

roof_analysisRoofAnalysis or any or nullrequired

The roof analysis behind solar_potential, plane by plane; null when the roof has not been analysed.

whole_roof_area_m2number or nullrequired≥ 0

The whole roof's area.

ground_area_m2number or nullrequired≥ 0

The ground the analysed roof covers.

peak_sunshine_hours_per_yearnumber or nullrequired≥ 0

Peak sunshine hours a year at the roof.

yearly_irradiance_kwh_per_m2number or nullrequired≥ 0

The solar energy a square metre of the roof receives in a year.

imagery_datestring (date) or nullrequired

The date of the imagery the roof was read from; null when undated or assumed.

imagery_qualitystring or nullrequired

The imagery's quality as the analysis grades it.

confidencenumber or nullrequired0–1

The analysis's confidence, 0 to 1.

planes_are_assumedboolean or nullrequired

True where the planes are an estimate's assumption, false where they were measured, null where unsaid.

roof_surveylidar | image_matching or nullrequired

Where the planes were measured on the building by an open survey: how it measured them, lidar (airborne laser scanning) or image_matching (a point cloud matched from overlapping aerial photographs, which is not lidar). Null where the planes come from no such survey (read from imagery, or assumed) or from a survey baseray does not list.

panel_capacity_wnumber or nullrequired≥ 0

The power of the panel the layout assumes.

panel_width_mnumber or nullrequired≥ 0

The width of that panel.

panel_height_mnumber or nullrequired≥ 0

The height of that panel.

planesarray of RoofPlanerequired

Every plane of the roof, by its number.

planeintegerrequired≥ 1: The number the analysis gives the plane.
facingnorth | north-east | east | south-east | south | south-west | west | north-westrequired: The compass direction the plane faces.
azimuth_degreesnumberrequired: The bearing the plane faces: 0 north, 90 east, 180 south.
pitch_degreesnumberrequired: The plane's slope from the horizontal.
area_m2numberrequired≥ 0: The plane's area.
sunshine_hours_per_yearnumber or nullrequired≥ 0: The sunshine the plane gets in a year; null when not analysed.
panelsintegerrequired≥ 0: Panels the largest layout puts on the plane.

climateClimate or any or nullrequired

The local climate; null when none is on record.

periodsarray of ClimatePeriodrequired

The temperatures, frost and hot days and rainfall per period; a period with no figure on record is left out.

periodlatest_year | recent_average | current_yearrequired: latest_year (the last complete year), recent_average (yearly average over the recent years) or current_year (this year so far, preliminary).
fromstring or nullrequired: Where the period starts: a year, or a date for current_year.
tostring or nullrequired: Where the period ends: a year, or a date for current_year.
data_throughstring (date) or nullrequired: The last day the data covers.
coldest_day_cnumber or nullrequired: The lowest daily temperature, °C.
hottest_day_cnumber or nullrequired: The highest daily temperature, °C.
frost_daysnumber or nullrequired≥ 0: Days below freezing.
hot_daysnumber or nullrequired≥ 0: Hot days.
precipitation_mmnumber or nullrequired≥ 0: Rainfall over the year, mm.
wet_daysnumber or nullrequired≥ 0: Wet days.
wettest_day_mmnumber or nullrequired≥ 0: Rainfall on the wettest day, mm.

heating_degree_daysarray of HeatingDegreeDaysrequired

The heating degree-days per period, the climate normal first; a period not on record is left out.

periodstandard_normal | recent_average | latest_yearrequired: standard_normal (the climate normal), recent_average (yearly average over the recent years) or latest_year (the last complete year).
fromstringrequired: The first year of the period.
tostringrequired: The last year of the period.
degree_daysnumberrequired≥ 0: Heating degree-days, K·d.

temperature_trend_c_per_decadenumber or nullrequired

How fast the location has warmed, °C per decade; null where the trend is not on record or has no clear direction.

energy_networksarray of EnergyNetworkLevelrequired

Gas and district-heating network evidence from the locality down to the building; empty when none is on record.

networknatural_gas | district_heatingrequired: The network.
levellocality | service_area | street | address | buildingrequired: How close to the building the evidence reaches: the locality, the service area, the street, the address or the building's own connection.
presentbooleanrequired: Whether the network is on record at that level.
yearinteger or nullrequired: The year the evidence refers to.

heating_estimateHeatingEstimate or any or nullrequired

The heating estimate, a model estimate; null when the building is not modelled.

useful_heat_kwh_per_yearnumber or nullrequired

The headline: the heat the building needs in a year for space heating, as it was built (insulated or re-glazed since, it needs less).

useful_heat_low_kwh_per_yearnumber or nullrequired

Where the number of floors is not on record: the lowest need over the floor counts the building may have.

useful_heat_high_kwh_per_yearnumber or nullrequired

Where the number of floors is not on record: the highest need over the floor counts the building may have.

useful_heat_kwh_per_m2_per_yearnumber or nullrequired

The heat need per m² of heated floor area.

heated_floor_area_m2number or nullrequired

The heated floor area the need is worked out on.

heated_floor_area_basisstring or nullrequired

What the heated floor area rests on, e.g. register_heated_area or volume_share.

useful_heat_kwh_per_dwelling_per_yearnumber or nullrequired

The heat need of one dwelling on average, where the dwellings are counted.

dwelling_countinteger or nullrequired

The dwellings that figure is per.

delivered_energy_kwh_per_yearnumber or nullrequired

The energy delivered to the heating system for that need.

expected_energy_kwh_per_yearnumber or nullrequired

The energy the building is expected to use for heating.

peak_heat_load_kwnumber or nullrequired

The peak heat load.

peak_heat_load_basisstring or nullrequired

What the peak heat load rests on; screening_estimate is an order of magnitude at the standard winter design temperature of the location.

design_outdoor_temperature_cnumber or nullrequired

The outdoor temperature the peak heat load is worked out at, °C.

hot_water_heat_kwh_per_yearnumber or nullrequired

The heat in the hot water, apart from space heating and in none of the other figures.

hot_water_personsnumber or nullrequired

The people the hot water is worked out for.

hot_water_occupancy_basisstring or nullrequired

Where those people come from: counted_dwellings, one_household or heated_floor_area.

construction_period_is_on_recordboolean or nullrequired

False when the construction period behind the estimate is assumed, not read from the building's own record.

era_scenariosarray of HeatingEraScenariorequired

Where the construction year is not on record: the need under each construction period.

first_yearinteger or nullrequired: The period's first year; null for the earliest.
last_yearinteger or nullrequired: The period's last year; null for the latest.
useful_heat_kwh_per_yearnumberrequired≥ 0: The heat need under that period.
is_takenbooleanrequired: Whether the other figures assume this period.

neighbours_are_measuredboolean or nullrequired

False when the neighbouring buildings were not measured and every wall was taken to face the weather.

neighbour_wall_sharenumber or nullrequired

The share of the walls, 0 to 1, standing against neighbouring buildings; null where they were not measured.

heat_pump_scenariosarray of HeatPumpScenariorequired

The electricity a heat pump would use per seasonal performance factor.

seasonal_performance_factornumberrequired≥ 0: The seasonal performance factor assumed.
electricity_kwh_per_yearnumber or nullrequired≥ 0: The electricity a year.

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.
402: insufficient_credits: the answer's buildings need more credits than the workspace has left this month. Nothing was returned or charged.
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.

Request

curl "https://api.baseray.ai/v1/buildings/c9eefd1b-8c8d-48fe-8b72-e015374d7720" \
  -H "Authorization: Bearer $BASERAY_API_KEY"

const response = await fetch("https://api.baseray.ai/v1/buildings/c9eefd1b-8c8d-48fe-8b72-e015374d7720", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.BASERAY_API_KEY}` },
});
const result = await response.json();

import os
import requests

response = requests.get(
    "https://api.baseray.ai/v1/buildings/c9eefd1b-8c8d-48fe-8b72-e015374d7720",
    headers={"Authorization": f"Bearer {os.environ['BASERAY_API_KEY']}"},
    timeout=30,
)
response.raise_for_status()
result = response.json()

Response 200

{
  "data": {
    "building_id": "c9eefd1b-8c8d-48fe-8b72-e015374d7720",
    "address": "Bulevardul 15 Noiembrie 78",
    "nearest_road": null,
    "address_evidence": "address_record",
    "address_corroboration": "single_source",
    "postal_code": null,
    "locality": "Brașov",
    "country": "RO",
    "latitude": 45.64988,
    "longitude": 25.61044,
    "category": "commercial",
    "category_evidence": "confirmed",
    "building_type": "retail",
    "roof_shape": "flat",
    "footprint_area_m2": 31252,
    "height": {
      "metres": 18,
      "basis": "estimated"
    },
    "volume_m3": 562531,
    "volume_basis": "estimated",
    "floor_area": {
      "square_metres": 500032,
      "basis": "estimated",
      "scope": "gross_above_ground"
    },
    "floors": 16,
    "floors_including_underground": null,
    "construction_year": null,
    "completed_by_year": null,
    "dwellings": null,
    "existing_solar_panels": {
      "status": "none_seen",
      "photo_date": "2022-09-08",
      "confidence": 0.988,
      "analysed_on": null,
      "photo_resolution_cm": null
    },
    "solar_presence": "none_seen",
    "registered_solar": null,
    "solar_potential": null,
    "registered_business_count": 0,
    "registered_business_employees": null,
    "registered_business_turnover": null,
    "flood_zone": null,
    "flood_zone_mapped": false,
    "flood_zone_source": null,
    "seismic_design_acceleration_g": null,
    "seismic_risk_class": null,
    "seismic_risk_assessment_year": null,
    "owner_type": null,
    "app_url": "https://app.baseray.tech/?building=c9eefd1b-8c8d-48fe-8b72-e015374d7720",
    "entrances": null,
    "stated_facts": [],
    "is_current": true,
    "replaced_by_building_id": null,
    "outline_reference": null,
    "parts": [],
    "eave_height_m": null,
    "has_3d_model": null,
    "addresses": {
      "confirmation": "confirmed",
      "addresses": [
        {
          "line": "Strada Memorandumului 28, bl. A, sc. 1",
          "postal_code": "400114",
          "locality": "Cluj-Napoca",
          "entrance": "1",
          "dwellings_at_entrance": 24,
          "relation": "shown"
        }
      ]
    },
    "units": {
      "listed": 118,
      "listed_dwellings": 96,
      "stated": 118,
      "stated_dwellings": 96,
      "list_is_complete": true,
      "by_floor": [
        {
          "floor_kind": "ground",
          "floor_number": null,
          "units": 22,
          "dwellings": 0
        },
        {
          "floor_kind": "upper",
          "floor_number": 1,
          "units": 24,
          "dwellings": 24
        }
      ],
      "by_kind": [
        {
          "kind": "dwelling",
          "units": 96
        },
        {
          "kind": "commercial",
          "units": 4
        },
        {
          "kind": "storage",
          "units": 18
        }
      ],
      "entrances": [
        "A",
        "B"
      ],
      "entrance_dwellings": []
    },
    "record_sheet": {
      "exists": true,
      "validated": true,
      "cadastral_number": "262812-C1",
      "property_number": null,
      "land_book_number": null,
      "land_book_number_as_filed": "1997/N",
      "read_on": "2026-10-06",
      "sections": [
        {
          "title": "Performance",
          "rows": [
            {
              "label": "Heated floor area",
              "value": 2410.5,
              "unit": "m2"
            }
          ]
        }
      ]
    },
    "roof_analysis": null,
    "climate": {
      "periods": [
        {
          "period": "recent_average",
          "from": "2016",
          "to": "2025",
          "data_through": "2025-12-31",
          "coldest_day_c": -14.2,
          "hottest_day_c": 36.8,
          "frost_days": 92.4,
          "hot_days": 31.5,
          "precipitation_mm": 612.3,
          "wet_days": 104.2,
          "wettest_day_mm": 48.6
        }
      ],
      "heating_degree_days": [
        {
          "period": "standard_normal",
          "from": "1991",
          "to": "2020",
          "degree_days": 3202
        }
      ],
      "temperature_trend_c_per_decade": 0.48
    },
    "energy_networks": [
      {
        "network": "natural_gas",
        "level": "street",
        "present": true,
        "year": 2024
      }
    ],
    "heating_estimate": {
      "useful_heat_kwh_per_year": 182000,
      "useful_heat_low_kwh_per_year": null,
      "useful_heat_high_kwh_per_year": null,
      "useful_heat_kwh_per_m2_per_year": 75.5,
      "heated_floor_area_m2": 2410.5,
      "heated_floor_area_basis": "register_heated_area",
      "useful_heat_kwh_per_dwelling_per_year": 7583,
      "dwelling_count": 24,
      "delivered_energy_kwh_per_year": 214000,
      "expected_energy_kwh_per_year": 196000,
      "peak_heat_load_kw": 96.4,
      "peak_heat_load_basis": "screening_estimate",
      "design_outdoor_temperature_c": -15,
      "hot_water_heat_kwh_per_year": 41000,
      "hot_water_persons": 52.8,
      "hot_water_occupancy_basis": "counted_dwellings",
      "construction_period_is_on_record": true,
      "era_scenarios": [],
      "neighbours_are_measured": true,
      "neighbour_wall_share": 0.18,
      "heat_pump_scenarios": [
        {
          "seasonal_performance_factor": 3,
          "electricity_kwh_per_year": 60667
        }
      ]
    }
  }
}

One building

Path parameters

Response 200

Errors

Cookies