Coverage API

Use the Nearmap Coverage API to get a list of surveys by date for a location, which you can then use with Nearmap's Tile API.

Use the Coverage API to retrieve metadata about Nearmap surveys for a given location including survey dates, content types, and resolution. Survey IDs returned by this API can then be passed directly to the Tile API to request imagery for a specific capture date.

Choosing the right endpoint

Before querying, decide whether you need survey polygon geometries (the actual coverage outlines) or just survey metadata (dates, resolution, content types). Use the table below to select the appropriate endpoint.

Use CaseAPIInputOutput
Use this API for querying dates and other attributes for a small geographic area. For example, in interactive web applications./coverage/v2/poly/Area of Interest as a polygonMetadata for survey resources that the user can access via the API, taking into account area and content types.
Use this API for querying dates and other attributes for a point. For example, checking if there is Nearmap coverage at a geocoded address./coverage/v2/point/Area of Interest as a pointMetadata for survey resources that the user can access via the API, taking into account area and content types.
Use this API for querying dates and other attributes for a Google x/y/z tile coordinate. Provided for legacy compatibility reasons. Equivalent to the /poly request with the extent of the particular tile./coverage/v2/coord/Area of Interest as a Web Mercator tileMetadata for survey resources that the user can access via the API, taking into account area and content types.
Use this API for visualization of aggregated Nearmap coverage. For example, to create an interactive map that shows where there is Nearmap coverage./coverage/v2/aggregate/boundaries.geojsonNo way to specify the areaAggregated coverage polygons per content type (Vertical, Oblique, 3D), regardless of the user access level.
Use this API for querying the photo timestamps at a point in a survey./coverage/v2/point/{x},{y}/timestamp.jsonDate range using the since and until parametersMetadata related to the photo timestamps for a tile

Using Coverage with the Tile API

  1. Call /coverage/v2/poly/ or /coverage/v2/point/ to get the list of available surveys and their dates for the current map viewport
  2. Display the survey list in a date-picker component
  3. Pass the selected surveyId to the Tile API endpoint /surveys/{surveyId}/{contentType}/{z}/{x}/{y}.{format} to load imagery for that date.