Get Facility Data
Get time series data for a specific facility, grouped by unit.
/ v4 / data / facilities / {network_code} Get time series data for a specific facility, grouped by unit.
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 for the requested facilities.
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
facility_code string[] | null Restrict to one or more facility codes (max 30). Multi-value: repeat the param.
unit_code string[] | null Restrict to one or more unit codes (max 30). Multi-value: repeat the param.
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).
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/facilities/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
}