Sales Volume

POST /api/sales/volume

Real estate transaction volumes.

Example Request

curl --location 'https://ws-osservatorio.realitycs.it/api/sales/volume' \
--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
`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
`cadastral_typology`	optional		Esatate cadastral typology	string	`A4`
`nation`	optional	`IT`	Nation code	string	`IT`
`success_if_empty`	optional	`false`	handle response with empty data	boolean	`false`

JSON keys in the response

cadastral_typologies: Cadastral categories
sales: Revenue (processed data from AdE)
sales_qtraw: NTN (processed data from AdE)
sales_surface_avg: Average surface
sales_surface_class: Surface classes

Example Response

{
    "_metadata": {
        "message": "",
        "query": {},
        "status": 200,
        "request_id": "90032878-a74f-43fc-bf25-8af27b1cc86f"
    },
    "items": [
        {
            "cadastral_typologies": [
                {
                    "qt_raw_perc": 50.0,
                    "typology_id": "A3"
                },
                {
                    "qt_raw_perc": 38,
                    "typology_id": "A2"
                },
                {
                    "qt_raw_perc": 8,
                    "typology_id": "A4"
                },
                {
                    "qt_raw_perc": 3,
                    "typology_id": "A7"
                },
                {
                    "qt_raw_perc": 1,
                    "typology_id": "other"
                }
            ],
            "sales": {
                "delta": {
                    "value": -5.12,
                    "window": "3M"
                },
                "ranking": {
                    "of": 8,
                    "position": 1
                },
                "value": 1248273623.74
            },
            "sales_qtraw": {
                "delta": {
                    "value": 38.27,
                    "window": "3M"
                },
                "ranking": {
                    "of": 8,
                    "position": 1
                },
                "value": 10004.21
            },
            "sales_surface_avg": {
                "delta": {
                    "value": -1.39,
                    "window": "3M"
                },
                "ranking": {
                    "of": 8,
                    "position": 8
                },
                "value": 96.51
            },
            "sales_surface_class": [
                {
                    "id": "2",
                    "qt_raw_perc": 40.0
                },
                {
                    "id": "3",
                    "qt_raw_perc": 25
                },
                {
                    "id": "5",
                    "qt_raw_perc": 13
                },
                {
                    "id": "4",
                    "qt_raw_perc": 12
                },
                {
                    "id": "1",
                    "qt_raw_perc": 10
                }
            ]
        }
    ]
}