Use this when you have coordinates (for example from a map click or a GPS reading) and want the single land parcel at that location. You get that parcel and the associated Nearmap content that exists.
For how the API works, see the Content API handbook page.
Request body
POST https://api.nearmap.com/content/v1/search/parcels with Authorization: Apikey <YOUR_API_Key> and a JSON body:
| Field | Required Y/N? | What it is |
|---|---|---|
aoi | Y | A GeoJSON Point: {"type": "Point", "coordinates": [longitude, latitude]}Coordinates are longitude first, then latitude. |
resources | Y | The content you want |
since, until, overlap, limit, cursor | N | As in Search by Address |
Example
curl -X POST "https://api.nearmap.com/content/v1/search/parcels" \
-H "Authorization: Apikey $NEARMAP_API_KEY" \
-H "Content-Type: application/json" \
-d {
"resources": [ { "namespace": "raster", "type": "vert" } ],
"aoi": { "type": "Point", "coordinates": [151.20946760824103, -33.86284118648583] }
}The response has one item in properties: the parcel that contains the point, with its transactionToken.
What it costs
One Property Credit the first time you unlock the parcel. Searching it again in the same subscription period is free.
If it fails
| Error | Most likely cause |
|---|---|
400REQUEST_PARSE_FAILURE | aoi is missing or is not a Point |
400MULTIPLE_PARCELS_FOUND | The point matches more than one parcel: move it inside the parcel you want |
400INVALID_COUNTRY | The point is not in US or AU, or is not in uppercase. |
403 User is not authorized to access this area | The point is outside your subscription's areas, or in a place Nearmap hasn't captured |
404 Property not found | There's no parcel at the point. Check longitude and latitude aren't swapped. |
For a list of all errors, see Content API Error Codes.
