v1

latestOpenAPI 3.0.02026-07-243964175.3 KB

Returns roof age information for the latest resource within the supplied AOI.

summary: Returns roof age information for the latest resource within the supplied AOI.

post/resources/latest.{fileFormat}

Path parameters

fileFormat'geojson' required

Output file format. Currently only GeoJSON is supported.

Request body

sinceAsOfDatestring date

Date (YYYY-MM-DD) specifying that the returned asOfDate must be on or after the given date.

untilAsOfDatestring date

Date (YYYY-MM-DD) specifying that the returned asOfDate must be on or before the given date.

cursorstring

Optional cursor for pagination. Should be omitted on the first request, and set to the value of nextCursor from the previous response for subsequent requests.

limitinteger

Optional maximum number of features to return. If not set, a default of 1000 is used. If results are above limit, the response will be paginated, and only include 1000 features per page.

Example request

{
  "address": {
    "streetAddress": "422 Towne Park Trl",
    "city": "Austin",
    "state": "TX",
    "zip": "78751",
    "country": "US"
  },
  "aoi": {
    "geometry": {
      "coordinates": [
        [
          [
            -97.72889712645727,
            30.30097004106024
          ],
          [
            -97.72891413685106,
            30.30094441770939
          ],
          [
            -97.7286977067365,
            30.300846611442992
          ],
          [
            -97.7286821440362,
            30.300871609858902
          ],
          [
            -97.72889712645727,
            30.30097004106024
          ]
        ]
      ]
    }
  }
}

Response

Successful request, returning roof age information.

{"stackTrail":"components:schemas:RoofAgeResponse:properties:cursor","oasType":"schema","type":"unknown","description":"Cursor for fetching the next page of results. `null` if there are no more results to retrieve.\n"}

typestring required

resourceIdstring required

modelVersionstring required

Version of the AI Roof Age model used to generate the roof age predictions.

presentationVersionstring required

Version of the presentation layer used to generate AI Roof Age data.

Example response

{
  "features": [
    {
      "id": 3376720206396550700,
      "properties": {
        "hilbertId": "3376720206396550762"
      }
    }
  ],
  "address": {
    "streetAddress": "422 Towne Park Trl",
    "city": "Austin",
    "state": "TX",
    "zip": "78751",
    "country": "US"
  }
}