This endpoint enables you to retrieve roof age information for a specific resource within the supplied Area of Interest (AOI).

Endpoint

POST [https://api.nearmap.com/ai/roofage/v1/resources/\{resourceId}.\{fileFormat}](https://api.nearmap.com/ai/roofage/v1/resources/\{resourceId}.\{fileFormat})

Path Parameters

Parameter	Type	Required	Description
`fileFormat`	string	✔	Output format for the response. Currently, only GeoJSON is supported

Request Body Parameters

The request body is a JSON object that must contain either address information or area of interest geometry. You cannot provide both address and aoi in the same request.

Parameter	Type	Required	Description
`address`	string	✔*	Address information for the property to analyze in the format: `"422 Towne Park Trl, Austin, TX 78751 US"`. Required if `aoi` is not provided
`aoi`	object	✔*	Polygon geometry with an array of coordinate rings defining the analysis area. Required if `address` is not provided

*Note: Either address OR aoi must be provided, but not both.

AOI Object Structure

When using the aoi parameter, provide a GeoJSON-style polygon:

{
  "aoi": {
    "type": "Polygon",
    "coordinates": [
      [
        [longitude1, latitude1],
        [longitude2, latitude2],
        [longitude3, latitude3],
        [longitude4, latitude4],
        [longitude1, latitude1]
      ]
    ]
  }
}

Example Requests

Using Address

{
  "address": "422 Towne Park Trl, Austin, TX 78751 US"
}

Using Area of Interest

{
  "aoi": {
    "type": "Polygon",
    "coordinates": [
      [
        [-97.7431, 30.2672],
        [-97.7425, 30.2672],
        [-97.7425, 30.2665],
        [-97.7431, 30.2665],
        [-97.7431, 30.2672]
      ]
    ]
  }
}

Response Format

The response will be returned in the specified fileFormat (currently only GeoJSON) and will include roof age information and analysis results for the requested resource and area.