Browse
Infrastructure & SPOF assessment โ projected into three named sub-objects sourced across partitions: nearest-feature distances, supply-shed shed, and the climate overlay.
Returns the latest infrastructure 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/infrastructure
โถ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[port_road_km] | number (gte, lte) | Road-routed driving distance to the nearest port, km. One bound per request. |
filter[nearest_port_km] | number (gte, lte) | Straight-line distance to the nearest port, km. One bound per request. |
filter[nearest_water_km] | number (gte, lte) | Distance to the nearest navigable waterway, km. One bound per request. |
filter[nearest_road_km] | number (gte, lte) | Distance to the nearest road, km. One bound per request. |
filter[since] | date (eq) | Only assessments with sco2_run_at on or after this date. |
โถSorting
?sort= keys (leading - = descending): since (default -since), created_at.
โถIncludes
?include= | Adds | Why opt-in |
|---|---|---|
port_routes | port_routes on each resource โ the driving routes to the nearest port, as an array of routes, each a list of [lon, lat] vertices. | Up to three polylines of several hundred vertices each, so tens of KB per location. The key is omitted entirely without the include, so absent (not requested) is distinguishable from null (no routed port). |
port_routes is an include, not a sparse field: fields[assessment]=port_routes is a 400. ?include=port_routes composes with fields[assessment]= โ the routes are returned alongside whichever sub-objects were selected.
โถResponse
- 200 โ Paginated list of infrastructure 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 Infrastructure-specific attributes:
| Field | Type | Description |
|---|---|---|
distances | object | Nearest-feature distances (see sub-object below). |
shed | object | Supply-shed footprint areas (art9 sibling). |
climate | object | Climate / physical-risk overlay (hazard sibling). |
sub_options | object | null | Snapshot of the check_* sub-options active when produced. |
port_routes | array | null | Opt-in โ present only with ?include=port_routes. Driving routes to the nearest port; each entry is a list of [lon, lat] vertices. |
โถSub-objects
| Sub-object | Fields |
|---|---|
distances | nearest_water_km, nearest_port_km, nearest_road_km, port_road_km, nearest_port_name, nearest_port_address, nearest_port_point, nearest_water_point, port_route_count, port_routes_unavailable, nearest_grid_km, nearest_grid_point. |
shed | shed_area_ha, commodity_area_ha, natural_forest_area_ha. |
climate | flood_zone_pct, flood_event_count, precip_trend_pct, water_stress_score, extreme_heat_wbgt. |
sub_options | check_water_access, check_port_proximity, check_road_access, building_density_threshold, commodity_radius. |
shed is read from the art9 partition and climate (+ the grid distance in
distances) from the hazard partition via sibling joins โ each null when
that partition wasn't produced/visible for the location.
โถSample response
{
"meta": {
"page": 1,
"page_size": 1,
"total": 1,
"has_next": false
},
"links": {
"self": "/assessments/sheds/infrastructure"
},
"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",
"distances": {
"nearest_road_km": 1.2,
"nearest_port_km": 84.5
},
"shed": {
"shed_area_ha": 1204.0
},
"climate": {
"flood_zone_pct": 4.2
}
},
"links": {
"self": "/assessments/sheds/81895eee-e2bd-4b65-b75d-3c92110b5552/infrastructure"
}
}
]
}
Required scope:
assessments:read