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 facility, 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/facilities/infrastructure

Filters

All read endpoints share the location-level and ingestion-trace filters (filter[field]=condition:value โ€” see Query Parameters):

FilterTypeDescription
organization_iduuidOwning organization ID.
location_iduuidStaged location ID.
commodityenumCommodity type.
country_codeiso-countryISO 3166-1 alpha-2.
namestringLocation name.
tagstagsTags on linked entities.
created_atdatePer-org link creation timestamp.
country / admin_region / citystringNormalised location-parity fields.
facility_id / shed_id / plot_idstring / uuidUnderlying entity IDs.
assets.task_iduuidIngestion task ID.
assets.filenamestringSource filename from ingestion.
assets.data.*wildcardUser-uploaded source columns (e.g. filter[assets.data.CITY]=London).

This slug additionally supports:

FilterTypeDescription
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=AddsWhy opt-in
port_routesport_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

Every assessment resource carries the shared identity / meta block (sourced from the location + ingestion joins, not the assessment data):

FieldTypeDescription
location_iduuidType-specific location ID.
location_typefacility | shed | plotUnderlying entity type.
commoditystring | nullCommodity type.
country_codestring | nullISO 3166-1 alpha-2 country code.
namestring | nullNormalised location name.
geoGeoJSON | nullLocation geometry.
sco2_run_atISO 8601 | nullTimestamp of the run that produced this assessment.
asset_task_iduuidIngestion task that linked this location.
created_atISO 8601 | nullCreation timestamp.
updated_atISO 8601 | nullLast update timestamp.

Plus the Infrastructure-specific attributes:

FieldTypeDescription
distancesobjectNearest-feature distances (see sub-object below).
shedobjectSupply-shed footprint areas (art9 sibling).
climateobjectClimate / physical-risk overlay (hazard sibling).
sub_optionsobject | nullSnapshot of the check_* sub-options active when produced.
port_routesarray | nullOpt-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-objectFields
distancesnearest_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.
shedshed_area_ha, commodity_area_ha, natural_forest_area_ha.
climateflood_zone_pct, flood_event_count, precip_trend_pct, water_stress_score, extreme_heat_wbgt.
sub_optionscheck_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/facilities/infrastructure"
  },
  "data": [
    {
      "type": "assessment",
      "id": "3fad3b99-0000-0000-0000-000000000000",
      "attributes": {
        "location_id": "81895eee-e2bd-4b65-b75d-3c92110b5552",
        "location_type": "facility",
        "commodity": "palm",
        "country_code": "BR",
        "name": "Example Facility",
        "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/facilities/81895eee-e2bd-4b65-b75d-3c92110b5552/infrastructure"
      }
    }
  ]
}

Required scope: assessments:read