v4 /coverage.json

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

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

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.

Responses

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.nearmap.com/ai/features/v4/coverage.json?bulk=false&prerelease=false&perspective=Vert&3dCoverage=false&excludePartialResources=false' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

200OK

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

401Unauthorized

403Forbidden