v3/surveys/{surveyId}/{type}.{format}

get

https://api.nearmap.com/staticmap/v3/surveys/{surveyId}/{type}.{format}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

surveyId

string

required

Identifier of the survey for which content will be retrieved. This will correspond to a specific date.

type

enum

required

Type of raster content to return. This corresponds to the requested types in the coverage end point.

format

enum

required

File format of the resultant raster image.

Allowed:

Query Params

point

string

The central point of the area of interest being queried, in the format LONG,LAT. The point is the longitude and latitude of the location on which to center the area. Must be used in conjunction with a radius parameter or else it is invalid. It is invalid to specify more than one of bbox or point-and-radius or x-and-y.

radius

double

Distance from the point in metres. Required in conjunction with point to define the token's bounding box (not a circle). Radius range is between 1 - 100. Must be used in conjunction with a point parameter or else it is invalid.

maxSize

string

Defaults to 4096x4096

Maximum width and height of the resultant image in pixels. The format is {width}x{height}. The maximum image size is "4096x4096". This parameter is optional, and if not given defaults to the maximum image size.

tileSize

string

Defaults to 4096x4096

Maximum width and height of a tile. Only valid in conjunction with x and y parameters. The format is {width}x{height}. The maximum tile size is "4096x4096". This parameter is optional, and if not given defaults to the maximum tile size.

bbox

string

The rectangular box being queried, in the comma-separated format LONG,LAT,LONG,LAT. The bounding box specifies the longitude and latitude of the bottom-left and top-right corners of a rectangle. It is invalid to specify more than one of bbox or point-and-radius or x-and-y.

int32

The x position of the tile within the entire requested image. Large requested image are divided into tiles up to 4096x4096 pixels in size. Small integers are used to select which of these tiles to return. When x=0 this gives the leftmost tile, and x increases rightwards. Note x=0 is westernmost in Vert imagery, but is only west for North panoramas. Must be used in conjunction with a y parameter or else it is invalid. It is invalid to specify more than one of bbox or point-and-radius or x-and-y.

int32

The y position of the tile within the entire requested image. Large requested image are divided into tiles up to 4096x4096 pixels in size. Small integers are used to select which of these tiles to return. When y=0 this gives the topmost tile, and y increases downwards. Note y=0 is northernmost in Vert imagery, but is only north for North panoramas. Must be used in conjunction with a x parameter or else it is invalid. It is invalid to specify more than one of bbox or point-and-radius or x-and-y.

transactionToken

string

required

Transaction token to use in an image request. This token is obtained from the coverage service's v3 end point. This token contains authentication information, transaction ID, reference ID, resource specification, and area of interest (AOI). This token can be used to make multiple image requests within its AOI, until the token expires. Image requests do not incur extra usage charges beyond the original coverage request.

Headers

string

enum

Defaults to image/*

Generated from available response content types

Allowed:

Responses

400

On bad or missing input parameter.

403

Transaction token is invalid or request is out of bounds.

429

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

503

Service is unavailable due to overload. Exponential backoff is recommended. Retry the request later.

5XX

Internal server error.

200Image or world file response.