Buildings

A building's units

The units a building's record lists (flats, shops, parking spaces, storage), each with its number, name or door, its floor as the record words it and as a kind and number, and its entrance, kind, use, area, rooms and cadastral number where the record states them. unit finds units by their number or name ("275" finds 275, "Ap. 275" and "Parcare 275", never 1275); without it the list comes a page at a time. meta.list_is_complete is false when the record states a total that differs from its list: a unit missing from the list may then still exist. A building with no units listed has unknown units, never none. Costs what opening the building costs: free once opened.

get/buildings/{building_id}/units

Request

  • Base URL: https://api.baseray.ai/v1
  • URL: https://api.baseray.ai/v1/buildings/{building_id}/units
  • Auth: HTTP bearer

Path parameters

building_idstring uuid required

The building's baseray id, a UUID returned by the other building endpoints.

Query parameters

unitstring

The number or name of the unit(s) to find, e.g. 275, 12A or Parcare 3; 1 to 100 characters.

limitinteger

Units per page, 1 to 500. Default 200.

offsetinteger

Matched units to skip, 0 to 100,000. Default 0.

Response

OK

Example response

{
  "data": [
    {
      "designation": "275",
      "floor": "ETAJ 7",
      "floor_kind": "upper",
      "floor_number": 7,
      "entrance": "B",
      "kind": "dwelling",
      "use": "locuinta",
      "area_m2": 54.2,
      "rooms": 2,
      "cadastral_number": null
    }
  ],
  "meta": {
    "listed": 736,
    "stated": 736,
    "list_is_complete": true,
    "matched": 1,
    "limit": 200,
    "offset": 0
  },
  "links": {
    "next": null
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.