Endpoint: single_building_query
This endpoint accepts an address-based location input with built-in geocoding. It returns flood risk and loss estimates for fluvial, coastal, and pluvial hazards, as well as the wildfire risk index.
Note: The
financialsection of the payload is optional and requires a subscription to the Geosapiens Financial module. Including it allows the API to calculate loss values (AAL and PML) for structures, inventory, and equipment.
URI
POST /mediator/single_building_query
Payload
{
"location": {
"streetAddress": "9 101A Ave",
"city": "Edmonton",
"areaName": "Alberta",
"postalCode": "T5H 0B9",
"countryName": "Canada"
},
"financial": {
"typeOfBusiness": "RESIDENTIAL",
"basement": "YES",
"numberOfStoreys": "TWO STORY",
"firstFloorHeight": 0.15,
"structureDeductible": 10000,
"inventoryDeductible": 10000,
"equipmentDeductible": 10000,
"structureTIV": 1000000,
"inventoryTIV": 1000000,
"equipmentTIV": 1000000
}
}
Response
Returns flood indices, flood scores, and loss values for fluvial, coastal, and pluvial hazards, along with the wildfire index.
{
"uuid": "6ae47547-c18e-483a-99e5-a0b6456fddf5",
"timeStamp": "2025-10-16 22:12:54 UTC",
"type": "OK",
"description": "The request has succeeded.",
"statusCode": 200,
"status": "OK",
"fluvialFloodIndex": 6,
"fluvialStructureFloodScore": 4,
"fluvialStructureAal": 1813,
"fluvialStructureAalDefFail": 1813,
"fluvialStructureAalDefOverTop": 1813,
"fluvialStructurePml1500": 179021,
"fluvialStructurePml1500DefFail": 179021,
"fluvialStructurePml1500DefOverTop": 179021,
"fluvialInventoryAal": 1438,
"fluvialInventoryAalDefFail": 1438,
"fluvialInventoryAalDefOverTop": 1438,
"fluvialInventoryPml1500": 148783,
"fluvialInventoryPml1500DefFail": 148783,
"fluvialInventoryPml1500DefOverTop": 148783,
"fluvialEquipmentAal": 1438,
"fluvialEquipmentAalDefFail": 1438,
"fluvialEquipmentAalDefOverTop": 1438,
"fluvialEquipmentPml1500": 148783,
"fluvialEquipmentPml1500DefFail": 148783,
"fluvialEquipmentPml1500DefOverTop": 148783,
"coastalFloodIndex": 1,
"coastalStructureFloodScore": 0,
"coastalStructureAal": 0,
"coastalStructureAalDefFail": 0,
"coastalStructureAalDefOverTop": 0,
"coastalStructurePml1500": 0,
"coastalStructurePml1500DefFail": 0,
"coastalStructurePml1500DefOverTop": 0,
"coastalInventoryAal": 0,
"coastalInventoryAalDefFail": 0,
"coastalInventoryAalDefOverTop": 0,
"coastalInventoryPml1500": 0,
"coastalInventoryPml1500DefFail": 0,
"coastalInventoryPml1500DefOverTop": 0,
"coastalEquipmentAal": 0,
"coastalEquipmentAalDefFail": 0,
"coastalEquipmentAalDefOverTop": 0,
"coastalEquipmentPml1500": 0,
"coastalEquipmentPml1500DefFail": 0,
"coastalEquipmentPml1500DefOverTop": 0,
"pluvialFloodIndex": 4,
"pluvialStructureFloodScore": 2,
"pluvialStructureAal": 371,
"pluvialStructurePml1500": 160429,
"pluvialInventoryAal": 264,
"pluvialInventoryPml1500": 112602,
"pluvialEquipmentAal": 264,
"pluvialEquipmentPml1500": 112602,
"wildfireIndex": 8
}
Additional References
- input_parameters.md: Valid input parameter values
- output_values.md: Possible output values
- error_handling.md: Possible error responses