Atoka API User Reference
People package "Real Estate"
Regarding the `connectedSubjects` field, only individuals with direct ownership of at least 25 percent of the company are considered connected subjects; only subjects with these characteristics are considered when calculating the counts shown in this field. Moreover, real estate related to more than one connected subject are counted only once when calculating the counts.
API tokens are configured to access only the packages each user needs; this means you might not have access to the content of this package. Ask your sales contact!
Available fields | Description | Data | Used by filters | Facet | Match | Stats |
|---|---|---|---|---|---|---|
| buildings | total number of buildings to which the subject has rights (whether ownership, usufruct, etc.) | int | - | |||
| buildingsCommercial | total number of commercial buildings to which the subject has rights (whether ownership, usufruct, etc.) | int | - | |||
| buildingsResidential | total number of residential buildings to which the subject has rights (whether ownership, usufruct, etc.) | int | - | |||
| categories[] | - | realEstateCategories realEstateCategoriesExclude | ||||
| categories[].code | Cadastral category code; available only for buildings | "string" | - | |||
| categories[].label | Cadastral category name; textual description of the cadastral real estate category, which indicates the type of real estate units present in the area, different for intrinsic characteristics that determine its ordinary and permanent destination; available only for buildings | "string" | - | |||
| connectedSubjects.buildings Private field | total number of buildings to which the connected subjects have rights (whether ownership, usufruct, etc.) | int | - | |||
| connectedSubjects.buildingsCommercial Private field | total number of commercial buildings to which the connected subjects have rights (whether ownership, usufruct, etc.) | int | - | |||
| connectedSubjects.buildingsResidential Private field | total number of residential buildings to which the connected subjects have rights (whether ownership, usufruct, etc.) | int | - | |||
| connectedSubjects.items[].id Private field | atoka ID of the person connected to this company | "string" | - | |||
| connectedSubjects.items[].name Private field | full name of the person | "string" | - | |||
| connectedSubjects.items[].relationType Private field | type of relationship the person has with the company | "string" | - | |||
| connectedSubjects.ownerships.buildings Private field | total number of buildings the connected subjects own (fully or partially) | int | - | |||
| connectedSubjects.ownerships.buildingsEstimation.valueMax Private field | maximum estimate of the total value of buildings owned by the connected subjects, weighted by percentage of ownership, assuming they are in normal condition | float | - | |||
| connectedSubjects.ownerships.buildingsEstimation.valueMin Private field | minimum estimate of the total value of buildings owned by the connected subjects, weighted by percentage of ownership, assuming they are in normal condition | float | - | |||
| connectedSubjects.ownerships.plotsOfLand Private field | total number of plots of land the connected subjects owns (fully or partially) | int | - | |||
| connectedSubjects.ownerships.plotsOfLandSize Private field | total area of land owned by the connected subjects, taking into account the percentage of ownership, in centiare | float | - | |||
| connectedSubjects.plotsOfLand Private field | total number of plots of land to which the connected subjects have rights (whether ownership, usufruct, etc.) | int | - | |||
| connectedSubjects.realEstate Private field | total number of real estate to which the connected subjects have rights (whether ownership, usufruct, etc.) | int | - | |||
| ownerships.buildings | total number of buildings the subject owns (fully or partially) | int | - | |||
| ownerships.buildingsEstimation.valueMax | maximum estimate of the total value of buildings owned by the subject, weighted by percentage of ownership, assuming they are in normal condition | float | - | |||
| ownerships.buildingsEstimation.valueMin | minimum estimate of the total value of buildings owned by the subject, weighted by percentage of ownership, assuming they are in normal condition | float | - | |||
| ownerships.plotsOfLand | total number of plots of land the subject owns (fully or partially) | int | - | |||
| ownerships.plotsOfLandSize | total area of land owned by the subject, taking into account the percentage of ownership, in centiare | float | - | |||
| plotsOfLand | total number of plots of lands to which the subject has rights (whether ownership, usufruct, etc.) | int | - | |||
| realEstate | total number of real estate to which the subject has rights (whether ownership, usufruct, etc.) | int | - |
Example JSON fragment for package
{"categories": [{"label": "foo", "code": "foo" },...],"realEstate": 42, "buildings": 42, "buildingsCommercial": 42, "buildingsResidential": 42, "plotsOfLand": 42, "ownerships": {"buildings": 42, "buildingsEstimation": {"valueMin": 0.42, "valueMax": 0.42 },"plotsOfLand": 42, "plotsOfLandSize": 0.42 },"connectedSubjects": {"items": [{"id": "foo", "name": "foo", "relationType": "foo" },...],"realEstate": 42, "buildings": 42, "buildingsCommercial": 42, "buildingsResidential": 42, "plotsOfLand": 42, "ownerships": {"buildings": 42, "buildingsEstimation": {"valueMin": 0.42, "valueMax": 0.42 },"plotsOfLand": 42, "plotsOfLandSize": 0.42 }}}