How to specify depth parameter in AAL.get_summary()?

[rht]

The wiki https://github.com/FirstStreet/fsf_api_access_python/wiki/Average-Annual-Loss says

The dollar loss is returned with the associated depth. 1cm, 15cm, or 30cm are returned automatically if no specific depth is appended to the query.

That list (1cm, 15cm, or 30cm) is definitely outdated. Should have been (3cm, 15cm, 31cm).
There is no way to specify the depth from the AAL.get_summary() function.

Additionally, I have observed that the depth loss is always 0, and so I have 6 rows in my CSV output just for one property-level FSID (2 years, 2020 or 2050) x (3 depths, 3, 15, or 31). Is it possible to modify the fsf_api_access library so that the depth information is not included in the resulting CSV, and so will make the CSV 3x smaller in size?

[Lyetenth]

Hi @rht,

Thanks for noticing the typo, the wiki has been updated and a ticket has been put in the backlog to update the FSF API documentation with the updated default depths.

To specify the depth in the AAL.get_summary() function, provide the depth to the extra_param argument in the format specified in the wiki (https://github.com/FirstStreet/fsf_api_access_python/wiki/Average-Annual-Loss) and the AAL calculator (https://github.com/FirstStreet/fsf_api_access_python/wiki/AAL-Calculator). Adjustments of this function are ongoing, and making it simpler to apply to multiple properties are in the backlog, so this format may change.

We have also added additional examples for you in the AAL wiki page which should help clarify the usage format.

If you are seeing a depth loss of 0 for all three default depths, this implies the dollar loss at those depths are 0. Please check your inputs to the function, or try another FSID. For example, the two sample property FSIDs in the example section (FSIDs: 511447411 and 80000002) both return nonzero values for all three default depths.

Unfortunately, since these nonzero (and zero) depth loss values may be valuable for other flood lab members / commercial partners, we won't be able to remove those columns from the library at this time.

Let me know if you have any additional troubles specifying the depth losses in the AAL.get_summary() function

[rht]

Unfortunately, since these nonzero (and zero) depth loss values may be valuable for other flood lab members / commercial partners, we won't be able to remove those columns from the library at this time.

While I understand that you don't want to break compatibility, isn't it still possible to have an optional flag that disables the depth loss column, and so no row explosion?