File contents
The JSON file returns the address, the capture date and the MapBrowser URL for the address as explained in the table below. At a parcel level, the JSON contains an aggregation of all roof condition, material and shape properties such as areas, counts, etc. within the parcel. For each roof, it provides the individual roof condition, material and shape properties such as areas, counts, etc., which are aggregated at the parcel level and stored in the properties field. If no value is detected, an empty string is returned.
Roofs are ordered by decreasing roof area, so the primary (largest) roof will always be the first. This is illustrated in the example below.
The JSON file that is returned contains the following information.
Field | Data Type | Description |
|---|
address | string | The geocoded address of the requested parcel. |
captureDate | string | The survey date of the requested parcel. |
urlLink | string | The Nearmap MapBrowser URL for the Vertical image of the requested parcel. |
properties | object | The set of aggregated values computed from the AI features of the requested parcel. This is a unique ID designed for programmatic use cases. |
roofs | array | The collection of roof rollups ordered by descending roof area, that is, the first roof is the primary (largest) roof. |
Field | Example of return value |
|---|
address |
|
captureDate |
|
urlLink |
|
properties |
|
roofs |
|
{
"address": "1616 W 5th St Austin TX 78703-4738 United States of America",
"captureDate": "2017-04-27",
"urlLink": "https://apps.nearmap.com/maps/#/@30.2747438,-97.7642827,20.00z,0d/V/20170427?locationMarker",
"properties": {
"007b8c46-bfb8-528c-ab28-bda98453ec0b": {
"description": "gable ratio",
"value": "0.000000"
},
"01aa1496-9517-50f2-af77-22c37cc17f8a": {
"description": "roof with temporary repair presence",
"value": "false"
},
"0262ed29-391c-5769-b12a-75aaa9db57fb": {
"description": "metal clipped area (sqm)",
"value": "474.8"
},
"065e9df6-02df-53c8-bf98-27b28a8d6c3d": {
"description": "tile count",
"value": "0"
},
...
"roofs": [
{
"roof-1": {
"007b8c46-bfb8-528c-ab28-bda98453ec0b": {
"description": "gable ratio",
"value": "0.637748"
},
"01aa1496-9517-50f2-af77-22c37cc17f8a": {
"description": "roof with temporary repair presence",
"value": "false"
},
"0262ed29-391c-5769-b12a-75aaa9db57fb": {
"description": "metal clipped area (sqm)",
"value": "386.1"
},
...
"roof-2": {
"107b8c46-bfb8-528c-ab28-bda98453ec0b": {
"description": "gable ratio",
"value": "0.737748"
},
...
