Products

Cumulative population exposure for a risk-zone product.

Returns the total population inside all risk-band polygons at or above a threshold level for a risk-zone product's latest issuance — the data behind headlines like "~57M under major heat risk".

Generic across every product that publishes exclusive risk-band polygons (NWS HeatRisk today; SPC categorical, WPC flood, and winter/cold outlooks later). Because the bands are spatially exclusive, a cumulative >= min_level figure is a straight sum with no double-counting.

Parameters

min_level is the inclusive cumulative threshold on the ordinal risk_level (e.g. HeatRisk 3 = Major and above). When omitted the upstream default (1, any elevated risk) applies. valid_time selects a specific issuance (RFC3339); omit it for the latest.

Caching

Successful responses carry Cache-Control: public, max-age=60, stale-while-revalidate=60. Edge cache key includes the query string so each min_level / valid_time variant gets its own TTL.

Auth

Standard sw-api Bearer auth applies.

get/v1/products/{product_id}/exposure-summary

Request

  • Base URL: https://api.smarterweather.com
  • URL: https://api.smarterweather.com/v1/products/{product_id}/exposure-summary
  • Auth: HTTP bearer

Path parameters

product_idstring required

Risk-zone product identifier (lowercase, digits, underscores), e.g. heatrisk_day1_conus.

Query parameters

min_levelinteger

Inclusive cumulative threshold on the ordinal risk_level.

valid_timestring date-time

RFC3339 issuance (valid_time) to summarize. Defaults to the latest.

Response

Cumulative population-exposure summary.

product_idstring required
min_levelinteger required
populationinteger required

Total population under risk_level >= min_level.

feature_countinteger required

Number of risk-band polygons contributing to the sum.

valid_timestring date-time nullable

Issuance the summary was computed for (null if no features).

Example response

{
  "product_id": "heatrisk_day1_conus",
  "min_level": 3,
  "population": 57000000,
  "feature_count": 2,
  "valid_time": "2026-06-30T22:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.