Page tree

Versions Compared

Key

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

...

Nearmap imagery (tiles) may be requested by URLs in the following formats:

  • http://[RC][NUMBER].nearmap.com/maps?parameters
  • https://[RC][NUMBER].nearmap.com/maps?parameters

Parameters

RequiredNameTypeDescription

RCstringThe region code. For example, au or us. Note: the region code for New Zealand is also au.

NUMBERinteger

The domain rotation number. Valid numbers are 0-3.

Domain rotation is used to drive traffic from multiple domains to a single IP address. 

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

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

zinteger

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

Read about the zoom levels.

nmlstring

The orientation of the imagery:

Vertical Imagery:

  • For vertical imagery, set: nml=V

Panorama Imagery:

  • For North panorama imagery, set: nml=N
  • For East panorama imagery, set: nml=E
  • For South panorama imagery, set: nml=S
  • For West panorama imagery, set: nml=W

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.

excludestringMust be set to background. Used to exclude tertiary satellite imagery when Nearmap imagery is not available.

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

...

Nearmap surveys may be requested by URLs in the following format:

http://[RC][NUMBER].nearmap.com/maps?ll=LAT,LONG&nmq=INFO&nmf=json&z=18&apikey=YOUR_API_KEY

Parameters

RequiredNameTypeDescription

RCstringThe region code. For example, au or us.

NUMBERinteger, integer

The domain rotation number. Valid numbers are 0-3.

Domain rotation is used to drive traffic from multiple domains to a single IP address. 

llintegerLatitude and longitude of the location on which to centre the image, in the format LAT,LONG. For example, 37.334849,-122.008946.

zintegerThe zoom level. The web mercator zoom is used. This parameter must be set to 18.

nmqstring

The request. The parameter must be set to INFO.

nmfinteger

The response format. The parameter must be set to json.

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.

...