Atoka API User Reference

Real Estate package "Base"

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
address.fullAddress

complete address of this real estate

"string" -
address.macroregion

macro region for this real estate

"string" -
address.municipality

municipality for this real estate

"string" -
address.province

province for this real estate

"string" -
address.provinceCode

code of the province for this real estate

"string" -
address.region

region for this real estate

"string" -
address.state

state for this real estate

"string" -
address.streetName

name of the street where the real estate is

"string" -
cadastralInfo.administrativeSection

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

(available only for buildings)

"string" -
cadastralInfo.agrarianIncome

"Rendita Agraria"

Parte del reddito medio ordinario dei terreni imputabile al capitale di esercizio e al lavoro di organizzazione impiegati, nei limiti della potenzialità del terreno, nell’esercizio delle attività agricole. È correlato alla qualità del terreno e alla sua produttività media ordinaria

(available only for plots of land)

float -
cadastralInfo.cadastralCode

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

"string" -
cadastralInfo.category

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" -
cadastralInfo.categoryCode

Cadastral category code

(available only for buildings)

"string" -
cadastralInfo.censusSection

"Sezione Censuaria"

(available only for plots of land)

"string" -
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 repartition in classes for the category (when the profitability is homogeneous in the cadastral area). The value are from 1 to n where 1 represents the higher profitability

"string" -
cadastralInfo.farmlandIncome

"Rendita Dominicale"

Parte del reddito medio ordinario ritraibile dall’esercizio delle attività agricole, che spetta al proprietario del terreno. È correlato alla qualità del terreno e alla sua produttività media ordinaria

(available only for plots of land)

float -
cadastralInfo.floor

Cadastral floor ("piano") of the real estate

(available only for buildings)

"string" -
cadastralInfo.income

Cadastral income ("rendita"), aka the fiscal value of the real estate

(available only for buildings)

float -
cadastralInfo.layout

Cadastral layout ("foglio") of the real estate

"string" -
cadastralInfo.lot

Cadastral lot ("particella") of the real estate

"string" -
cadastralInfo.lotDenominator

("denominatore particella")

"string" -
cadastralInfo.subLot

Cadastral "subalterno" of the real estate

int -
cadastralInfo.updateTime

last update time

date -
cadastralInfo.urbanSection

"Sezione Urbana"

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

(available only for buildings)

"string" -
estimation.averageMax

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

float -
estimation.averageMin

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

float -
estimation.optimalMax

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

float -
estimation.optimalMin

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

float -
estimation.poorMax

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

float -
estimation.poorMin

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

float -
landType

description of the type of land (e.g. "Uliveto")

only for plots of land

- -
size.details.are

Size of the plot of land: are size

int -
size.details.centiare

Size of the plot of land: centiare size

int -
size.details.hectare

Size of the plot of land: hectare size

int -
size.details.portionCode

In caso di terreno porzionato è il codice identificativo della porzione in cui è suddiviso il terreno

"string" -
size.unit

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

"string" -
size.value

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

float -
type

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

- -
Example JSON fragment for package
{
"type": "foo",
"landType": "foo",
"address": {
"fullAddress": "foo",
"streetName": "foo",
"municipality": "foo",
"province": "foo",
"provinceCode": "foo",
"region": "foo",
"macroregion": "foo",
"state": "foo"
},
"size": {
"value": 0.42,
"unit": "foo",
"details": {
"hectare": 42,
"are": 42,
"centiare": 42,
"portionCode": "foo"
}
},
"cadastralInfo": {
"updateTime": "2015-12-24",
"layout": "foo",
"lot": "foo",
"classCode": "foo",
"lotDenominator": "foo",
"subLot": 42,
"agrarianIncome": 0.42,
"farmlandIncome": 0.42,
"censusSection": "foo",
"categoryCode": "foo",
"category": "foo",
"floor": "foo",
"urbanSection": "foo",
"administrativeSection": "foo",
"income": 0.42,
"cadastralCode": "foo"
},
"estimation": {
"poorMin": 0.42,
"poorMax": 0.42,
"averageMin": 0.42,
"averageMax": 0.42,
"optimalMin": 0.42,
"optimalMax": 0.42
}
}