Skip to content
Sign in Sign up

One building's public page

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

The public facts of one building that has a public page: in Czechia an addressed building whose register gives its floors, completion date and use; in Romania an addressed building whose register gives at least two of floors, construction year and floor area. Any other building answers 404. A retired building whose replacement has a public page answers 301: its page moved for good to that one.

Path parameters

building_idstring (uuid)required
The building's baseray id.

Response 200

OK

idstring (uuid)required
The building's baseray id, the same as in the rest of this API.
countrycz | dk | rorequired
slugstringrequired
A readable slug for the building's page URL, from its locality and address.
addressPublicBuildingAddressrequired
The building's address, from an address record.
streetstring or nullrequired
Street name; null for a village address without streets.
numberstring or nullrequired
House number as the address record writes it.
localitystring or nullrequired
Town or village.
districtstring or nullrequired
City district or sector, where the place has them.
countystring or nullrequired
County (Romanian județ, Czech kraj).
postcodestring or nullrequired
Postcode; null when none is on record.
labelstringrequired
The full address on one line, as it is written locally.
factsPublicBuildingFactsrequired
Each fact is its value or null (unknown, never zero), and says whether it is an estimate.
usePublicUseFact or any or nullrequired
What the building is used for.
valuestring or nullrequired
Use code, e.g. residential_multi; null when unknown.
labelstring or nullrequired
The use in the country's own words, e.g. Bytový dům.
estimatebooleanrequired
True when the value is modelled rather than taken from a record or a measurement.
floorsPublicFloorsFact or any or nullrequired
Floors.
valueinteger or nullrequired
Floors; null when unknown.
estimatebooleanrequired
True when the value is modelled rather than taken from a record or a measurement.
includesUndergroundbooleanrequired
True when the count includes floors below ground.
builtPublicBuiltFact or any or nullrequired
When it was built.
yearinteger or nullrequired
Year of completion; null when only the era is known or nothing is.
erastring or nullrequired
The period it was built in, e.g. 1919–1945, where the record gives a period rather than a year.
estimatebooleanrequired
True when the value is modelled rather than taken from a record or a measurement.
footprintAreaPublicAreaFact or any or nullrequired
Area of the building's footprint.
valuenumber or nullrequired
Area in m²; null when unknown.
unitm2required
estimatebooleanrequired
True when the value is modelled rather than taken from a record or a measurement.
floorAreaPublicFloorAreaFact or any or nullrequired
Floor area.
valuenumber or nullrequired
Floor area in m²; null when unknown.
unitm2required
scopeusable | gross or nullrequired
usable (the usable floor area) or gross (the built floor area); null when unknown.
estimatebooleanrequired
True when the value is modelled rather than taken from a record or a measurement.
heightPublicHeightFact or any or nullrequired
Height.
valuenumber or nullrequired
Height in metres; null when unknown.
unitmrequired
estimatebooleanrequired
True when the value is modelled rather than taken from a record or a measurement.
volumePublicVolumeFact or any or nullrequired
Volume above ground.
valuenumber or nullrequired
Volume in m³; null when unknown.
unitm3required
estimatebooleanrequired
True when the value is modelled rather than taken from a record or a measurement.
roofAreaPublicAreaFact or any or nullrequired
Roof area.
valuenumber or nullrequired
Area in m²; null when unknown.
unitm2required
estimatebooleanrequired
True when the value is modelled rather than taken from a record or a measurement.
roofShapePublicTextFact or any or nullrequired
Roof shape, e.g. flat or gabled.
valuestring or nullrequired
The value; null when unknown.
estimatebooleanrequired
True when the value is modelled rather than taken from a record or a measurement.
dwellingsPublicCountFact or any or nullrequired
Dwellings.
valueinteger or nullrequired
The count; null when unknown.
estimatebooleanrequired
True when the value is modelled rather than taken from a record or a measurement.
floodZonePublicFloodZone or any or nullrequired
The flood zone; null when the building lies in none on record or it is unknown.
valuestringrequired
The flood zone the building lies in.
estimatefalserequired
Always false: the value is taken from an official map.
seismicZonePublicSeismicZone or any or nullrequired
The seismic zone; null where the country has no seismic zoning on record.
designAccelerationGnumberrequired
The design ground acceleration of the building's seismic zone, in g.
estimatefalserequired
Always false: the value is taken from an official map.
cadastralRefPublicCadastralReference or any or nullrequired
The building's official identifier (cadastral number or building code).
valuestringrequired
The building's official identifier (cadastral number or building code).
officialUrlstring or nullrequired
The register's own public page for the building, where it has one.
outlinePublicPolygonrequired
The building's outline as a GeoJSON Polygon.
typePolygonrequired
coordinatesarray of array of array of numberrequired
GeoJSON rings of [longitude, latitude] positions in WGS84; the first ring is the outline, any further ones holes.
centroidarray of numberrequired
[longitude, latitude] of the outline's centre, WGS84.
contextPublicBuildingContextrequired
How the building compares with its street and locality; null where too little is known.
streetBuildingsinteger or nullrequired
Buildings on the same street.
olderThanShareOnStreetnumber or nullrequired
Share (0–1) of the street's buildings with a known age that this building is older than.
tallerThanShareInLocalitynumber or nullrequired
Share (0–1) of the locality's buildings with a known height that this building is taller than.
placePublicPlaceReference or any or nullrequired
The place whose statistics page the building belongs to; null when it belongs to none.
countrycz | dk | rorequired
slugstringrequired
The place's slug, for /public/places/{country}/{slug}/stats.
namestringrequired
The place's name.
streetPageobject or any or null
The page of the building's street; null where its street has none.
slugstringrequired
For /public/places/{country}/{slug}/streets/{street}, with the place's slug.
namestringrequired
gatedPublicGatedCountsrequired
What signing in shows, as counts only.
solarCheckedbooleanrequired
True when the roof has been checked for solar panels; the verdict is shown only after signing in.
registeredCompaniesintegerrequired
Companies with their registered office at the address; who they are is shown only after signing in. A registered office is not ownership.
updatedAtstring (date)required
When the building's facts last changed.
streetarray of PublicNeighbourBuilding
Other buildings with a public page on the same street of the same locality, closest house numbers first; empty without a street.
idstring (uuid)required
countrycz | dk | rorequired
slugstringrequired
Not unique: always put the id in URLs.
labelstringrequired
Its one-line address, as on its page.
numberstring or nullrequired
usestring or nullrequired
The register's own wording of its use, in the local language; null where unknown.
floorsobject or any or nullrequired
valueintegerrequired
includesUndergroundbooleanrequired
builtobject or any or nullrequired
yearinteger or nullrequired
erastring or nullrequired
distanceMnumber
Metres between the two outlines; only in nearby.
nearbyarray of PublicNeighbourBuilding
The closest other buildings with a public page off that street (within about 600 m), nearest first, each with distanceM.
idstring (uuid)required
countrycz | dk | rorequired
slugstringrequired
Not unique: always put the id in URLs.
labelstringrequired
Its one-line address, as on its page.
numberstring or nullrequired
usestring or nullrequired
The register's own wording of its use, in the local language; null where unknown.
floorsobject or any or nullrequired
valueintegerrequired
includesUndergroundbooleanrequired
builtobject or any or nullrequired
yearinteger or nullrequired
erastring or nullrequired
distanceMnumber
Metres between the two outlines; only in nearby.
surroundingsarray of PublicSurroundingOutline
Outlines of every building within about 65 m of this one, with or without a public page, nearest first.
outlinePublicPolygonrequired
The building's outline as a GeoJSON Polygon.
typePolygonrequired
coordinatesarray of array of array of numberrequired
GeoJSON rings of [longitude, latitude] positions in WGS84; the first ring is the outline, any further ones holes.
idstring (uuid) or nullrequired
Set only where that building has a public page.
slugstring or nullrequired
sameStreetbooleanrequired
Its address names the same street in the same locality.

Errors

301
The building was retired and replaced: its page moved for good to the page of the building that replaced it, which Location and the body name. Kept an hour, like a refusal, so a replacement that gains or loses its page is followed within the hour.
404
No such page (not_found).
429
Too many requests from this address in a minute (rate_limited); retry after Retry-After seconds.
503
The building catalogue is unavailable right now (unavailable); retry after Retry-After seconds.

Every error has the same shape. Error codes.