List Projects

GET

/api/v1/projects

const url = 'https://api.totalview.energy/api/v1/projects';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Authorizations

OAuth2PasswordBearer

Responses

200

Successful Response

application/json

Response List Projects Api V1 Projects Get

Array<object>

ProjectWithLatest

Project with latest run info (for list views).

The latest_run_* fields come from the most recent model run for the project (by created_at); latest_run_start_date and latest_run_end_date define the analysis window that produced the headline metrics callers see in the row’s tooltip / drill-down.

object

project_id

required

Project Id

string format: uuid

project_name

required

Project Name

string

tech_type_id

Any of:

string
null

string

existing_project_flag

Existing Project Flag

boolean

eia_ba_code

Any of:

string
null

string

nameplate_capacity

Any of:

number
null

number

cod_date

Any of:

string
null

string format: date-time

decommision_date

Any of:

string
null

string format: date-time

latest_run_status

Any of:

string
null

string

latest_run_id

Any of:

string
null

string format: uuid

latest_run_start_date

Any of:

string
null

string

latest_run_end_date

Any of:

string
null

string

profile_source_breakdown

Any of:

object
null

object

key

additional properties

integer

profile_primary_source

Any of:

string
null

string

profile_metered_pct

Any of:

number
null

number

Example

[
  {
    "existing_project_flag": false
  }
]