Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

RequiredNameTypeDescription

contentTypestring

The content type for the requested tiles. The 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

Note: the contentType values are case sensitive.

zintegerThe zoom level. The highest resolution is typically 21. Uses the Google XYZ scheme.

xintegerThe X tile coordinate (column). Uses the Google XYZ scheme.

yintegerThe Y tile coordinate (row). Uses the Google XYZ scheme.

formatstring

The format of the tile output. The available values are:

  • JPG - always JPEG
  • PNG - always PNG
  • IMG - JPEG by default, PNG when the tile is partial

tertiarystring

The tertiary map to return when Nearmap tile is not found. The available values are: none, Default.

The default value is none.

Note: returned tiles will always be blended with tiles from another survey. Tertiary tiles will only be blended when tertiary parameter is not 'none'.

sincestring

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

There two possible formats are:

  • For a specific date: YYYY-MM-DD, e.g. 2015-10-31 to retrieve imagery since this date.
  • For a relative date: xxY, xxM, or xxD, e.g. 5M to retrieve imagery since 5 months ago.

Notes:

  • If specified, and imagery at that location at that date exists, the request returns the imagery.
  • If specified, and imagery at that location at that date does not exist, the request returns imagery of the next available date after the specified date.
  • If neither since nor until are specified, the request returns the latest imagery.

untilstring

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

There two possible formats are:

  • For a specific date: YYYY-MM-DD, e.g. 2015-10-31 to retrieve imagery until this date.
  • For a relative date: xxY, xxM, or xxD, e.g. 5M to retrieve imagery until 5 months ago.

Notes:

  • If specified, and imagery at that location at that date exists, the request returns the imagery.
  • If specified, and imagery at that location at that date does not exist, the request returns imagery of the next available date after the specified date.
  • If neither since nor until are specified, the request returns the latest imagery.

apikeystringYour API key. See API Key Authentication for more information.

Example

...

idtalk-87

The following example shows a typical URL request:

...

RequiredNameTypeDescription

surveyidstring

The survey ID in the format of UUID. Only tiles of the specified survey will be returned.

contentTypestring

The content type for the requested tiles. The 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

zintegerThe zoom level. The highest resolution is typically 21. Uses the Google XYZ scheme.

xintegerThe X tile coordinate (column). Uses the Google XYZ scheme.

yintegerThe Y tile coordinate (row). Uses the Google XYZ scheme.

formatstringThe format of the tile output. The available values are : png, jpg, img.

apikeystringYour API key. See API Key Authentication for more information.

Example

The following example shows a typical URL request:

...