Get Network Data
Get time series data for a network.
/ v4 / data / network / {network_code} Get time series data for a network.
Authorizations
AuthorizationstringheaderrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path parameters
network_code string required Network identifier — see `/networks` for valid codes.
Query parameters
metrics string[] required One or more metrics to return. Multi-value: `?metrics=energy&metrics=power`.
Types of metrics that can be queried in OpenNEM. Each metric represents a different type of measurement or calculation that can be performed on the data. Attributes: POWER: Instantaneous power output/consumption (MW) ENERGY: Energy generated/consumed over time (MWh) PRICE: Price per unit of energy ($/MWh) DEMAND: Demand for energy (MW) CURTAILMENT_SOLAR: Curtailment of solar energy (MW) CURTAILMENT_WIND: Curtailment of wind energy (MW) MARKET_VALUE: Total market value ($) EMISSIONS: CO2 equivalent emissions (tonnes) RENEWABLE_PROPORTION: Percentage of renewable energy (%)
Available options: power, energy, price, market_value, demand, demand_energy, demand_gross, demand_gross_energy, generation_renewable, generation_renewable_energy, curtailment, curtailment_energy, curtailment_solar_utility, curtailment_solar_utility_energy, curtailment_wind, curtailment_wind_energy, emissions, renewable_proportion, pollution, storage_battery, generation_renewable_with_storage, generation_renewable_with_storage_energy, renewable_with_storage_proportion, flow_imports, flow_exports, flow_imports_energy, flow_exports_energy
interval string Bucket size for time-series aggregation.
Available options: 5m, 1h, 1d, 7d, 1M, 3M, season, 1y, fy
date_start string (date-time) | null Inclusive start of the query window (network-local time).
date_end string (date-time) | null Inclusive end of the query window (network-local time).
network_region string | null Restrict to a single network region (price zone).
fueltech string[] | null Restrict to one or more fueltechs (e.g. `coal_black`, `solar_utility`).
fueltech_group string[] | null Restrict to one or more fueltech groups (e.g. `coal`, `renewable`).
primary_grouping "network" | "network_region" Primary grouping dimension applied to results.
Available options: network, network_region
secondary_grouping "fueltech" | "fueltech_group" | "status" | "renewable" | null Optional secondary grouping dimension.
Secondary grouping types for time series data. These groupings can be applied on top of the primary grouping to provide additional dimensionality to the data. Attributes: FUELTECH: Group by individual fuel technologies FUELTECH_GROUP: Group by fuel technology groups (e.g., coal, gas, solar) STATUS: Group by facility status (e.g., operating, retired) RENEWABLE: Group by renewable vs non-renewable
Available options: fueltech, fueltech_group, status, renewable
Responses
Successful Response
version string OpenElectricity API version that produced this response.
created_at string (date-time) UTC timestamp when this response was produced.
success boolean default: true `true` if the request succeeded. Errors set this to `false` and populate `error`.
error string | null Human-readable error message when `success` is `false`. `null` on success.
data TimeSeries[] Response payload. Shape depends on the endpoint — see the endpoint's response schema.
total_records integer | null Total number of records in `data` when paginated; `null` when not applicable.
curl --request GET \
--url "https://api.openelectricity.org.au/v4/data/network/NETWORK_CODE?metrics=METRICS" \
--header "Authorization: Bearer YOUR_API_KEY"{
"version": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"success": true,
"error": "<string>",
"data": [],
"total_records": 123
}