/coverage/v2/coord/{z}{x}{y}

get

https://api.nearmap.com/coverage/v2/coord/{z}/{x}/{y}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

The zoom level.

int64

required

The X tile coordinate for which the surveys are retrieved (column).

int64

required

The Y tile coordinate for which the surveys are retrieved (row).

Query Params

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.

resources

string

Comma separated list of resource types to include in the response in the form of "resourceClass:type" where ":type" is optional and represents all types of a resource class if not present. If not specified then all types are returned.

limit

int64

Number of survey records to return.

offset

int64

Zero-based index of first record in the result.

sort

string

Name of field to sort results by, with a prefix of "-" indicating to sort in descending order. Only one field can be specified. Default is by capture date descending.

fields

string

Comma separated list of survey fields to include in the response. Default is all fields.

include

string

Specify tags survey resource should include, return survey resource that match AT LEAST ONE of exposed tag
Comma separated tag query strings. Tag structure is TagType:TagName
Single tag query can be TagType only, match same tag type with any tag value.
Supported tag types are present in the coverage response

exclude

string

Specify tags survey resource should exclude, return survey resource does NOT match any exposed tag
Comma separated tag query strings. Tag structure is TagType:TagName
Single tag query can be TagType only, match same tag type with any tag value.
Supported tag types are present in the coverage response

Responses

400

On bad input parameter or if tile coordinate is out of range

Language

Credentials

Loading…

Response

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

application/json

200Survey resources matching criteria