Atoka API User Reference

People package "Real Estate"

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 realEstate
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 -
items[]

list of companies this person has positions in

- -
items[].base.address.fullAddress

complete address of this real estate

"string" -
items[].base.address.macroregion

macro region for this real estate

"string" realEstateMacroregions
items[].base.address.municipality

municipality for this real estate. It also corresponds to the cadastral muncipality ("Comune Catastale")

"string" realEstateMunicipalities
items[].base.address.province

province for this real estate

"string" realEstateProvinces
items[].base.address.provinceCode

code of the province for this real estate

"string" -
items[].base.address.region

region for this real estate

"string" realEstateRegions
items[].base.address.state

state for this real estate

"string" -
items[].base.address.streetName

name of the street where the real estate is

"string" -
items[].base.cadastralInfo.administrativeSection

Cadastral "Sezione Amministrativa", could be any of {"Q", "A", "R", "S", "B", "C", "D", "E", "P"}

(available only for buildings)

"string" realEstateAdministrativeSection
items[].base.cadastralInfo.cadastralCode

Identifier for Italian municipalities and foreign countries in the cadastre. Composed of 1 letter + 3 digits.

"string" -
items[].base.cadastralInfo.category.code

Cadastral category code; available only for buildings

"string" realEstateCategory
items[].base.cadastralInfo.category.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" -
items[].base.cadastralInfo.censusSection

"Sezione Censuaria"

(available only for plots of land)

"string" realEstateCensusSection
items[].base.cadastralInfo.classCode

Parameter that identifies the level of productivity of lots (cultivated or buildings of category A, B and C). The value U represent absence of ripartition in classes for the category (when the profitability is homogeneous in the cadastral area).

"string" realEstateClassCode
items[].base.cadastralInfo.layout

Cadastral layout ("foglio") of the real estate

"string" realEstateLayout
items[].base.cadastralInfo.lot

Cadastral lot ("particella") of the real estate

"string" realEstateLot
items[].base.cadastralInfo.lotDenominator

("Denominatore particella")

"string" realEstateLotDenominator
items[].base.cadastralInfo.subLot

Cadastral "subalterno" of the real estate

int realEstateSubLot
items[].base.cadastralInfo.updateTime

last update time

date -
items[].base.cadastralInfo.urbanSection

"Sezione Urbana"

Further division of the municipal territory, exists only for some muncipalities

(available only for buildings)

"string" realEstateUrbanSection
items[].base.estimation.average.max Private field

Estimated value for the real estate. This field represents the maximum value estimated in case the building is in normal conditions

float realEstateEstimationMin realEstateEstimationMax realEstateEstimationAverageMin realEstateEstimationAverageMax
items[].base.estimation.average.min Private field

Estimated value for the real estate. This field represents the minimum value estimated in case the building is in normal conditions

float realEstateEstimationMin realEstateEstimationMax realEstateEstimationAverageMin realEstateEstimationAverageMax
items[].base.estimation.optimal.max Private field

Estimated value for the real estate. This field represents the maximum value estimated in case the building is in optimal conditions

float realEstateEstimationMin realEstateEstimationMax realEstateEstimationOptimalMin realEstateEstimationOptimalMax
items[].base.estimation.optimal.min Private field

Estimated value for the real estate. This field represents the minimum value estimated in case the building is in optimal conditions

float realEstateEstimationMin realEstateEstimationMax realEstateEstimationOptimalMin realEstateEstimationOptimalMax
items[].base.estimation.overall.max Private field

Estimated value for the real estate. This field represents the maximum value estimated no matter the building conditions

float realEstateEstimationMin realEstateEstimationMax
items[].base.estimation.overall.min Private field

Estimated value for the real estate. This field summarizes the minimum value estimated no matter the building conditions

float realEstateEstimationMin realEstateEstimationMax
items[].base.estimation.poor.max Private field

Estimated value for the real estate. This field represents the maximum value estimated in case the building is in poor conditions

float realEstateEstimationMin realEstateEstimationMax realEstateEstimationPoorMin realEstateEstimationPoorMax
items[].base.estimation.poor.min Private field

Estimated value for the real estate. This field represents the minimum value estimated in case the building is in poor conditions

float realEstateEstimationMin realEstateEstimationMax realEstateEstimationPoorMin realEstateEstimationPoorMax
items[].base.type

the real estate type, can be either a building (building) or a plot of land (plotOfLand).

"string" realEstate
items[].id

Unique ID that you can use throughout the API endpoints to reference to a specific real estate

"string" -
items[].owner.entitlement[].code

code of type of entitlement

int realEstateEntitlement
items[].owner.entitlement[].label

Type of property (e.g. "Proprietà", "Usufrutto", ...)

"string" -
items[].owner.ratio

Ratio of ownership

float realEstateRatio
items[].size.unit

unit of measure for the value, Could be any of: mq (square meters), vn (rooms), mc (cubic meters)

"string" -
items[].size.value

Size of the real estate, to be considered in combination with unit

float -
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
realEstate

total number of real estate to which the subject has rights (whether ownership, usufruct, etc.)

int realEstate
Example JSON fragment for package
{
"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
},
"items": [
{
"id": "foo",
"base": {
"type": "foo",
"address": {
"fullAddress": "foo",
"streetName": "foo",
"municipality": "foo",
"province": "foo",
"provinceCode": "foo",
"region": "foo",
"macroregion": "foo",
"state": "foo"
},
"cadastralInfo": {
"updateTime": "2015-12-24",
"administrativeSection": "foo",
"censusSection": "foo",
"urbanSection": "foo",
"layout": "foo",
"lot": "foo",
"lotDenominator": "foo",
"subLot": 42,
"cadastralCode": "foo",
"category": {
"label": "foo",
"code": "foo"
},
"classCode": "foo"
},
"estimation": {
"poor": {
"min": 0.42,
"max": 0.42
},
"average": {
"min": 0.42,
"max": 0.42
},
"optimal": {
"min": 0.42,
"max": 0.42
},
"overall": {
"min": 0.42,
"max": 0.42
}
}
},
"owner": {
"entitlement": [
{
"label": "foo",
"code": 42
},
...
],
"ratio": 0.42
},
"size": {
"value": 0.42,
"unit": "foo"
}
},
...
]
}