Skip to content
TotalView API

Overview

TotalView API 1.0.0

Section titled “TotalView API 1.0.0”

Programmatic access to the TotalView LCA platform: create renewable energy projects, queue lifecycle analyses, submit batches, manage scenarios, and retrieve time-series impact results.

Informations

  • OpenAPI version: 3.1.0

Operations

Section titled “ Operations ”
POST
/api/v1/auth/login/access-token
POST
/api/v1/auth/login/access-token
POST
/api/v1/auth/register
POST
/api/v1/auth/register
POST
/api/v1/auth/login/oidc
POST
/api/v1/auth/login/oidc
GET
/api/v1/auth/login/amazon/authorize
GET
/api/v1/auth/login/amazon/authorize
POST
/api/v1/auth/login/amazon/callback
POST
/api/v1/auth/login/amazon/callback
POST
/api/v1/auth/set-password
POST
/api/v1/auth/set-password
POST
/api/v1/auth/forgot-password
POST
/api/v1/auth/forgot-password
POST
/api/v1/auth/reset-password
POST
/api/v1/auth/reset-password
POST
/api/v1/auth/change-password
POST
/api/v1/auth/change-password
POST
/api/v1/auth/login/verify-2fa
POST
/api/v1/auth/login/verify-2fa
POST
/api/v1/auth/2fa/setup
POST
/api/v1/auth/2fa/setup
POST
/api/v1/auth/2fa/verify
POST
/api/v1/auth/2fa/verify
DELETE
/api/v1/auth/2fa
DELETE
/api/v1/auth/2fa
GET
/api/v1/auth/me
GET
/api/v1/auth/me
GET
/api/v1/auth/api-keys
GET
/api/v1/auth/api-keys
POST
/api/v1/auth/api-keys
POST
/api/v1/auth/api-keys
DELETE
/api/v1/auth/api-keys/{key_id}
DELETE
/api/v1/auth/api-keys/{key_id}
GET
/api/v1/projects
POST
/api/v1/projects
GET
/api/v1/projects/{project_id}
PATCH
/api/v1/projects/{project_id}
POST
/api/v1/projects/{project_id}/queue
GET
/api/v1/projects/{project_id}/results
GET
/api/v1/projects/{project_id}/airsheds
GET
/api/v1/projects/{project_id}/airshed-intensity-tiles
GET
/api/v1/projects/{project_id}/airshed-intensity-aggregate
GET
/api/v1/projects/{project_id}/runs/latest
GET
/api/v1/projects/{project_id}/runs/{run_id}/plant-displacements
GET
/api/v1/projects/{project_id}/runs/{run_id}/inferno-result
GET
/api/v1/projects/{project_id}/scenarios
POST
/api/v1/projects/{project_id}/scenarios
GET
/api/v1/projects/{project_id}/scenarios/{scenario_id}
DELETE
/api/v1/projects/{project_id}/scenarios/{scenario_id}
PATCH
/api/v1/projects/{project_id}/scenarios/{scenario_id}
POST
/api/v1/projects/{project_id}/scenarios/{scenario_id}/clone
GET
/api/v1/projects/{project_id}/profiles
POST
/api/v1/projects/{project_id}/profiles
DELETE
/api/v1/projects/{project_id}/profiles/{profile_id}
PATCH
/api/v1/projects/{project_id}/profiles/{profile_id}
POST
/api/v1/projects/{project_id}/queue-scenario
GET
/api/v1/projects/{project_id}/compare
POST
/api/v1/batch
GET
/api/v1/batch/{batch_id}/status
GET
/api/v1/batch/{batch_id}/projects
GET
/api/v1/batch/{batch_id}/summary
GET
/api/v1/projects/{project_id}/impacts/time-series
GET
/api/v1/projects/{project_id}/impacts/dashboard
GET
/api/v1/projects/{project_id}/impacts/status
POST
/api/v1/projects/{project_id}/impacts/generation-data
GET
/api/v1/projects/{project_id}/impacts/data-status
POST
/api/v1/projects/{project_id}/impacts/recalculate
GET
/api/v1/projects/{project_id}/impacts/hourly
GET
/api/v1/projects/{project_id}/impacts/daily
GET
/api/v1/gating/status

Authentication

Section titled “ Authentication ”

OAuth2PasswordBearer

Section titled “OAuth2PasswordBearer ”

Security scheme type: oauth2

Flow type: password

Token URL: /auth/login/access-token