Skip to content

Output values

When a request succeeds, the JSON body includes your usual response envelope (fields such as uuid, timeStamp, statusCode, type, description, etc.) plus these score fields:

Score fields

Field Meaning
fluvialFloodHazardScore Fluvial flood hazard score (Range: 1 to 10)
fluvialFloodRiskScore Fluvial flood risk score (Range: 0 to 10)
coastalFloodHazardScore Coastal flood hazard score (Range: 1 to 10)
coastalFloodRiskScore Coastal flood risk score (Range: 0 to 10)
pluvialFloodHazardScore Pluvial flood hazard score (Range: 1 to 10)
pluvialFloodRiskScore Pluvial flood risk score (Range: 0 to 10)
wildfireHazardScore Wildfire hazard score (Range: 0 to 10)

Non-negative values in these ranges are normal model outputs for your subscription and location. Finer interpretation of each band is defined in your Geosapiens product documentation or support materials.


Special status codes

Some integer results are not computed hazard or risk scores. They indicate access, subscription, or geography constraints. The Essential API uses the same meanings as the full Geosapiens API for these codes.

Value Meaning
-1 Outside model territory — The location is outside the geographic area covered by that flood model, so no score is produced for that model.
-2 No access to model — Your subscription does not include that flood or wildfire model; the field is not available to you.
-3 No access to module — Your subscription does not include the underlying capability (for example flood index, flood score, or wildfire index) needed to fill that field.

You may see a mix: for example, fluvial scores populated and coastal codes -1 or -2 depending on both location and contract.

The Essential API does not return building loss fields (AAL, PML, etc.). Only the seven fields above remain in the score block.