Introduction

Prev Next

Real estate objects v1

This API provides comprehensive support for managing real estate objects within Bloxs. It enables external systems to create, retrieve and update real estate objects, including buildings, complexes, sections, and units.

In addition to core CRUD functionality, the API supports:

Buildings

  • Retrieve Key register Addresses and Buildings (in Dutch: Basisregistratie Adressen en Gebouwen, BAG) information for buildings;

  • Retrieve object categories for buildings;

  • Retrieve theoretical rent values for buildings;

  • Retrieve initial cost values for buildings.

Complexes

  • Retrieve Key register Addresses and Buildings (in Dutch: Basisregistratie Adressen en Gebouwen, BAG) information for complexes;

  • Retrieve object categories for complexes;

  • Retrieve initial cost values for complexes.

Sections

  • Retrieve Key register Addresses and Buildings (in Dutch: Basisregistratie Adressen en Gebouwen, BAG) information for sections;

  • Retrieve object categories for sections.

Units

  • Retrieve Key register Addresses and Buildings (in Dutch: Basisregistratie Adressen en Gebouwen, BAG) information for units;

  • Retrieve object categories for units;

  • Retrieve theoretical rent values for units;

Generic

  • Retrieve and update energy labels for real estate objects;

  • Retrieve, add and delete values for real estate objects;

  • Retrieve and add scoring point totals (in Dutch: Puntentelling) for real estate objects;

  • Managing property definitions used in the publication process for real estate objects, including:

    • Retrieve publication data for real estate objects;

    • Retrieve images from publication data for real estate objects;

    • Update publication data for real estate objects;

    • Retrieve published real estate objects (filtered and paged).

Admin settings

  • Retrieve energy labels available for real estate objects;

  • Retrieve value types available for real estate objects;

  • Retrieve extra relation types available for real estate objects;

  • Retrieve regions available for real estate objects;

  • Retrieve, add, update and delete property definitions available for publication process for real estate objects;

Real estate object types

Buildings
A building is a standalone rentable object, such as a row house or an entire building that is not subdivided into multiple rentable parts. A building can be included in a rental contract. If a property contains multiple rentable units, it should be structured as a complex with units instead of a single building.

Complexes
A complex is a collection of rentable units. These units are often located under one roof, but this is not always the case. A complex consists of one or more units and can optionally be divided into sections. Units within a complex can be included in rental contracts.

Sections
A section is an optional subdivision within a complex, used to separate different functional or physical parts of a property, such as floors, blocks, or usage types (for example commercial versus residential). Correct section configuration is important, as sections form part of the object structure in Bloxs and directly impact cost allocation, reporting, service cost settlements, and service tickets. Examples include a complex with a shop on the ground floor and apartments above, or a large apartment complex where each floor is defined as a separate section.

Units
A unit is an individual rentable part of a larger property and can be included in a rental contract. A unit always belongs to a complex and may optionally belong to a section. Examples include a room in a student house or an apartment within a townhouse.

Authorization

To access the API, include your API key in the request headers. For details on how to obtain and use your API key, refer to the Authorization documentation.