/v2/tx/poly/{poly}

get

https://api.nearmap.com/coverage/v2/tx/poly/{poly}

Return the surveys intersecting/overlapping with polygon

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Return the surveys intersecting/overlapping with polygon

Path Params

poly

string

required

The polygon for which the surveys are retrieved. The polygon is depicted by a set of lon,lat pairs, where the first and the last points must be the same.

Query Params

dates

enum

required

Whether the customer wishes to access all dates available or only one date (per resource type).

Allowed:

resources

string

required

Comma separated list of resource types. Each resource type is a colon separated namespace/type tuple, for example raster:Vert.

Namespaces currently supported:

raster
aiPacks
aiImpactAssessment

Supported raster resource types:

Vert - vertical orthorectified imagery
DetailDtm - aka DTM or bare earth elevation model
DetailDsm - aka DSM or surface model
TrueOrtho - True Ortho (strict top down imagery, derived from 3D)
North, East, South, West - panorama imagery

Supported aiPacks resource types:

building
building_char
construction
debris
pavement_marking
poles
pool
postcat
roof_char
roof_cond
roof_objects
solar
surface_permeability
surfaces
trampoline
vegetation

Supported aiImpactAssessment resource types:

postcat

since

string

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.

until

string

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.

limit

int64

Limit the number of surveys in the result. Default is 20, Maximum is 1000.

sort

string

enum

The field by which to sort the surveys.
Only one field can be specified.
If this parameter is not used in the URL request, then the surveys are sorted by captureDate in descending order.

offset

int64

Zero-based index of first record in the result.

overlap

enum

Whether or not to return metadata for imagery that only partially intersects the requested area.
Default is to return all, such that surveys that only partially intersect the AOI will still be returned.
If full is specified then only surveys completely within the given AOI are included.

Allowed:

filter

enum

Whether to match only surveys with all of the listed resource types (allTypes),
or surveys with at least one of the resource types (anyTypes).
Default is allTypes.

Allowed:

aiOn3dCoverage

boolean

Defaults to false

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

preview

boolean

Defaults to false

When true, a coverage request will not be charged credits, however it will also not include
a transaction token in the response. All other behaviour should remain the same.
This allows a client to check the coverage status of a location before committing to the
transaction request.

Responses

200Surveys returned that match polygon

400Bad Request.

404Not Found