Page tree

Versions Compared

Key

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

...

Read more about the API URL format.


Info

This API will retrieve tiles up to the maximum zoom level that has been set on the tiles. To allow digital scaling in your application, set the maximum zoom level of the tile source using a mapping framework designed to consume tiled maps such as Google Maps JavaScript APIOpenLayersLeaflet

The advantage of doing this is that it allows the app to be more bandwidth efficient and to upscale on the client. This is more responsive and will consume less network traffic (and less usage for users).


Parameters

RequiredNameAPI / queryTypeDescription

Awesome Icon
color#001E60
iconfa-check-square-o

surveyidAPIstring

The survey ID in the format of UUID. Only tiles of the specified survey will be returned. You can use the ID from the survey object returned by the Coverage API.

Awesome Icon
color#001E60
iconfa-check-square-o

contentTypeAPIstring

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 tileResourceType values are case sensitive.

Awesome Icon
color#001E60
iconfa-check-square-o

zAPIintegerThe zoom level. The highest resolution is typically 21. Uses the Google Maps Tile Coordinates.

Awesome Icon
color#001E60
iconfa-check-square-o

xAPIintegerThe X tile coordinate (column). Uses the Google Maps Tile Coordinates.

Awesome Icon
color#001E60
iconfa-check-square-o

yAPIintegerThe Y tile coordinate (row). Uses the Google Maps Tile Coordinates.

Awesome Icon
color#001E60
iconfa-check-square-o

formatAPIstring

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

Note that imagery is stored on Nearmap's servers as JPEG, so switching to PNG does not result in improvement in quality, however it will increase the size of the response.

Awesome Icon
color#001E60
iconfa-check-square-o

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

...