Skip to content
TotalView API

Get InMAP-derived airshed polygons for this project's displaced plants

GET
/api/v1/projects/{project_id}/airsheds
 
curl --request GET \
  --url https://api.totalview.energy/api/v1/projects/example/airsheds \
  --header 'Authorization: Bearer <token>'

Return a GeoJSON FeatureCollection of per-plant airshed polygons.

Polygons come from the InMAP ISRM v1.2.1 extraction pipeline (scripts/build_airshed_polygons.py); each feature covers the cells that receive ~80 % of the plant’s population-weighted PM2.5 intake under 2005 meteorology. Only plants actually displaced by this project are included.

Plants not present in the polygon set (non-CONUS, nuclear, too-new) are silently omitted — the frontend should fall back to a 500 km circular buffer for those.

See product/plans/phase3-multi-scale-map-ui.md §2.2.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
project_id
required
Project Id
string

Query Parameters

Section titled “Query Parameters ”
customer_id
Any of:
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
Example generated
example

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}