Skip to content
Sign in Sign up

One building's 3D model

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

What one building that has a public page is drawn in 3D from. A shell is served (lod2) only where it was measured from open data, with the credit its licence asks for; a shell measured from paid imagery never is. Otherwise the outline is raised to the height the page shows (extruded), or drawn flat where the page shows none (flat): no height is ever guessed. Any other building answers 404, as its page does.

Path parameters

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

Response 200

OK

buildingIdstring (uuid)required
The building's baseray id.
kindlod2 | extruded | flatrequired
lod2: a shell measured from open data, in mesh. extruded: raise outline to heightM. flat: draw outline flat; no height is known.
heightMnumber or nullrequired
The height the building's public page shows, in metres; null where it shows none.
heightOnRecordbooleanrequired
False where heightM is an estimate, or null.
sourcePublicModel3DSource or any or nullrequired
Set for lod2 only.
labelstringrequired
The open dataset the shell was measured from, as its credit names it.
licencestringrequired
The licence the dataset is published under, as people write it (CC BY 4.0).
urlstring (uri)required
The publisher's page of the dataset.
outlinearray of array of numberrequired
The outer ring as [x, y] positions, counter-clockwise, without a closing position.
holesarray of array of array of numberrequired
Courtyards, each a clockwise ring like outline.
meshPublicModel3DMesh or any or nullrequired
Set for lod2 only.
verticesarray of array of numberrequired
[x, y, z] positions in metres, in the frame of outline.
facesarray of array of integerrequired
Triangles, each three indices into vertices.

Errors

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.