Skip to content

Geographical data

GET /api/report/appraisal/<report_uuid>/geo

GeoJSON layers used to draw the maps of the report: the position of the property on the market page and the boundary of the OMI zone.

Example Request

curl --location 'https://insights.immobiliare.it/api/report/appraisal/e75ad7d5-dad2-4f6c-8db8-02295bd0bd9f/geo' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>'

Request Fields

Field Required Default Description Type Example Notes
report_uuid yes UUID of the report, given during the creation string e75ad7d5-dad2-4f6c-8db8-02295bd0bd9f Path parameter

JSON keys in the response:

  • market_map: FeatureCollection of Point features locating the property and the market zone. Each feature carries markerIconOptions with iconUrl and iconSize to render the marker.
  • omi_map: FeatureCollection of MultiPolygon features tracing the boundary of the OMI zone. Each feature carries pathOptions with color, weight, opacity and fillOpacity to style the outline.

Coordinate order

Coordinates follow the GeoJSON convention, longitude first, then latitude. The polygons of omi_map carry a third value in every position, the elevation, which is always 0 and can be ignored.

No show_geo needed

This endpoint is the geographical block of the report, so it always returns its layers. show_geo is only relevant on the blocks that embed a map alongside their own data, see Getting started.

Example Response

Note

Both collections are truncated to a single feature and the polygon to two positions in the example below: the actual response returns the full boundary of the zone, and is in the order of tens of kilobytes.

{
  "_metadata": {
    "message": "",
    "query": {},
    "status": 200
  },
  "data": {
    "market_map": {
      "features": [
        {
          "coordinates": [
            11.039137599752786,
            43.865818409317896
          ],
          "markerIconOptions": {
            "iconSize": [
              33,
              33
            ],
            "iconUrl": "https://pdf-generator-dev.realitycs.it/static/images/icone-b2c/color-5/appartamento.png"
          },
          "properties": {},
          "type": "Point"
        }
      ],
      "type": "FeatureCollection"
    },
    "omi_map": {
      "features": [
        {
          "coordinates": [
            [
              [
                [
                  11.106234002,
                  43.842128,
                  0
                ],
                [
                  11.106190001,
                  43.84209,
                  0
                ]
              ]
            ]
          ],
          "pathOptions": {
            "color": "#505050",
            "fillOpacity": 0.3,
            "opacity": 1,
            "weight": 1
          },
          "properties": {},
          "type": "MultiPolygon"
        }
      ],
      "type": "FeatureCollection"
    }
  }
}

Features are not standard GeoJSON

A GeoJSON Feature nests its geometry under a geometry key. Here type and coordinates sit directly on the feature and properties is always empty, with the rendering hints kept as sibling keys. Most mapping libraries will not accept these collections as they are: rebuild each feature as {"type": "Feature", "geometry": {"type": ..., "coordinates": ...}} before handing it over, and keep markerIconOptions and pathOptions aside as style options.