--- title: "Returns roof age information for resource ID within the supplied AOI." method: POST path: "/resources/{resourceId}.{fileFormat}" --- # Returns roof age information for resource ID within the supplied AOI. `POST /resources/{resourceId}.{fileFormat}` summary: Returns roof age information for resource ID within the supplied AOI. ## Path parameters - `resourceId` string, required - `fileFormat` 'geojson', required ## Request body - RoofAgeRequest - `address` Address — The address of the parcel for which to retrieve roof age. - `streetAddress` string, required — The street address for a geocoded request. Should consist of the street number, street name, and street type. - `city` string, required — The city, suburb, or locality for a geocoded request. - `state` string, required — The two-letter state code for a geocoded request. - `zip` string, required — The five-digit ZIP code or nine-digit ZIP+4 code for US addresses or the four-digit postal code for AU addresses for a geocoded request. - `country` string, required — The two-letter country code for the geocoded request. Only supports US and AU. Defaults to US when geocoding is used without supplying the country code. - `aoi` AoiGeometry — AOI for roof age query - `geometry` object, required — A GeoJSON object representing the requested AOI. Must be a GeoJSON polygon with no interior rings. - `type` 'Polygon', required — GeoJSON geometry type. - `coordinates` GeoJSONPolygonRing[], required — The set of rings defining the Polygon. - GeoJSONCoordinate[] — A set of coordinate pairs that define the polygon for the AOI. - number[] — An ordered pair of floating point numbers representing the location specified in the following sequence: longitude, latitude. - `sinceAsOfDate` string, date — Date (`YYYY-MM-DD`) specifying that the returned asOfDate must be on or after the given date. - `untilAsOfDate` string, date — Date (`YYYY-MM-DD`) specifying that the returned asOfDate must be on or before the given date. - `cursor` string — 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. - `limit` integer — 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. ## Response `200` Successful request; returns roof age information. - RoofAgeResponse - `cursor` unknown, required - `features` Feature[], required — The list of roof and parcel features matching the AOI. - `geometry` object — GeoJSON polygon of the roof or parcel instance in EPSG:4326 projection to which the roof installation date applies. - `id` number — Feature unique identifier - `properties` object - `hilbertId` string — Stringified version of the feature ID. - `area` number — Area of the roof or parcel feature in square meters. - `installationDate` string, date — Predicted roof installation date in YYYY-MM-DD format. If the predicted roof installation date is prior to 2000, null will be returned. - `asOfDate` string, date — Date as of which the roof age is calculated. - `kind` 'roof' | 'parcel' — Indicates if feature is roof or parcel based. - `trustScore` integer — A score between 0 and 100 which is representative of the relative confidence of the roof installation dates. - `evidenceType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 — Evidence status: - 0 No unobscured images available for the roof or parcel and there is no supporting evidence for that parcel. No roof installation date is provided. - 1 (Future Release) No unobscured images available for the roof or parcel. Aggregated supporting evidence from the area can provide an indication of the likely age of roofs in that area. - 2 No unobscured images available for the roof or parcel. Supporting evidence provides an indication of the roof installation date. - 3 Single unobscured image available and the model predicts the age of the roof by using the available image as well as other data sources. - 4 Single unobscured image available and the model predicts the age of the roof by using the available image as well as other data sources. Supporting evidence agrees with the predicted installation date. - 5 Multiple unobscured images available for the roof and the AI model has not detected a roof change between captures. The age of the roof has been predicted by a seperate model using the available images as well as other data sources. - 6 Multiple unobscured images available for the roof and the AI model has not detected a roof change between captures. The age of the roof has been predicted by a seperate model using the available images as well as other data sources. Supporting evidence agrees with the predicted installation date. - 7 Multiple unobscured images of the roof and the AI model has detected a roof change between two captures. - 8 Multiple unobscured images of the roof and the AI model has detected a roof change between two captures. Supporting evidence agrees with the predicted installation date. - `evidenceTypeDescription` 'no_evidence' | 'aggregate_adjunct_only' | 'adjunct_only' | 'single_image' | 'single_image_and_adjunct' | 'multiple_images_with_no_change' | 'multiple_images_with_no_change_and_adjunct' | 'multiple_images_with_change' | 'multiple_images_with_change_and_adjunct' — The evidence type used in the prediction of the roof installation date. - `minCaptureDate` string, date — Earliest capture date used to calculate the roof age in YYYY-MM-DD. - `maxCaptureDate` string, date — Latest capture date used to calculate the roof age in YYYY-MM-DD. - `numberOfCaptures` integer — Number of unique captures dates used to calculate the roof age. - `mapBrowserUrl` string, uri — Link to the Mapbrowser view of this property. If the installation date falls within the available imagery range, the view will show the imagery from the `beforeInstallationCaptureDate` and `afterInstallationCaptureDates` range. If the installation date is outside of the imagery range, the view will show imagery from the `minCaptureDate` and `maxCaptureDate` range. - `beforeInstallationCaptureDate` string, date — Capture date immediately preceding the predicted roof installation (YYYY-MM-DD) when within the imagery range. Null if the installation date is outside the range or unavailable (predicted before 2000). - `afterInstallationCaptureDate` string, date — Capture date immediately after the predicted roof installation (YYYY-MM-DD) if within the available imagery range. Null if the installation date is outside the range or unavailable (e.g., prediction before 2000). - `relevantPermits` boolean — True if roof installation related permits were used for the calculation of the roof installation date. False if no permits available or not used in calculation. - `assessorData` boolean — True if year-built assessor data associated with the parcel is available. False if no data is available. - `type` string, required - `resourceId` string, required - `address` CanonicalAddress — The canonical address of the parcel to retrieve roof age. - `streetAddress` string — The street address for a geocoded request. Should consist of the street number, street name, and street type. - `city` string — The city, suburb, or locality for a geocoded request. - `state` string — The two-letter state code for a geocoded request. - `zip` string — The five-digit ZIP code or nine-digit ZIP+4 code for US addresses or the four-digit postal code for AU addresses for a geocoded request. - `country` string — The two-letter country code for the geocoded request. Only supports US and AU. - `modelVersion` string, required — Version of the AI Roof Age model used to generate the roof age predictions. - `presentationVersion` string, required — Version of the presentation layer used to generate AI Roof Age data. ## Other responses - `400` — Bad request (invalid input) - `403` — This action is restricted. Please check your access permissions. - `404` — Not Found --- [API](https://skmtc.net/nearmap/apis/tiles.md) · [All operations](https://skmtc.net/nearmap/apis/tiles/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nearmap/tiles/versions/1f55d21ac4b9/schema)