API Reference

staticmap/v2/coverage.json

get
https://api.nearmap.com/staticmap/v2/coverage.json

Query survey resources of the requested type that are available in the given AOI. Surveys are returned in order of most to least recent.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

The point for which the surveys are retrieved. The point is the longitude and latitude of the location on which to center the image, in the format LONG,LAT. For example, -74.044831,40.689669.

int64
required

Distance from the point in metres. Used in conjunction with point to define a bounding box (not a circle). Radius range between 1 - 100.

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:
string

The first day from which to retrieve the surveys (inclusive).

string

The last day from which to retrieve the surveys (inclusive).

string
required

Comma separated list of resource types indicating the survey resources to return in the response.

string

Comma-separated list of field names that will appear in the response. The id field will always be among the returned fields, even if not specified. If not present then all the fields are returned.

int64

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

int64

Zero-based index of first record in the result.

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:
Responses

400

On bad input parameter.

403

point outside of coverage.

429

Rate limit exceeded. Exponential backoff is recommended.Retry the request later.

503

Service is unavaiable due to overloaded.Exponential backoff is recommended. Retry the request later.

5XX

Internal server error.

Updated about 1 year ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago