Search Data
POST /api/search-data
Market demand information.
Example Request
curl --location 'https://ws-osservatorio.realitycs.it/api/search-data' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data '{
"ty_zone": "com",
"id_zone": "100005",
"window": "1M",
"contract": 1,
"year": 2024,
"month": 12,
"typology": 4,
"nation": "IT"
}'
Request Fields
| Field | Required | Default | Description | Type | Example | Notes |
|---|---|---|---|---|---|---|
ty_zone | yes | Zone type | string | com | ||
id_zone | yes | Zone ID | string | 100005 | ||
window | yes | Time window | string | 1M | ||
contract | yes | Contract type | number | 1 | ||
year | yes | Required year | number | 2024 | ||
month | yes | Required month | number | 12 | ||
typology | optional | Esatate typology | number | 4 | ||
nation | optional | IT | Nation code | string | IT | |
success_if_empty | optional | false | handle response with empty data | boolean | false |
JSON keys in the response
- contribution: Share of searches in the area.
- contribution_views: Share of views in the area.
- conversion_rate: Conversion rate.
- leads_avg: Average leads per listing.
- maintenance_status: Search segmentation by maintenance condition.
- min_surface_avg: Searches by surface area.
- price_sqm_search_avg: Average spending propensity of searches.
- typologies: Search segmentation by property type.
Example Response
{
"_metadata": {
"message": "",
"query": {},
"status": 200,
"request_id": "2357224d-b47c-475b-8e9f-73f5105f4229"
},
"items": [
{
"contribution": {
"delta": {
"value": 0.42,
"window": "12M"
},
"ranking": {
"of": 20,
"position": 3,
"value": [
{
"id": "3",
"nome": "Lombardia",
"valore": 24.3
},
{
"id": "12",
"nome": "Lazio",
"valore": 14.65
},
{
"id": "1",
"nome": "Piemonte",
"valore": 9.54
},
{
"id": "8",
"nome": "Emilia-Romagna",
"valore": 8.34
},
{
"id": "5",
"nome": "Veneto",
"valore": 7.21
},
{
"id": "9",
"nome": "Toscana",
"valore": 6.31
},
{
"id": "15",
"nome": "Campania",
"valore": 5.49
},
{
"id": "19",
"nome": "Sicilia",
"valore": 4.69
},
{
"id": "7",
"nome": "Liguria",
"valore": 4.62
},
{
"id": "16",
"nome": "Puglia",
"valore": 3.51
},
{
"id": "6",
"nome": "Friuli Venezia Giulia",
"valore": 2.17
},
{
"id": "20",
"nome": "Sardegna",
"valore": 1.94
},
{
"id": "11",
"nome": "Marche",
"valore": 1.66
},
{
"id": "13",
"nome": "Abruzzo",
"valore": 1.63
},
{
"id": "4",
"nome": "Trentino-Alto Adige",
"valore": 1.39
},
{
"id": "18",
"nome": "Calabria",
"valore": 0.97
},
{
"id": "10",
"nome": "Umbria",
"valore": 0.93
},
{
"id": "2",
"nome": "Valle d'Aosta",
"valore": 0.31
},
{
"id": "14",
"nome": "Molise",
"valore": 0.18
},
{
"id": "17",
"nome": "Basilicata",
"valore": 0.16
}
]
},
"value": 9.54
},
"contribution_views": {
"delta": {
"value": 2.96,
"window": "12M"
},
"ranking": {
"of": 20,
"position": 3,
"value": [
{
"id": "3",
"nome": "Lombardia",
"valore": 21.43
},
{
"id": "12",
"nome": "Lazio",
"valore": 14.06
},
{
"id": "1",
"nome": "Piemonte",
"valore": 10.78
},
{
"id": "8",
"nome": "Emilia-Romagna",
"valore": 8.23
},
{
"id": "9",
"nome": "Toscana",
"valore": 7.52
},
{
"id": "5",
"nome": "Veneto",
"valore": 6.85
},
{
"id": "15",
"nome": "Campania",
"valore": 5.4
},
{
"id": "19",
"nome": "Sicilia",
"valore": 5.13
},
{
"id": "7",
"nome": "Liguria",
"valore": 5.09
},
{
"id": "16",
"nome": "Puglia",
"valore": 3.62
},
{
"id": "6",
"nome": "Friuli Venezia Giulia",
"valore": 1.93
},
{
"id": "11",
"nome": "Marche",
"valore": 1.87
},
{
"id": "13",
"nome": "Abruzzo",
"valore": 1.84
},
{
"id": "20",
"nome": "Sardegna",
"valore": 1.66
},
{
"id": "4",
"nome": "Trentino-Alto Adige",
"valore": 1.36
},
{
"id": "18",
"nome": "Calabria",
"valore": 1.32
},
{
"id": "10",
"nome": "Umbria",
"valore": 1.05
},
{
"id": "2",
"nome": "Valle d'Aosta",
"valore": 0.34
},
{
"id": "17",
"nome": "Basilicata",
"valore": 0.26
},
{
"id": "14",
"nome": "Molise",
"valore": 0.26
}
]
},
"value": 10.78
},
"conversion_rate": {
"delta": {
"value": -14.29,
"window": "12M"
},
"ranking": {
"of": 20,
"position": 8
},
"value": 1.2
},
"leads_avg": {
"delta": {
"value": -2.76,
"window": "12M"
},
"ranking": {
"of": 20,
"position": 7
},
"value": 4.07
},
"maintenance_status": [
{
"qt_raw_perc": 43.0,
"status_id": "2"
},
{
"qt_raw_perc": 39,
"status_id": "3"
},
{
"qt_raw_perc": 10,
"status_id": "4"
},
{
"qt_raw_perc": 8,
"status_id": "1"
}
],
"min_surface_avg": {
"delta": {
"value": -1.16,
"window": "12M"
},
"ranking": {
"of": 20,
"position": 10
},
"value": 85
},
"pc_rooms": {
"1": {
"pc_raw": 3.76,
"qt_raw": 3035
},
"2": {
"pc_raw": 22.44,
"qt_raw": 18114
},
"3": {
"pc_raw": 43.7,
"qt_raw": 35282
},
"4": {
"pc_raw": 21.14,
"qt_raw": 17066
},
"5": {
"pc_raw": 8.8,
"qt_raw": 7102
},
"m5": {
"pc_raw": 0.16,
"qt_raw": 130
}
},
"price_sqm_search_avg": {
"delta": {
"value": -2.3,
"window": "12M"
},
"ranking": {
"of": 20,
"position": 12
},
"value": 2671
},
"res": {
"pc_1floor": 11.77,
"pc_1typology": 27.07,
"pc_garage": 4.16,
"pc_garden": 9.62,
"pc_minrooms": 19.47,
"pc_status": 12.29,
"pc_terrace": 6.35
},
"typologies": [
{
"qt_raw_perc": 24.0,
"typology_id": "7"
},
{
"qt_raw_perc": 21,
"typology_id": "12"
},
{
"qt_raw_perc": 19,
"typology_id": "4"
},
{
"qt_raw_perc": 14,
"typology_id": "13"
},
{
"qt_raw_perc": 22,
"typology_id": "other"
}
]
}
]
}