/v4 /rollups.json

post

https://api.nearmap.com/ai/features/v4/rollups.json

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

Operates semantically the same way as the GET variant but allows the polygon parameter and classes to be passed inside the request body rather than as a query parameter. This may be required for polygons and classes whose representations are large, in order to avoid URL length limitations.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

polygon

string

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.

since

string

Since is a date (YYYY-MM-DD) specifying that the capture must be on or after the given date (if not provided then the first available survey date in the location is assumed).

until

string

Until is a date (YYYY-MM-DD) specifying that the capture date must be on or before the given date (if not provided then the current date is assumed).

order

enum

Defaults to latest

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

Allowed:

bulk

boolean

Defaults to false

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

packs

string

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.

classes

string

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.

streetAddress

string

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.

city

string

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.

state

string

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.

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.

It cannot be used with the polygon query parameter.

Must be omitted when TXv3 token authorization is used.

country

string

enum

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.

Allowed:

systemVersion

string

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

systemVersionPrefix

string

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.

alpha

boolean

Defaults to false

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

beta

boolean

Defaults to false

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

3dCoverage

boolean

Defaults to false

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.

Body Params

aoi

object

A GeoJSON object representing the requested AOI. Must be a GeoJSON polygon with no interior rings.

It cannot be used with the polygon query parameter.

classes

array of strings

Classes accepts a list of 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 or body parameter is not specified.

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

classes

Headers

X-Nearmap-Ext-Reference

string

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

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200OK response to the rollups.json endpoint.

400Bad Request. There was a problem with the request parameters.

401Unauthorized

403Forbidden

404Not Found. No data is available matching the request criteria.