API Reference

v1 /properties/aoi

post
https://api.nearmap.com/property/resources/v1/properties/aoi
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
aoi
required
resources
array of objects
required

Resources determine which types of coverage are returned.

See also: https://github.com/nearmap/api-team/blob/master/technical/design/highlander_api_design.md#supported-resources

resources*
string

First day from which to retrieve the surveys (inclusive). Must be of the form "YYYY-MM-DD" or as a relative date relative date "xxY", "xxM", "xxD" where 5M represents since 5 months ago.

string

Last day from which to retrieve the surveys (inclusive). Must be of the form "YYYY-MM-DD" or as a relative date relative date "xxY", "xxM", "xxD" where 5M represents until 5 months ago.

string
enum
Defaults to partial
  • partial allows returning metadata for imagery that partially intersects the requested area (or fully contains it).
  • full will only returns resources fully containing the requested area.
Allowed:
integer
Defaults to 20

Max number of resources in the result. Maximum is 300

string

Cursor value for next page is provided in the search result.

Responses

401

The caller has not provided valid authentication credentials

Updated about 16 hours ago

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

Updated about 16 hours ago