v1

latestOpenAPI 3.0.02026-07-243964175.3 KB
tiles

Retrieve a tile at a tile coordinate

Retrieves a tile of the specified type at the given tile coordinate, using Google Maps Tile Coordinates. Additional query parameters includes 'since' and 'until' dates can be provided to select a specific capture time.

get/{contentType}/{z}/{x}/{y}.{format}

Path parameters

contentTypestring required

The resource type for the requested tile. Available values are: ◾️ Vert - for vertical imagery ◾️ North - for North panorama imagery ◾️ South - for South panorama imagery ◾️ East - for East panorama imagery ◾️ West - for West panorama imagery Other tile types may be available depending on the user's subscription. Note that the tileResourceType values are case sensitive.

zinteger required

The zoom level. Uses the Google Maps Tile Coordinates. Note that the maximum zoom level is available from the Coverage API.

format'tif' | 'jpg' | 'png' | 'jgw' | 'pgw' | 'tfw' required

File format of the resultant raster image.

Query parameters

xinteger

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.

yinteger

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.

sincestring

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.

untilstring

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.

mosaicstring

Specifies the order in which the surveys covering the specified area are prioritized. The available values are: ◾️ latest (default) - the imagery with the later capture date is prioritized ◾️ earliest - imagery with the earlier capture date is prioritized To return imagery on or after a specified date, use mosaic=earliest in combination with the since parameter.

includestring

Filters surveys so that only those tagged with the type and name specified are returned. Tags are a type:name combination. You can also filter on type and name separately. By comma separating you can include multiple tags, types and/or names. ◾️ type:name, e.g. disaster:hurricane ◾️ type, e.g. disaster ◾️ name, e.g. hurricane Refer to Coverage API - Filter Surveys for further detail on tags.

excludestring

Filters surveys so that only those not tagged with the type and name specified are returned. Tags are a type:name combination. You can also filter on type and name separately. By comma separating you can include multiple tags, types and/or names. ◾️ type:name, e.g. disaster:hurricane ◾️ type, e.g. disaster ◾️ name, e.g. hurricane Refer to Coverage API - Filter Surveys for further detail on tags.

tertiarystring

The tertiary map to return when a Nearmap tile is not found. The available values are: ◾️ none (default) - no tertiary imagery in the background ◾️ satellite - use our current tertiary backdrop Note: Returned tiles will always be blended with tiles from another survey. Tertiary tiles will only be blended when tertiary parameter is not 'none'.

Response

OK. Tile image in requested format.

All 39 operations