NEnearmap
staticmap

Return surveys that are available at the requested location.

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

get/coverage.json

Request

  • Base URL
    https://api.nearmap.com/staticmap/v2
  • URL
    https://api.nearmap.com/staticmap/v2/coverage.json
  • Auth
    • API key in query parameter apikey
    • or API key in header Authorization

Query parameters

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

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

overlap'full' | 'all'

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.

sincestring

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

untilstring

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

resourcesstring required

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

fieldsstring

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.

limitinteger

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

offsetinteger

Zero-based index of first record in the result.

filter'allTypes' | 'anyTypes'

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.

Response

Surveys matching the given criteria

limitinteger

Limit as specified in the request

offsetinteger

Offset of the first survey returned, as specified in the request

totalinteger

Total number of surveys available for the request

transactionTokenstring

Transaction token to use in subsequent staticmap image requests. The coverage response gives you a Transaction Token. This token is valid 30 days form the coverage call. Once you've successfully requested the first image, this is counted against your monthly transaction allowance. You can subsequently make multiple calls to retrieve DSM/TrueOrtho/Vertical imagery within the original AOI without being charged, until the Transaction Token expires.

Changes

No recorded changes to this operation across all 1 revision of this API.