{
  "version": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "success": true,
  "error": "<string>",
  "data": [],
  "total_records": 123
}

Generation Data

Get Facility Data

Get time series data for a specific facility.

This endpoint returns time series data for a facility, with data grouped by unit. The data can be aggregated by different time intervals.

Args: network_code: The network the facility belongs to facility_code: The facility code to get data for metrics: List of metrics to query (e.g. energy, power, emissions) interval: The time interval to aggregate by date_start: Start time for the query date_end: End time for the query client: ClickHouse client dependency

Returns: APIV4ResponseSchema: Time series data response containing a list of TimeSeries objects, one per requested metric, with data for each unit

GET

data

facilities

{network_code}

{
  "version": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "success": true,
  "error": "<string>",
  "data": [],
  "total_records": 123
}

Get Facility Data

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

network_code

string

required

Query Parameters

metrics

enum<string>[]

required

The metrics to get data for

Show child attributes

interval

enum<string>

The time interval to aggregate data by

Available options:

5m,

1h,

1d,

7d,

1M,

3M,

season,

1y,

fy

facility_code

string[] | null

The facility code to get data for

date_start

string<date-time> | null

Start time for the query

date_end

string<date-time> | null

End time for the query

with_clerk

boolean

default:true

Response

Successful Response

version

string

created_at

string<date-time>

success

boolean

default:true

error

string | null

data

any[]

total_records

integer | null

Get Network Data Get Network Data

⌘I

API Reference

​Get Facility Data

Authorizations

Path Parameters

Query Parameters

Response

Get Facility Data