Page tree

Versions Compared

Key

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

...

Access to Nearmap imagery is only available to authenticated subscribers. Tiles may be requested from Nearmap servers with an API Key. Please refer to the API Key Authentication guide for details on how to obtain and use an API Key.

...

RequiredNameAPI / queryTypeDescription

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

tileResourceTypeAPIstring

The resource 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

zAPIinteger

The zoom level. Uses the Google Maps Tile Coordinates.

Note: the maximum zoom level is available from the Coverage API.

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.

Awesome Icon
color#001E60
iconfa-square-o

tertiaryquerystring

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

Awesome Icon
color#001E60
iconfa-square-o

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

The 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, the since parameter controls the earliest imagery that is returned. If there are multiple captures after the date specified by the since parameter, the latest imagery is returned.

  • If the mosaic parameter is set to earliest, the imagery on or after the date specified by the since parameter is returned.

  • If neither since nor until are specified, the request returns the latest imagery.

Awesome Icon
color#001E60
iconfa-square-o

untilquerystring

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

The 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 before the specified date.
  • If neither since nor until are specified, the request returns the latest imagery.

Awesome Icon
color#001E60
iconfa-square-o

mosaicquerystring

Specifies the order in which the surveys covering the specified area are prioritised.

The available values are:

  • latest - the imagery with the later capture date is prioritised

  • earliest - imagery with the earlier capture date is prioritised

If the mosaic parameter is not specified, the imagery with the later capture date is prioritised.

To return imagery on or after a specified date, use mosaic=earliest in combination with the since parameter.

...

These examples use a demo API key. Replace this API key with your own when using the Tile API.

The following example shows a typical URL request:Australia

Code Block
themeEclipse
https://api.nearmap.com/tiles/v3/Vert/21/1855981/1265938.jpg?apikey=Yzc2MjEzMWUtY2Q4YS00NTM2LTgyMDgtMDljZjI2YTdhMTMz

...

Code Block
themeEclipse
https://api.nearmap.com/tiles/v3/Vert/21/1855981/1265938.jpg?apikey=Yzc2MjEzMWUtY2Q4YS00NTM2LTgyMDgtMDljZjI2YTdhMTMz&until=2018-08-01


US

Code Block
themeEclipse
https://api.nearmap.com/tiles/v3/Vert/19/119799/215845.jpg?apikey=ZGE4MTdmNWYtZTdiNS00ZDRkLTg3MzItYjYwMzAyMzM5MjI0


Responses

The possible HTTP response status codes to the URL request are:

...

Read more about the API URL format.


Info

Note: This API will retrieve tiles up to the maximum zoom level of that has been tile set on the tiles. To allow digital scaling to zoom beyond the resolution at which the survey was captured 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 APIOpenLayersLeafletwe recommend you investigate client side up-scaling. Some of the popular applications and mapping frameworks support this functionality.

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

...

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.

Example

...

Examples

Australia

Code Block
themeEclipse
https://api.nearmap.com/tiles/v3/surveys/100-4c51ffe8-ab52-11e8-9b7a-b3f8ca0bcb81/Vert/16/57999/39561.jpg?apikey=Yzc2MjEzMWUtY2Q4YS00NTM2LTgyMDgtMDljZjI2YTdhMTMz


US

Code Block
themeEclipse
https://api.nearmap.com/tiles/v3/surveys/88f1c072-0bdd-11ea-b266-130e886a3ec4/Vert/19/119799/215845.jpg?apikey=ZGE4MTdmNWYtZTdiNS00ZDRkLTg3MzItYjYwMzAyMzM5MjI0

Responses

The possible HTTP response status codes to the URL request are:

...