Skip to content
This repository was archived by the owner on Jan 18, 2023. It is now read-only.

AAL Calculator

Kelvin edited this page May 18, 2021 · 2 revisions

Average Annual Loss Calculator

NOTE: These optional parameters only apply for the property location type.

NOTE: When appending custom "depths" only the depthLoss node is impacted. For all other parameters, the parameter appended will adjust calculations for both depthLoss and annualLoss.

The AAL API accepts optional parameters to impact the AAL calculation. If no parameters are appended, it will provide the AAL costs based on the default values that First Street Foundation has available from 3rd party data providers or calculations.

(More information on the Average Annual Loss calculator can be found on the Calculator Page on the First Street Foundation API Data Dictionary)

Optional Parameters

Parameter Type Description Example
avm int (Positive integers only) The Automated Valuation Model (AVM) or the modeled real estate market value in US dollars for the property. 234212
depths list of int (non-zero integer) The depth in cm of the flood event that the damage should be calculated for. Multiple values accepted, delineated with a comma. [30]
basement boolean Whether or not the building contains a basement. true
floorElevation int The height in centimeters associated with the floor elevation for the building. Additional information can be acquired by querying the Location-FloodElevation product. 22
units int The total number of units the building contains. 2
stories int The total number of stories the building contains. 1
Clone this wiki locally