Browse
Natural-hazard assessment โ flood, extreme heat, water stress, precipitation trend, fire, and the nearest power-grid distance.
Returns the latest hazard assessment per supply shed, paginated and
filterable. All four response formats (application/json,
application/geo+json, application/x-ndjson, application/x-ndgeo+json)
are available via the Accept header โ see Response Formats.
โถRequest
โถMethod & Path
GET /assessments/sheds/hazard
โถFilters
All read endpoints share the location-level and ingestion-trace filters
(filter[field]=condition:value โ see Query Parameters):
| Filter | Type | Description |
|---|---|---|
organization_id | uuid | Owning organization ID. |
location_id | uuid | Staged location ID. |
commodity | enum | Commodity type. |
country_code | iso-country | ISO 3166-1 alpha-2. |
name | string | Location name. |
tags | tags | Tags on linked entities. |
created_at | date | Per-org link creation timestamp. |
country / admin_region / city | string | Normalised location-parity fields. |
facility_id / shed_id / plot_id | string / uuid | Underlying entity IDs. |
assets.task_id | uuid | Ingestion task ID. |
assets.filename | string | Source filename from ingestion. |
assets.data.* | wildcard | User-uploaded source columns (e.g. filter[assets.data.CITY]=London). |
This slug additionally supports:
| Filter | Type | Description |
|---|---|---|
filter[natural_hazard_risk_level] | enum (eq, in) | Risk band: low, medium, high, or unknown (every satellite hazard check failed). Any other value is a 400 that lists these. |
filter[since] | date (eq) | Only assessments with sco2_run_at on or after this date. |
โถSorting
?sort= keys (leading - = descending): since (default -since), risk_score, created_at.
โถResponse
- 200 โ Paginated list of hazard assessments.
- 400 / 401 / 403 โ See Error Codes.
โถdata[] attributes
data[] attributesEvery assessment resource carries the shared identity / meta block (sourced
from the location + ingestion joins, not the assessment data):
| Field | Type | Description |
|---|---|---|
location_id | uuid | Type-specific location ID. |
location_type | facility | shed | plot | Underlying entity type. |
commodity | string | null | Commodity type. |
country_code | string | null | ISO 3166-1 alpha-2 country code. |
name | string | null | Normalised location name. |
geo | GeoJSON | null | Location geometry. |
sco2_run_at | ISO 8601 | null | Timestamp of the run that produced this assessment. |
asset_task_id | uuid | Ingestion task that linked this location. |
created_at | ISO 8601 | null | Creation timestamp. |
updated_at | ISO 8601 | null | Last update timestamp. |
Plus the Hazard-specific attributes:
| Field | Type | Description |
|---|---|---|
natural_hazard_risk_score | number | null | Natural-hazard risk score. |
natural_hazard_risk_level | string | null | Natural-hazard risk level. |
natural_hazard_summary | string | null | Natural-hazard narrative summary. |
natural_hazard_sources | array | Grounded source citations (upstream-owned, passed through verbatim). |
flood_zone_pct | number | null | Share of the geometry in a flood zone. |
flood_event_count | number | null | Documented flood-event count. |
extreme_heat_wbgt | number | null | Extreme-heat wet-bulb globe temperature. |
water_stress_score | number | null | Water-stress score. |
precip_trend_pct | number | null | Precipitation trend (%). |
nearest_grid_km | number | null | Distance to the nearest power grid (km). |
nearest_grid_point | GeoJSON | null | Nearest power-grid point. |
fire_detections_count | number | null | Fire detections count. |
fire_radiative_power_mw | number | null | Fire radiative power (MW). |
forest_commodity_area_ha | number | null | Forest/commodity area used for the fire assessment (ha). |
flood_event_points | array | null | Flood-event point coordinates ([lon, lat] pairs). |
โถSample response
{
"meta": {
"page": 1,
"page_size": 1,
"total": 1,
"has_next": false
},
"links": {
"self": "/assessments/sheds/hazard"
},
"data": [
{
"type": "assessment",
"id": "3fad3b99-0000-0000-0000-000000000000",
"attributes": {
"location_id": "81895eee-e2bd-4b65-b75d-3c92110b5552",
"location_type": "shed",
"commodity": "palm",
"country_code": "BR",
"name": "Example Supply Shed",
"natural_hazard_risk_level": "low",
"flood_zone_pct": 4.2,
"water_stress_score": 1.8
},
"links": {
"self": "/assessments/sheds/81895eee-e2bd-4b65-b75d-3c92110b5552/hazard"
}
}
]
}
Required scope:
assessments:read