All requests must be properly authenticated; see the Authentication section for more info
curl -G "https://api.atoka.io/v2/realestate"
Debug
Use these parameters when you need to understand how your request was evaluated by the API.
Parameters
explain boolean, default is false
When using this parameter in your request you'll get and additional property in the results explanation, that contains all the filters actually used during the query.
By default this API endpoint returns the list of real estate matching the selected criteria.
Using these parameters, you'll be able to customize the output you'll get from your searches.
Parameters
fields array, default is items
Get just the list of real estate matched, or the search facets (or both!).
If you set this to value none, you'll get just the meta object, with count of real estate matching your search criteria.
Accepts multiple values, separated with , (comma) char: will match on any value (logic OR).
Possible values are:
items
facets
none
facetFields array
We want to keep our API as fast as possible, but facets are expensive to compute. To avoid slowing things down, you must explicitly state which facets you want when you request them. We want to make your life as simple as possible, though, that's why we support wildcards to be used in here; with them you will be able to have an initial look at the data, and to explicitly specify the facets you need once you start developing your application.
This field is required when requesting the search facets through the fields parameter
Accepts multiple values, separated with , (comma) char: will match on any value (logic OR).
Possible values are:
* Enable all the facets of all the requested packages
base.* Enable all the facets of the package "base"
This parameter allows you to control the information you want to retrieve about each real estate.
If you have special needs and want to further customize the data returned, we can adapt the output to your specific needs: just get in touch with us at sales@atoka.io.
Parameters
packages array
Fine tune the results to the level of detail your application actually requires.
The extraction cost per single real estate will be multiplied to the number of results in your query (up to offset parameter value).
To avoid using any package, don't pass this parameter and the results will contain just the Atoka Real Estate ID (and little more).
Accepts multiple values, separated with , (comma) char: will match on any value (logic OR).
Possible values are:
base
owners
* (use all the data packages you have an active subscription for)
Accepts multiple values, separated with , (comma) char.
curl -G "https://api.atoka.io/v2/realestate"
Response
The response of the real estate
{
"items": [
{
"id": "6da785b3adf219770c9e",
"fullAddress": "foo",
"cervedId": 2044622,
"base": {
"type": "foo",
"landType": "foo",
"address": {
"fullAddress": "foo",
"streetNumber": "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
}
...click to expand...},
"owners": {
"owners": [
{
"id": "foo",
"cervedId": 0.42,
"label": "foo",
"company": false,
"entitlement": "foo",
"regime": "foo",
"ratio": 0.42
},
...
]
...click to expand...}
},
...
],
"facets": {
"base": {
"type": {
"count": 35,
"selected": true,
"included": [
{
"id": "object id",
"count": 15,
"label": "included value"
},
...
],
"facets": [
{
"id": "object id",
"count": 23,
"label": "example value"
},
...
]
...click to expand...},
"landType": {
"count": 35,
"selected": true,
"included": [
{
"id": "object id",
"count": 15,
"label": "included value"
},
...
],
"facets": [
{
"id": "object id",
"count": 23,
"label": "example value"
},
...
]
...click to expand...},
"address": {
"municipality": {
"count": 35,
"selected": true,
"included": [
{
"id": "object id",
"count": 15,
"label": "included value"
},
...
],
"facets": [
{
"id": "object id",
"count": 23,
"label": "example value"
},
...
]
...click to expand...},
"province": {
"count": 35,
"selected": true,
"included": [
{
"id": "object id",
"count": 15,
"label": "included value"
},
...
],
"facets": [
{
"id": "object id",
"count": 23,
"label": "example value"
},
...
]
...click to expand...},
"region": {
"count": 35,
"selected": true,
"included": [
{
"id": "object id",
"count": 15,
"label": "included value"
},
...
],
"facets": [
{
"id": "object id",
"count": 23,
"label": "example value"
},
...
]
...click to expand...},
"macroregion": {
"count": 35,
"selected": true,
"included": [
{
"id": "object id",
"count": 15,
"label": "included value"
},
...
],
"facets": [
{
"id": "object id",
"count": 23,
"label": "example value"
},
...
]
...click to expand...}
}
...click to expand...}
},
"explanation": {
"fields": [
"items",
...
],
"packages": [
"base",
...
],
"countries": [
"it",
...
]
...click to expand...},
"queryExplanation": [
{
"engine": "foo",
"text": "foo",
"json": {"foo": "bar"}
},
...
],
"meta": {
"ordering": "default",
"count": 57,
"limit": 10,
"offset": 30,
"info": [
"foo",
...
]
}
}
Real Estate Details
Show full details of a real estate item.
By default we show all information available using all the data packages you subscribed to. Use the package parameter to fine tune the output format.
If you have special needs and want to further customize the data returned, we can adapt the output to your specific needs: just get in touch with us at sales@atoka.io.
https://api.atoka.io/v2/realestate/{id}
Replace {id} with The Atoka Real Estate ID you want details for (as returned by the [Real Estate Search](#realestate) API endpoint. .
All requests must be properly authenticated; see the Authentication section for more info
curl -G "https://api.atoka.io/v2/realestate/{id}"
Response
By default this API endpoint returns the list of real estate matching the selected criteria.
Using these parameters, you'll be able to customize the output you'll get from your searches.
Parameters
allowExpensive array
Some fields could expensive to be computed and returned; either they are computationally costly (like calling and external API), or they are charged extra fees, or both. Such fields must be explicitly enabled through this parameter.
Accepts multiple values, separated with , (comma) char: will match on any value (logic OR).
Differently from the Real Estate Search API, by default here in the Real Estate Details API we will return all the information you are allowed to see; this may become expensive, of course.
To avoid getting data you don't need, you can use the packages parameter to fine tune the results to the level your application actually requires; if you want to explicitly get all the data, feel free you use our preferred wildcard: packages=*.
Remember: your subscription gives you access to different levels of detail in data returned!
If you have special needs and want to further customize the data returned, we can adapt the output to your specific needs: just get in touch with us at sales@atoka.io.
Remember: your subscription gives you access to different levels of detail in data returned!
Parameters
packages array, default is *
By using this parameter you can fine tune the results to the level of detail your application actually requires.
Accepts multiple values, separated with , (comma) char: will match on any value (logic OR).
Possible values are:
base
owners
* use all the data packages you have an active subscription for
Use these parameters when you need to understand how your request was evaluated by the API.
Parameters
explain boolean, default is false
When using this parameter in your request you'll get and additional property in the results explanation, that contains all the filters actually used during the query.