v3/{contentType}/{z}/{x}/{y}.{format}

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The resource type for the requested tile. 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 Other tile types may be available depending on the user's subscription. Note that the tileResourceType values are case sensitive.

int64
required

The zoom level. Uses the Google Maps Tile Coordinates. Note that the maximum zoom level is available from the Coverage API.

int64
required

The X tile coordinate (column).

int64
required

The Y tile coordinate (row).

string
required

The format of the tile output, which is dependent on the tile type. Example values for vertical or panorama imagery are: ◾️ jpg - always returns JPEG ◾️ png - always returns PNG ◾️ img - JPEG by default, PNG when the tile is partial Note that imagery is stored on Nearmap's servers as JPEG, so switching to PNG does not result in improvement in quality, however it will increase the size of the response.

Query Params
string

The first day from which to retrieve the tiles (inclusive). The two possible formats are: ◾️ For a specific date: YYYY-MM-DD, e.g. 2015-10-31 to retrieve imagery since this date. ◾️ For a relative date: xxY, xxM, or xxD, e.g. 5M to retrieve imagery since 5 months ago. Notes: ◾️ If specified, the since parameter controls the earliest imagery that is returned. If there are multiple captures after the date specified by the since parameter, the latest imagery is returned. ◾️ If the mosaic parameter is set to earliest, the imagery on or after the date specified by the since parameter is returned. ◾️ If neither since nor until are specified, the request returns the latest imagery.

string

The last day from which to retrieve the tiles (inclusive). The two possible formats are: ◾️ For a specific date: YYYY-MM-DD, e.g. 2015-10-31 to retrieve imagery until this date. ◾️ For a relative date: xxY, xxM, or xxD, e.g. 5M to retrieve imagery until 5 months ago. 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 next available date before the specified date. ◾️ If neither since nor until are specified, the request returns the latest imagery.

string

Specifies the order in which the surveys covering the specified area are prioritized. The available values are: ◾️ latest (default) - the imagery with the later capture date is prioritized ◾️ earliest - imagery with the earlier capture date is prioritized To return imagery on or after a specified date, use mosaic=earliest in combination with the since parameter.

string

Filters surveys so that only those tagged with the type and name specified are returned. Tags are a type:name combination. You can also filter on type and name separately. By comma separating you can include multiple tags, types and/or names. ◾️ type:name, e.g. disaster:hurricane ◾️ type, e.g. disaster ◾️ name, e.g. hurricane Refer to Coverage API - Filter Surveys for further detail on tags.

string

Filters surveys so that only those not tagged with the type and name specified are returned. Tags are a type:name combination. You can also filter on type and name separately. By comma separating you can include multiple tags, types and/or names. ◾️ type:name, e.g. disaster:hurricane ◾️ type, e.g. disaster ◾️ name, e.g. hurricane Refer to Coverage API - Filter Surveys for further detail on tags.

string

The tertiary map to return when a Nearmap tile is not found. The available values are: ◾️ none (default) - no tertiary imagery in the background ◾️ satellite - use our current tertiary backdrop Note: Returned tiles will always be blended with tiles from another survey. Tertiary tiles will only be blended when tertiary parameter is not 'none'.

Responses

400

Bad Request. Returned when the request is invalid. This means either the format is wrong, or a value is out of range.

401

Unauthorized. Returned when the API key is missing or invalid.

403

Forbidden. Returned when not allowed to access the requested location.

404

Not Found. Returned when no tiles were found at the location for the requested survey.

429

Rate limit exceeded. Exponential backoff is recommended. Retry the request later.

500

Internal server error. Returned when something is wrong in the server side.

503

Service is unavailable due to being overloaded. Exponential backoff is recommended. Retry the request later.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
image/*