Overview
The Nearmap ImpactAssessment AI product comprises a selection of Gen 5 AI layer vectors, bundled in a special pack, is now available for ImpactResponse. With this layer data, you can perform a preliminary assessment of damages caused by a catastrophic event to plan the appropriate response.
You can access assessment data in ImpactAssessment AI via the APIs if you have a subscription for both the Nearmap ImpactResponse (Disaster Coverage) and Transactional Content API products.
You can access ImpactAssessment AI using the Transactional Content API.
NOTE: ImpactAssessment AI provides insights specific to the survey date, and does not take into consideration the imagery from any earlier or later dates.
NOTE: We recommend that you cross-check the results from this with MapBrowser imagery or imagery from another source. For more information, see https://help.nearmap.com/kb/articles/874-statistical-performance.
ImpactAssessment AI layers
The following Gen 5 AI vector layers are available in the ImpactAssessment attributes for catastrophic events:
Accessing ImpactAssessment AI
To access ImpactAssessment AI data, complete the following steps:
- Generate a transaction token and aiResourceid - The parameters that need to be passed to generate a transaction token are explained below. The transaction token is valid for 30 days, and can be used any number of times in that duration.
- Request data using the AI Feature API - You must have a transaction token to do this. The parameters that need to be passed to generate an output file are explained below.
Mandatory parameters are indicated with a ✔️, while ❌ indicates optional parameters.
Authentication
Access to Nearmap data is only available to authenticated subscribers. ImpactAssessment AI data may be requested from Nearmap servers with an API Key. Refer to the API Key Authentication guide for details on how to obtain and use an API Key.
Generating the transaction token
To generate the transaction token, provide the following information.
Required | Name | Type | Description |
|---|
✔️ | address or poly | string | Complete address of the parcel including the country. For example, 333 Guadalupe st, Austin, TX 78701, USA. Note that you can specify this in any case.
OR
The polygon for which you want to retrieve surveys. The polygon is specified by a set of latitude and longitude pairs, where the first and the last points must be the same. |
✔️ | country | string | This can take the value US or AU. This is not case sensitive, and is only valid for an address. |
✔️ | dates | string | Set this to "single", which is the only acceptable value for this parameter. This uses the latest survey as a default. |
❌ | since and until | string | Use these optional parameters to specify a date range to access historical surveys. Specify the dates in the format YYYY-MM-DD. For example, since=2010-01-01&until=2012-01-01 will return the latest survey in this date range while since=2010-01-01&until=2010-01-01 will return a survey on that specific date. |
✔️ | resources | string | Set this to aiImpactAssessment:postcat. |
| | | |
Example URL to request the transaction token
https://api.nearmap.com/coverage/v2/tx/poly/$aoi?dates=all&resources=aiImpactAssessment:postcat&apikey=$<your_API_key_for_authentication>
Once generated, the transaction token is a long sequence of numbers, letters and symbols stored in the transactionToken field.
Requesting ImpactAssessment layers
Use the following URL to request data using the AI Feature API:
https://api.nearmap.com/ai/features/v4/tx/surveyresources/{aiResourceId}/features.json?transactionToken={transactionToken}
All available ImpactAssessment AI data will be returned.
