Generation Data

Get Network Data

Get time series data for a network.

This endpoint returns time series data for a network, with optional grouping by region and other dimensions. The data can be aggregated by different time intervals.

Args: network_code: The network to get data for metrics: List of metrics to query (e.g. energy, power, price) interval: The time interval to aggregate by date_start: Start time for the query date_end: End time for the query primary_grouping: Primary grouping to apply secondary_grouping: Optional secondary grouping to apply client: ClickHouse client dependency

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

GET

data

network

{network_code}

curl --request GET \
  --url https://api.openelectricity.org.au/v4/v4/data/network/{network_code} \
  --header 'Authorization: Bearer <token>'

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

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

Available options:

power,

energy,

price,

market_value,

demand,

demand_energy,

emissions,

renewable_proportion

interval

enum<string>

The time interval to aggregate data by

Available options:

5m,

1h,

1d,

7d,

1M,

3M,

season,

1y,

fy

date_start

string | null

Start time for the query

date_end

string | null

End time for the query

primary_grouping

enum<string>

Primary grouping to apply

Available options:

network,

network_region

secondary_grouping

enum<string> | null

Optional secondary grouping to apply

Available options:

fueltech,

fueltech_group,

status,

renewable

with_clerk

boolean

default:

true

Response

200

application/json

Successful Response

version

string

created_at

string

success

boolean

default:

true

error

string | null

data

any[]

total_records

integer | null

Overview

Get Facility Data

curl --request GET \
  --url https://api.openelectricity.org.au/v4/v4/data/network/{network_code} \
  --header 'Authorization: Bearer <token>'

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

API Reference

Authorizations

Path Parameters

Query Parameters

Response