/v4 /coverage.json

post

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

Returns survey resources at a particular location, filtered by date.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

Query Params

polygon

string

The polygon to check for coverage, as a set of points where the first
and last point must be the same.

It cannot be used with the point parameter.

point

string

The point to check for coverage, as a comma separate longitude and latitude.

It cannot be used with the polygon query parameter.

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

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.

prerelease

boolean

Defaults to false

When set to true, causes pre-release system versions to be included in results.

perspective

string

Defaults to Vert

Accepts a comma-separated list of perspectives, limiting the coverage
lookup to just those perspectives. The available perspectives are Vert
and TrueOrtho.

This parameter is ignored if used with an empty value.

3dCoverage

boolean

Defaults to false

When set to true, performs coverage check using the 3D attribute
coverage boundary of the resource.

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.

excludePartialResources

boolean

Defaults to false

Partial resources are AI resources that only has prediction generated at certain areas of the survey boundary as compared to our conventional fully processed resource. These types of resources are generally available by default. This flag opts-out from serving partial resources.

postcat

string

enum

When set, the API will consider only postcat resources (true), only
non-postcat resources (false), or any resource (any) for results.
This parameter is only available for users on the new pricing platforms.
For users on the legacy pricing platform, the selection of postcat or
non-postcat resources is determined by the packs (or classes) requested.

Allowed:

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

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200OK

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

401Unauthorized

403Forbidden