v1

latestOpenAPI 3.0.02026-07-243964175.3 KB

rollups

/v4 /rollups.json

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

get/rollups.json

Query parameters

polygonstring

Represents the Area Of Interest (AOI) to query against. It is depicted by a set of points (longitude/latitude pairs) where the first and last point must be the same. The polygon must not self-intersect.

It cannot be used with the address geocoding parameters (streetAddress, city, state, zip and country), or with an aoi defined in the request body for the HTTP POST variant endpoints.

Must be omitted when TXv3 token authorization is used.

sincestring

First day from which to retrieve the surveys (inclusive). Must be of the form "YYYY-MM-DD" or as a relative date relative date "xxY", "xxM", "xxD" where 5M represents since 5 months ago.

untilstring

Last day from which to retrieve the surveys (inclusive). Must be of the form "YYYY-MM-DD" or as a relative date relative date "xxY", "xxM", "xxD" where 5M represents until 5 months ago.

order'latest' | 'earliest'

The order by which the surveys are sorted (using capture date) when the API selects the survey resource to use for serving the request.

bulkboolean

Bulk determines whether if the request is part of a large batch of requests, meaning requests will not be rate-limited.

packsstring

Packs accepts a list of comma-separated product packs. This returns specific features and attributes under the pack. The response will return all features and attributes that the user is entitled to if no packs are provided.

It cannot be used with the classes query parameter. This parameter is ignored if used with an empty value.

classesstring

Classes accepts a list of comma-separated feature class IDs. Features classes not requested will be filtered out of the response. The full list of available feature classes can be obtained by using the classes.json endpoint (Feature class IDs are in the id field for classes of type Feature). The response will include all feature classes that the user is entitled to if the query parameter is not specified.

It cannot be used with the packs query parameter. This parameter is ignored if used with an empty value.

streetAddressstring

The street address for a geocoded request. Should consist of the street number, street name, and street type.

It cannot be used with the polygon query parameter.

Must be omitted when TXv3 token authorization is used.

citystring

The city, suburb, or locality for a geocoded request.

It cannot be used with the polygon query parameter.

Must be omitted when TXv3 token authorization is used.

statestring

The two-letter state code for a geocoded request.

It cannot be used with the polygon query parameter.

Must be omitted when TXv3 token authorization is used.

zipstring

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.

It cannot be used with the polygon query parameter.

Must be omitted when TXv3 token authorization is used.

country'US' | 'AU'

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.

It cannot be used with the polygon query parameter.

Must be omitted when TXv3 token authorization is used.

systemVersionstring

If specified, causes the API to only consider the given system version when choosing which survey resource to use for serving the request.

systemVersionPrefixstring

If specified, causes the API to only consider system versions that match the prefix when choosing which survey resource to use for serving the request.

alphaboolean

When set to true, causes alpha classes to be included in results.

betaboolean

When set to true, causes beta classes to be included in results.

3dCoverageboolean

Use the 3D attribute boundary when the API selects the survey resource to use for serving the request. Othewise, the regular resource boundary will be used.

Headers

X-Nearmap-Ext-Referencestring

Allows a reference string to be echoed back opaquely in the body of the response.

Response

OK response to the rollups.json endpoint.

systemVersionstring required

The version of the system used to generate the AI data.

perspectivestring required

The perspective that was used to generate the AI data.

resourceIdstring required

The ID of the survey resource.

surveyIdstring required

The ID of the survey associated with the survey resource.

surveyDatestring date required

The date of the survey capture.

creditsinteger required

The number of credits used for this request.

linkstring required

The MapBrowser link to the location that was requested.

rollupsJSONRollups 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).

geomatchedAddressstring

Matched address used for geocoded requests.

referencestring

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.

extentMinXnumber required

Approximate minimum longitude of the AOI extent.

extentMinYnumber required

Approximate minimum latitude of the AOI extent.

extentMaxXnumber required

Approximate maximum longitude of the AOI extent.

extentMaxYnumber required

Approximate maximum latitude of the AOI extent.

prereleaseboolean

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.

Example response

{
  "surveyDate": "2019-09-27",
  "credits": 1,
  "link": "https://apps.nearmap.com/maps/#/@-33.7251728,151.2955012,20.00z,0d/V/20190927",
  "geomatchedAddress": "10897 S River Front Pkwy Ste 150, South Jordan, UT 84095-5650, USA",
  "reference": "123456"
}