Find content for a location and receive a transaction token to retrieve it.
Use this when you know a property's street address. You get the one property at that address and the content Nearmap has for it. For how the API works, see the Content API handbook page.
Request body
POST https://api.nearmap.com/content/v1/search/address with Authorization: Apikey <YOUR_API_Key> and a JSON body:
| Field | Required Y/N? | Description |
|---|---|---|
address.address | Y | The street address, as you'd write it on an envelope |
address.country | Y | US or AU, the country the address is in. The address is only looked up in this country. |
resources | Y | The content you want: at least one namespace and type |
since, until | N | Only content captured in this date range. Default - the last 2 years |
overlap | N | partial or full coverage of the property.Default - partial |
limit, cursor | N | Results per page (up to 300) and the next page. Default - 20 |
Example
curl -X POST "https://api.nearmap.com/content/v1/search/address" \
-H "Authorization: Apikey $NEARMAP_API_KEY" \
-H "Content-Type: application/json" \
-d {
"resources": [ { "namespace": "raster", "type": "vert" } ],
"address": { "address": "6-8 Bulletin Pl, Sydney NSW 2000", "country": "AU" }
}The response has one item in properties- the property at the address, with its transactionToken. Its type is parcel. resources has one item per survey that captured it. To download the content, see "Downloading the content" in the Content API handbook page.
Variations
| To | Add to the body |
|---|---|
| Get imagery and AI features in one search | { "namespace": "ai", "type": "vector_prediction" } in resources |
| Get only captures from the last year | "since": "1Y" |
| Get only captures that cover the whole property | "overlap": "full" |
More variations that work on every search are in the Common Tasks article.
What it costs
One Property Credit the first time you unlock the property. Searching it again in the same subscription period is free. If the address has no parcel, the search covers the area 30 meters around it instead and you use a credit for each property in that area.
Also in Search by Address, the 404 Property not found row in “If it fails”: the address doesn’t exist, or country doesn’t match it.
If it fails
| Error | Most likely cause |
|---|---|
400 REQUEST_PARSE_FAILURE | address.address or address.country is missing |
400 INVALID_ADDRESS | address.address contains only spaces |
400 INVALID_COUNTRY | country isn't US or AU, or is not in upper case |
400 MULTIPLE_PARCELS_FOUND | The address matches more than one parcel: add a unit or lot number |
404 Property not found | The address doesn't exist, or country doesn't match it |
All errors: Content API Error Codes.
