NEnearmap
rollups

/v4 /rollups.geojson

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

get/rollups.geojson

Request

  • Base URL
    https://api.nearmap.com/ai/features/v4
  • URL
    https://api.nearmap.com/ai/features/v4/rollups.geojson
  • Auth
    • API key in query parameter apikey
    • or API key in header Authorization
    • or API key in header Authorization

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

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

untilstring

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'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.geojson endpoint.

type'FeatureCollection' required

This is always "FeatureCollection".

Example response

{
  "features": [
    {
      "geometry": {
        "coordinates": [
          [
            [
              -97.72889,
              30.30097
            ],
            [
              -97.72891,
              30.30094
            ],
            [
              -97.72869,
              30.30084
            ],
            [
              -97.72868,
              30.30087
            ],
            [
              -97.72889,
              30.30097
            ]
          ]
        ]
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.