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

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

Unique identifier of a survey capture that contains the tile. This ID can be obtained from the Coverage API.

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.

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/*