Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

https://api.nearmap.com/coverage/v2/poly/{polygon}?apikey={YOUR_API_KEY}

Read more about the API URL format.

Parameters

RequiredNameAPI / queryTypeDescription

Awesome Icon
color#001E60
iconfa-check-square-o

polygon

APIstring

The polygon for which the surveys are retrieved. The polygon is depicted by a set of LONG,LAT points, when the last point and the first point must be the same.

For example:

138.59707796614592,-34.91729448760797

138.61703360121672,-34.91729448760797

138.61703360121672,-34.927709974005474

138.59707796614592,-34.927709974005474

138.59707796614592,-34.91729448760797

 Note: the API returns all surveys partially intersecting the requested polygon.

Awesome Icon
color#001E60
iconfa-check-square-o

apikeyquerystringYour API key. See API Key Authentication for more information.

Awesome Icon
color#001E60
iconfa-square-o

since

Anchor
since
since

querystring

The first day from which to retrieve the surveys (inclusive).

The two possible formats are:

  • For a specific date: YYYY-MM-DD, e.g. 2015-10-31 to retrieve surveys since this date.
  • For a relative date: xxY, xxM, or xxD, e.g. 5M to retrieve surveys since 5 months ago.

 The since and until parameters are used to further restrict the surveys that are returned.

Awesome Icon
color#001E60
iconfa-square-o

until

Anchor
until
until

querystring

The last day from which to retrieve the surveys (inclusive).

The two possible formats are:

  • For a specific date: YYYY-MM-DD, e.g. 2015-10-31 to retrieve surveys until this date.
  • For a relative date: xxY, xxM, or xxD, e.g. 5M to retrieve surveys until 5 months ago.

 The since and until parameters are used to further restrict the surveys that are returned.

Awesome Icon
color#001E60
iconfa-square-o

limitqueryinteger

The limit of the total number of surveys returned. The default value is 20. The surveys are returned from the most recent to the least recent survey.

Awesome Icon
color#001E60
iconfa-square-o

offsetqueryinteger

The offset of the first survey to be displayed. With no offset, the first survey to be displayed is the most recent one. If the offset is 3 for example, the first survey to be displayed is the 4th recent one.

Awesome Icon
color#001E60
iconfa-square-o

fields

Anchor
fields
fields

querystring

This is a comma-separated list of field names that will appear in the response.

The id field will always be among the returned fields, even if not specified.

If this parameter is not used in the URL request, then all the fields are returned.

The available values are:

  • captureDate
  • firstPhotoTime
  • id
  • lastPhotoTime
  • location
  • onlineTime
  • pixelSize
  • resources
  • timezone
  • utcOffset

Note: the fields values are case sensitive.

Awesome Icon
color#001E60
iconfa-square-o

sort

Anchor
sort
sort

querystring

The field by which to sort the surveys.

Only one field can be specified.

If this parameter is not used in the URL request, then the surveys are sorted by captureDate in descending order.

To sort in ascending order, pass the field name, e.g sort=lastPhotoTime. This will sort the surveys according to the lastPhotoTime from earliest to latest.

To sort in descending order, pass the field name with the "-" prefix, e.g. sort=-pixelSize. This will sort the surveys according to the pixelSize from the largest to the smallest.

If you sort by location, the following are the precedence rules for comparing location objects:

  • country
  • state
  • region

For example, "NZ, MWT, PalmerstonNorth" will come after "AU, NSW, Williamstown" if sorted in ascending order.

The available values are:

  • captureDate
  • firstPhotoTime
  • id
  • lastPhotoTime
  • location
  • onlineTime
  • pixelSize
  • timezone
  • utcOffset

...

https://api.nearmap.com/coverage/v2/point/{point}?apikey={YOUR_API_KEY}

Read more about the API URL format.

Parameters

RequiredNameAPI / queryTypeDescription

Awesome Icon
color#001E60
iconfa-check-square-o

pointAPIstringThe point for which the surveys are retrieved. The point is the latitude and longitude of the location on which to center the image, in the format LONG,LAT. For example, -122.008946,37.334849.

Awesome Icon
color#001E60
iconfa-check-square-o

apikeyquerystringYour API key. See API Key Authentication for more information.

Awesome Icon
color#001E60
iconfa-square-o

sincequerystring

The first day from which to retrieve the surveys (inclusive).

The two possible formats are:

  • For a specific date: YYYY-MM-DD, e.g. 2015-10-31 to retrieve surveys since this date.
  • For a relative date: xxY, xxM, or xxD, e.g. 5M to retrieve surveys since 5 months ago.

Awesome Icon
color#001E60
iconfa-square-o

untilquerystring

The last day from which to retrieve the surveys (inclusive).

The two possible formats are:

  • For a specific date: YYYY-MM-DD, e.g. 2015-10-31 to retrieve surveys until this date.
  • For a relative date: xxY, xxM, or xxD, e.g. 5M to retrieve surveys until 5 months ago.

Awesome Icon
color#001E60
iconfa-square-o

limitqueryinteger

The limit of the total number of surveys returned. The default value is 20. The surveys are returned from the most recent to the least recent survey.

Awesome Icon
color#001E60
iconfa-square-o

offsetqueryintegerThe offset of the first survey to be displayed. With no offset, the first survey to be displayed is the most recent one. If the offset is 3 for example, the first survey to be displayed is the 4th recent one.

Awesome Icon
color#001E60
iconfa-square-o

fieldsquerystring

This is a comma-separated list of field names that will appear in the response.

The id field will always be among the returned fields, even if not specified.

If this parameter is not used in the URL request, then all the fields are returned.

The available values are:

  • captureDate
  • firstPhotoTime
  • id
  • lastPhotoTime
  • location
  • onlineTime
  • pixelSize
  • resources
  • timezone
  • utcOffset

Note: the fields values are case sensitive.

Awesome Icon
color#001E60
iconfa-square-o

sortquerystring

The field by which to sort the surveys.

Only one field can be specified.

If this parameter is not used in the URL request, then the surveys are sorted by captureDate in descending order.

To sort in ascending order, pass the field name, e.g sort=lastPhotoTime. This will sort the surveys according to the lastPhotoTime from earliest to latest.

To sort in descending order, pass the field name with the "-" prefix, e.g. sort=-pixelSize. This will sort the surveys according to the pixelSize from the largest to the smallest.

If you sort by location, the following are the precedence rules for comparing location objects:

  • country
  • state
  • region

For example, "NZ, MWT, PalmerstonNorth" will come after "AU, NSW, Williamstown" if sorted in ascending order.

The available values are:

  • captureDate
  • firstPhotoTime
  • id
  • lastPhotoTime
  • location
  • onlineTime
  • pixelSize
  • timezone
  • utcOffset

...

https://api.nearmap.com/coverage/v2/coord/{z}/{x}/{y}?apikey={YOUR_API_KEY}

Read more about the API URL format.

Parameters

RequiredNameAPI / queryTypeDescription

Awesome Icon
color#001E60
iconfa-check-square-o

zAPIinteger

The zoom level. The highest resolution is typically 21. Uses the Google Maps Tile Coordinates.

Awesome Icon
color#001E60
iconfa-check-square-o

xAPIintegerThe X tile coordinate for which the surveys are retrieved (column). Uses the Google Maps Tile Coordinates.

Awesome Icon
color#001E60
iconfa-check-square-o

yAPIintegerThe Y tile coordinate for which the surveys are retrieved (row). Uses the Uses the Google Maps Tile Coordinates.

Awesome Icon
color#001E60
iconfa-check-square-o

apikeyquerystringYour API key. See API Key Authentication for more information.

Awesome Icon
color#001E60
iconfa-square-o

since

querystring

The first day from which to retrieve the surveys (inclusive).

There two possible formats are:

  • For a specific date: YYYY-MM-DD, e.g. 2015-10-31 to retrieve surveys since this date.
  • For a relative date: xxY, xxM, or xxD, e.g. 5M to retrieve surveys since 5 months ago.

Awesome Icon
color#001E60
iconfa-square-o

untilquerystring

The last day from which to retrieve the surveys (inclusive).

There two possible formats are:

  • For a specific date: YYYY-MM-DD, e.g. 2015-10-31 to retrieve surveys until this date.
  • For a relative date: xxY, xxM, or xxD, e.g. 5M to retrieve surveys until 5 months ago.

Awesome Icon
color#001E60
iconfa-square-o

limitqueryinteger

The limit of the total number of surveys returned. The default value is 20. The surveys are returned from the most recent to the least recent survey.

Awesome Icon
color#001E60
iconfa-square-o

offsetqueryintegerThe offset of the first survey to be displayed. With no offset, the first survey to be displayed is the most recent one. If the offset is 3 for example, the first survey to be displayed is the 4th recent one.

Awesome Icon
color#001E60
iconfa-square-o

fieldsquerystring

This is a comma-separated list of field names that will appear in the response.

The id field will always be among the returned fields, even if not specified.

If this parameter is not used in the URL request, then all the fields are returned.

The available values are:

  • captureDate
  • firstPhotoTime
  • id
  • lastPhotoTime
  • location
  • onlineTime
  • pixelSize
  • resources
  • timezone
  • utcOffset

Note: the fields values are case sensitive.

Awesome Icon
color#001E60
iconfa-square-o

sortquerystring

The field by which to sort the surveys.

Only one field can be specified.

If this parameter is not used in the URL request, then the surveys are sorted by captureDate in descending order.

To sort in ascending order, pass the field name, e.g sort=lastPhotoTime. This will sort the surveys according to the lastPhotoTime from earliest to latest.

To sort in descending order, pass the field name with the "-" prefix, e.g. sort=-pixelSize. This will sort the surveys according to the pixelSize from the largest to the smallest.

If you sort by location, the following are the precedence rules for comparing location objects:

  • country
  • state
  • region

For example, "NZ, MWT, PalmerstonNorth" will come after "AU, NSW, Williamstown" if sorted in ascending order.

The available values are:

  • captureDate
  • firstPhotoTime
  • id
  • lastPhotoTime
  • location
  • onlineTime
  • pixelSize
  • timezone
  • utcOffset

...