Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Introduction

Nearmap provides access to its vertical imagery via a subset of the Tile Map Service (TMS) protocol. TMS splits a map into a pyramid of 256x256-pixel map tiles at multiple zoom levels. An application typically downloads a collection of adjacent tiles to cover a given region.

Only the Web Mercator projection is supported by Nearmap’s TMS (EPSG:3857; also known as EPSG:3785 and EPSG:900913). Nearmap’s Web Map Service (WMS) is recommended for other projections.

Authentication

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.

Nearmap Tile API consists of a number of individual HTTPS APIs, which are used in conjunction with Coverage API

URL Requests

Nearmap's Tile API is designed to be accessed by an application in an automated fashion via URL requests. We recommend that you use a mapping framework designed to consume tiled maps, such as Google Maps JavaScript API,  OpenLayers,  Leaflet, etc.

Available APIs

There are two Tile APIs: 

In addition, there are three Coverage APIs that are used in conjunction with the Tile APIs:

Retrieve Tiles

Parameters

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

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.

tertiarystring

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

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

nmdinteger

The date in the format YYYYMMDD. For example, 20151031.

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 closest previous date.
  • If not specified, the request returns the latest imagery.

See Getting a List of Surveys by Date for a Location for instructions on retrieving options for setting this parameter.

nmdinteger

The date in the format YYYYMMDD. For example, 20151031.

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 closest previous date.
  • If not specified, the request returns the latest imagery.

See Getting a List of Surveys by Date for a Location for instructions on retrieving options for setting this parameter.

version
The version number. Must be set to 2.

httpauthBooleanIndicates whether the tile server should prompt for HTTP basic authentication. Set this to false (we no longer support HTTP basic authentication).

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

Examples

The following examples show two typical URL requests, one over http, and the other over https:

http://au0.nearmap.com/maps?x=115995&y=79117&z=17&nml=v&version=2&httpauth=false&apikey=ZjNhZDkyNDUtZjIyMS00NTkwLWJlMzYtZDJlNWUyNDkxNjE4

https://us1.nearmap.com/maps?x=119799&y=215845&z=19&nml=v&version=2&httpauth=false&apikey=ZjNhZDkyNDUtZjIyMS00NTkwLWJlMzYtZDJlNWUyNDkxNjE4

Getting a List of Surveys

Please refer to Getting a List of Surveys to learn how to get a list of surveys by date for a location, and to understand the survey lists in the JSON response.


  • No labels