In this guide:
So you're developing an app. We've got maps for that.
Nearmap APIs allow developers to build custom applications with our library of rich, high resolution imagery and location content. Our APIs are consistent, secure, and easy to manage, with a wide range of use cases and platforms. More importantly, Nearmap content is dynamically updated so you can confidently develop applications and technology solutions with access to the latest data from a single source of truth.
Check out our list of application partners on our website, and don't forget to share your creation with us so that we can showcase your work, too.
Let’s get started!
- Which API should I use?
- How do I generate API keys?
Which API should I use?
Discover which API is right for your development project and explore the details in technical documentation and API reference guides.
Nearmap’s WMS 2.0 is a GIS industry standard Web Mapping Service API. For most GIS and CAD applications, it’s a simple as pasting in your Nearmap WMS 2.0 key – and you’re up and running with on-demand Nearmap Vertical imagery.
Nearmap’s WMS 2.0 gives you:
- the ability to select the dates you want
- a wide selection of projections. In fact, all other Nearmap APIS only support the Web Mercator projection, so we recommend Nearmap’s WMS 2.0 if you need projections other than Web Mercator.
- the ability to restrict your imagery by area and by time (You can set this by generating a custom WMS 2.0 service)
WMS 2.0 is great for consuming Nearmap Vertical content on-demand pretty much out-of-the-box. You can also use our Tile API out-of-the-box in ArcGIS Online by adding a Tile Layer from the Web.
However, if you’re looking to use Nearmap content as a basemap in your own application, or if you want to use Nearmap imagery for analysis rather than display, then you need to integrate our Tile API into your development. To do this you would most likely use a third-party framework such as OpenLayers or Google SDK.
Tile API uses Google Maps Tile Coordinates to map our survey photos into a pyramid of 256x256-pixel map tiles at multiple zoom levels. Applications developed with Tile API typically download a collection of adjacent tiles to cover a given region.
The Tile API lets you access Nearmap Vertical and – provided your subscription includes Obliques – you can also use Tile API to access Panorama Imagery.
Using only Nearmap’s Tile API you can retrieve tiles for a specified location and filter by date or by survey.
If you want to use Nearmap imagery as the base map in a web application, with the ability to pan, zoom and change dates, use our in conjunction with our .
Coverage API tells you whether your area has coverage and what types of image are available for that location.
The the easiest way to display a single Vertical image in a web page is by using our Image API. This is useful for, say, a real estate application, where you want your own content plus Nearmap Vertical imagery shown for a single property, or to include in a report.
Imagery displayed using the Image API will carry the Nearmap watermark.
Using Coverage API alongside Image API will help you manage how and when your application sources it imagery. For example, Coverage API will tell you if Nearmap imagery exists for a location, allowing you to design in an alternative imagery source for that location.
DSM and TrueOrtho API
Let’s say you are building a solar or roofing application and you want to automatically extract data like building height and roof features?
The DSM and True Ortho API is ideal for applications like these – providing the critical truth on the ground that allows calculation of solar irradiance, shadowing, or roof complexity at scale.
Available in North America and Australia, Nearmap’s DSM – digital surface model – is a data set that includes the elevation of all the built and natural objects on the Earth’s surface. It is a product of our 3D content, and is therefore high resolution, wide-scale and updated regularly.
Nearmap True Ortho is a seamless 2D image of the Earth’s surface that has been “orthorectified” (that is, all building lean has been removed). TrueOrtho is perfectly aligned with Nearmap DSM, allowing you to view, edit and analyse features from the DSM using the True Ortho as a visual guide. The result is a fabulously fast and accurate way to automate jobs on a massive scale.
This API is designed to work with smaller areas, such as typical residential and small commercial properties. The initial API call generates a Transaction Token which is valid for a specified coverage area. Your Transaction Token is valid for 30 days, during which time you can construct any number of image type requests for the same coverage area.
Generate API keys
As a Nearmap user, you can create your own API key in MyAccount so you can use Nearmap imagery in other applications. Nearmap APIs come with in-built API Key authentication, which means you do not have to provide your Nearmap username and password as authentication credentials.
If there is no application in the drop-down list, or the API Application you want is not there, contact your organisation's Nearmap administrator. Alternatively, learn how to create or manage an API application as a Nearmap Administrator.
Ready to learn more?
Also in the Getting Started series...
- Getting Started Series
- Getting to Know the Knowledge Hub
- Getting Started as a Nearmap Administrator
- Getting Started as a Nearmap User
- Getting Started with MapBrowser
- Getting Started with Integrations
- Getting Started with Nearmap Content
- Getting started with Nearmap on OpenSolar
- Getting Started with WMS 2.0
- Getting Started with Nearmap APIs
- Getting Started with Nearmap Vertical
- Getting Started with Nearmap Oblique
- Getting started with Nearmap 3D
- Getting started with Nearmap AI