Skip to content
TotalView API

Impacts & Time Series

Beyond a single model run, projects accrue time-series impacts as real generation data arrives. These endpoints power continuous-tracking dashboards.

Time series

Section titled “Time series”
Terminal window
curl "https://api.totalview.energy/api/v1/projects/$PROJECT_ID/impacts/time-series?granularity=monthly" \
  -H "Authorization: Bearer $TOKEN"

granularity is monthly (default), quarterly, or annual. Optional start_date / end_date. The response carries per-period generation, data quality, per-methodology results, methodology_summaries, totals, and real-world equivalencies (cars off road, homes powered, …).

EndpointGrainDefault windowAccess
…/impacts/time-seriesmonthly–annualall periodsfull
…/impacts/hourlyhourly168 h (max 52560)full
…/impacts/dailydaily365 d (max 3650)summary+
…/impacts/dashboardlifetime rollup—summary+

Hourly and daily responses include grid carbon intensity, marginal fuel, and displaced generation per interval, plus a summary block. They paginate with limit / offset.

Terminal window
curl "https://api.totalview.energy/api/v1/projects/$PROJECT_ID/impacts/hourly?limit=168&offset=0" \
  -H "Authorization: Bearer $TOKEN"

Submitting metered generation

Section titled “Submitting metered generation”

Feed real generation in for high-fidelity impacts:

Terminal window
curl -X POST https://api.totalview.energy/api/v1/projects/$PROJECT_ID/impacts/generation-data \
  -H "Authorization: Bearer $TOKEN" -H 'Content-Type: application/json' \
  -d '{
    "data_source": "metered",
    "source_system": "scada",
    "data_points": [
      { "timestamp": "2024-01-01T00:00:00Z", "generation_mw": 20.5 }
    ]
  }'

Returns 202 with an ingestion_id, validation warnings/errors, and the number of periods to recalculate. Track progress with GET …/impacts/data-status. To re-run after a model or data change, POST …/impacts/recalculate (optionally scoped by date range or methodology) — also 202 with a job_id.

Next steps

Section titled “Next steps”