/properties/aoi

Geometry search

The endpoint enables you to retrieve parcel boundaries using geometry-based input (point, polygon, or multi-polygon). The properties returned will be of type aoi.

For a point search, a radius must be specified.

Endpoint

POST https://api.nearmap.com/property/resources/v1/properties/aoi

Request body fields

Field NameValue(s)RequiredDefaultDescription
aoiA GeoJSON geometry ( polygon or multi-polygon)N/ALocation for the parcel search
radiusFloating point number (meters)✖ (Required when geometry is a point)N/ADistance from the point defining a bounding box (search boundary)
{
  "aoi" :  {
      "type": "Point",
      "coordinates": [125.6, 10.1]
  },
  "radius": 178.358,
  "resources": {
    "raster": [
      {
        "type": "vert"
      }
    ],
    "ai": [
      {
        "type": "pack:postcat",
        "selectors":  {
          "pipeline": "foo_fighters",
          "orthography": "trueortho",
          "3d": true
        }
      }
    ]
  },
  "since": "2019-12-02",
  "until": "6M",
  "nextCursor": "OWEwNWQ5OTQtOGY2OC00NmJlLWIzZDQtZWFmNDdmY2RlNjIzCg==",
  "limit": 5,
  "overlap" : "any",
  "filter" :"anyTypes",
  "preview": false
}
{
 "aoi" :  {
     "type": "Polygon",
     "coordinates": [
         [
             [100.0, 0.0],
             [101.0, 0.0],
             [101.0, 1.0],
             [100.0, 1.0],
             [100.0, 0.0]
         ]
     ]
 },
 "resources": {
   "raster": [
     {
       "type": "vert"
     }
   ],
   "ai": [
     {
       "type": "pack:postcat",
       "selectors":  {
         "pipeline": "foo_fighters",
         "orthography": "trueortho",
         "3d": true
       }
     }
   ]
 },
 "since": "2019-12-02",
 "until": "6M",
 "nextCursor": "OWEwNWQ5OTQtOGY2OC00NmJlLWIzZDQtZWFmNDdmY2RlNjIzCg==",
 "limit": 5,
 "overlap" : "any",
 "filter" :"anyTypes",
 "preview": false
}
{
  "aoi": {
    "type": "Feature",
    "properties": {
      "address": "Centenary Dr, Strathfield NSW 2135, Australia"
    },
    "geometry": {
      "coordinates": [
        [
          [
            151.06473262163433,
            -33.86852557477602
          ],
          [
            151.06473262163433,
            -33.87211908605872
          ],
          [
            151.06839300829336,
            -33.87211908605872
          ],
          [
            151.06839300829336,
            -33.86852557477602
          ],
          [
            151.06473262163433,
            -33.86852557477602
          ]
        ]
      ],
      "type": "Polygon"
    }
  },
  "resources": {
    "raster": [
      {
        "type": "vert"
      }
    ],
    "ai": [
      {
        "type": "pack:postcat",
        "selectors":  {
          "pipeline": "foo_fighters",
          "orthography": "trueortho",
          "3d": true
        }
      }
    ]
  },
  "since": "2019-12-02",
  "until": "6M",
  "nextCursor": "OWEwNWQ5OTQtOGY2OC00NmJlLWIzZDQtZWFmNDdmY2RlNjIzCg==",
  "limit": 5,
  "overlap": "any",
  "filter": "anyTypes",
  "preview": false
}