Introduction

Nearmap API services allow users to load Nearmap high-resolution imagery on demand.  There are two available services:

  • Simple - provides a URL to access latest Nearmap Vertical imagery using WMS 2.0 or Google Earth.
  • Custom - allows users of off-the-shelf GIS and CAD applications to define custom areas of interest and get a personalised WMS 2.0 URL with these areas only. A maximum of 10 areas of interest can be defined within one custom service.

To consume Nearmap imagery via WMS  or Google Maps, you must authenticate using API Key Authentication, and obtain either a Simple URL or a Custom URL to load in the application.

Once authenticated, your software package will have a way for you to specify:

  • The Nearmap layer you want to view
  • The coordinate reference system you want to use to view the layer

Nearmap will provide the best projection for the WMS 2.0 imagery. Once you use either simple or custom WMS 2.0 in an application, the service will update with the new imagery every time Nearmap publishes a new survey.

Accessing API services

In order to obtain either a Simple or a Custom URL, you will need to access API Services on MyAccount.

You can either use this direct link: https://apps.nearmap.com/account/integration/services  or follow these steps:

  1. Log in to Nearmap at  https://apps.nearmap.com/account
  2. Click the Integrations tab.


Make sure you have an API Application, as well as an API Key. If you don't have an application, contact your administrator. 


About WMS 2.0

Nearmap WMS integration allows users of off-the-shelf GIS and CAD applications to load high-resolution imagery on demand.

To consume Nearmap imagery via WMS, you must authenticate using API Key Authentication, and obtain either a Simple WMS URL or a Custom WMS URL to load in the application.

Once authenticated, your software package will have a way for you to specify:

  • The Nearmap layer you want to view
  • The coordinate reference system you want to use to view the layer

Nearmap will provide the best projection for the WMS imagery. 


Image format recommendations

Nearmap supports PNG and JPEG through the WMS service. Most WMS applications will request maps from a WMS server using PNG by default. When loading raster maps, such as Nearmap imagery, PNG has several advantages and several disadvantages. Please see below the recommendations for configuring your application.

When to Use PNG

PNG has a transparency channel, which means you can overlay Nearmap imagery on top of another basemap (for example a worldwide satellite layer or a roadmap). This works best when at small scale, for example when using a city or statewide extent. Note that PNG imagery is not compressed as much as JPEG and it will take longer to download. 


When to Use JPEG

Use JPEG for working with imagery at large scale. At house or suburb level, the chances of being on the Nearmap boundary are much smaller, which means that you won't need the transparency capability of PNG. Note that if you do come across a boundary, the areas with no data are rendered as black.


Datum changes

We support the most popular local datums for all of our imagery. Depending on which coordinate system your GIS application is configured with, you can request imagery in the following coordinate systems:

  • Australia - GDA94 and GDA2020

  • USA - NAD83

  • Canada - NAD83CSRS

  • New Zealand - NZGD2000 

When requesting imagery using WGS84 coordinate systems, namely EPSG:4326 (WGS 84) and EPSG:3857 (Web Mercator, Spherical Mercator, Pseudo-Mercator), our WMS service will automatically return imagery that has been converted to a local datum as per the table below.

SRS

Australia

Canada

New Zealand

United States

EPSG:3857/EPSG:4326

GDA2020

NAD83CSRS

NZGD2000

NAD83

For Australian Customers – assumed datum

Several web applications assume GDA94 where the datum is not specified. You can see from the table above that in Australia, Nearmap WMS 2.0 defaults to GDA2020. We provide a way to force the returned imagery to GDA94 with a custom request parameter  DATUM . The behaviour of this parameter depends on the projection the imagery is requested in (SRS Parameter), as shown in the table below.

Projection

DATUM=GDA94

DATUM is omitted (default behaviour)

EPSG:4326 (aka WGS84)

GDA94

GDA2020

EPSG:3857 (aka Web Mercator)

GDA94

GDA2020

Any MGA94 projection

GDA94

GDA94

Any MGA2020 projection

GDA2020

GDA2020


What is the advantage of this?

If your application relies on assumed GDA94, the alignment and accuracy can be improved by a significant margin, as you can see in the images below.

Default behaviour

With GDA94 override


FAQs

  • Page:
    Is there a way to know what is the date of the latest imagery? —

    Yes, in custom WMS you can know the date of the latest imagery, while in simple WMS you cannot. When you bring in the in the custom WMS the date layers are synced up to the latest imagery, and you know exactly which dates you are bringing in. With simple WMS there is no way to get at the dates, since it is a very simple lightweight service.
  • Page:
    Is WMS 2.0 more accurate than what I am currently using? —

    Australia - We have adjusted the datum of the imagery that is returned by default when you don’t specify a projection, i.e. rely on application defaults. WMS 2.0 will automatically adjust the imagery to GDA2020 coordinate system for Australia and NZGD2000 for New Zealand. This will reduce positional errors and projection mismatches ensuring your imagery lines up. WMS 2.0 will continue to support the GDA94 MGA zone projections in Australia.
  • Page:
    What are the best practices for defining areas? —

    Use simple boundaries around your areas of interest. The imagery is not requested until you interact with the application, so there is little difference in what imagery is returned when the custom service is used.
  • Page:
    Should I use Simple or Custom WMS? —

    The simple WMS should be used if you want the only latest imagery for your area (Australia/New Zealand/USA/Canada). You will not be able to perform geofencing or navigate time. Custom WMS will allow you to perform geofencing and to set up specified regions as the only imagery you can view. For those regions, you will be able to navigate the time and set boundaries for the dates.
  • Page:
    Can we limit the date range when creating the custom polygon? —

    Yes, the custom WMS allows you to limit the date range. You can specify either start date or end date, or both. It limits the surveys you get back as layers in your service. 
  • Page:
    Can I specify a polygon programmatically? —

    No, you cannot create a polygon programmatically. 
  • Page:
    When loading into QGIS without the satellite imagery, why wasn't I able to remove the black around the aerial imagery? —

    This is probably because your layer is brought through QGIS by default with JPEG. JPEG does not have transparency support, so when there are areas with no data, they are displayed as black. We recommend that if you want to look at a zoomed out version of Nearmap imagery, for example when you're looking at a whole city or state, bring it in as PNG. If you're working mainly with zoomed in imagery, bring it in as JPEG. 
  • Page:
    Can I upload a KML/Shapefile/FileGeoDatabase to define my areas to limit usage to precisely my areas? —

    No, you need to draw your areas, and the usage is only incurred at the time of browsing imagery in your GIS application.
  • Page:
    What do you see if you constrict start and end dates? —

    When you constrain a start date, to exclude older imagery, for an area if no more recent imagery is available, is a blank layer returned or your default, low-res (old) satellite imagery?  It would be very useful to see that there is no recent imagery after the constrained end date.

    You simply get no layers if you create an area with a polygon and restrict the dates to a particular range. The satellite layer, which was by default included in our last version of WMS, is no longer included in the responses, so you do not get satellite imagery unless you explicitly ask for it. So yes, it would be possible to see that there is no recent imagery after the constrained end date. 
  • Page:
    If we create many areas, does it have a performance impact? —

    The performance impact is not so much dependent on the size of the area, but on the number of surveys you bring back. There is a limit on how big an individual area can be, currently set at about 5000 km2, and you can specify up to ten areas in the same service. If you bring in ten metropolitan areas around Australia, you could be loading thousands of surveys. That would slow down your initial loading into your GIS application.
  • Page:
    How do I use State Plane projections? —

    Only available in Custom WMS. Only the state plane projections that intersect with the area of interest will be available as an option to request imagery in.
  • Page:
    How do I use GDA2020 projections? —

    For Simple WMS all AU MGA zones are available in both GDA94 and GDA2020. For Custom WMS only the zones that intersect with the area of interest will be available as an option to request imagery in.
  • Page:
    Are there limits to the Custom WMS services? —
    • Maximum number of WMS places - 50
    • Maximum number of areas per place - 10
    • Maximum area size - 15,000 km²
  • Page:
    When selecting an area can I select our local government boundary? —

    Yes, you can select any area, and it doesn't have to be exact. You will need to draw the area though, you cannot import your boundaries.

    When you create an area in the self-service API portal, you're defining a template/metadata for that particular service, at that point no data is downloaded. We recommend that when you are interested in an area you roughly sketch out around that area, it doesn't matter if it is not following your local government area boundaries. The data is only downloaded when you bring it into the application, and you start interacting with the imagery in the application. 
  • Page:
    Does interacting with the imagery in the area definition window count towards my usage? —

    Yes. When you define an area, a small amount of imagery is loaded to provide context for where we have coverage. We envisage that there will be very little usage coming from this tool because:

    • The map is very small, i.e. not full screen
    • It is used infrequently to create services