---
title: "/v4 /rollups.json"
method: GET
path: "/rollups.json"
tags: ["rollups"]
---

# /v4 /rollups.json

`GET /rollups.json`

Returns aggregated (rolled up) values computed from all AI features within the given polygon/address and date range.

## Query parameters

- `polygon` string
- `since` string
- `until` string
- `order` 'latest' | 'earliest'
- `bulk` boolean
- `packs` string
- `classes` string
- `streetAddress` string
- `city` string
- `state` string
- `zip` string
- `country` 'US' | 'AU'
- `systemVersion` string
- `systemVersionPrefix` string
- `alpha` boolean
- `beta` boolean
- `3dCoverage` boolean

## Headers

- `X-Nearmap-Ext-Reference` string

## Response `200`

OK response to the rollups.json endpoint.

- RollupsJSONResult
  - `systemVersion` string, required — The version of the system used to generate the AI data.
  - `perspective` string, required — The perspective that was used to generate the AI data.
  - `resourceId` string, required — The ID of the survey resource.
  - `surveyId` string, required — The ID of the survey associated with the survey resource.
  - `surveyDate` string, date, required — The date of the survey capture.
  - `credits` integer, required — The number of credits used for this request.
  - `link` string, required — The MapBrowser link to the location that was requested.
  - `rollups` JSONRollups, required — The set of aggregated values computed out of AI features at the location requested. The rollups can be grouped by one or more combinations of the feature class (e.g. roof), primary feature of the requested location (e.g. primary), feature attributes (e.g. 3D), or feature components (e.g. roof pitch).
  - `geomatchedAddress` string — Matched address used for geocoded requests.
  - `reference` string — The reference passed in via the X-Nearmap-Ext-Reference request header value, if it is present. It is up to the user to track the semantics of this field. E.g. they may wish to interpret it as an insurance policy ID.
  - `extentMinX` number, required — Approximate minimum longitude of the AOI extent.
  - `extentMinY` number, required — Approximate minimum latitude of the AOI extent.
  - `extentMaxX` number, required — Approximate maximum longitude of the AOI extent.
  - `extentMaxY` number, required — Approximate maximum latitude of the AOI extent.
  - `prerelease` boolean — Indicates whether or not the system version used to serve the request is a preview release. If it's not a preview release, then it's a regular GA release. This field is only populated if the alpha or beta request query parameters are set to true or a preview release is explicitly requested.

## Other responses

- `400` — Bad Request. There was a problem with the request parameters.
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found. No data is available matching the request criteria.

---

[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)