Get Facilities
Get all facilities and their associated units
/ v4 / facilities Get all facilities and their associated units
Authorizations
AuthorizationstringheaderrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query parameters
facility_code string[] | null Filter to one or more facility codes (e.g. `BAYSW`).
status_id "committed" | "operating" | "retired"[] | null Filter by unit operational status. Multi-value: `?status_id=operating&status_id=committed`.
Available options: committed, operating, retired
fueltech_id string[] | null Filter by unit fueltech (e.g. `coal_black`, `solar_utility`, `wind`).
Available options: battery, battery_charging, battery_discharging, bioenergy_biogas, bioenergy_biomass, coal_black, coal_brown, distillate, gas_ccgt, gas_ocgt, gas_recip, gas_steam, gas_wcmg, hydro, pumps, solar_rooftop, solar_thermal, solar_utility, nuclear, other, solar, wind, wind_offshore, imports, exports, interconnector, aggregator_vpp, aggregator_dr
fueltech_group_id string[] | null Filter by fueltech group (e.g. `coal`, `renewable`).
Available options: solar, wind, hydro, biomass, coal, gas, battery, battery_charging, battery_discharging, distillate, bioenergy, pumps
network_id string[] | null Filter to one or more network codes — see `/networks`.
network_region string | null Filter to a network region (price zone).
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 object[] Facilities matching the request, sorted by `code`.
Facility response schema with selected fields and associated units
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/facilities/" \
--header "Authorization: Bearer YOUR_API_KEY"{
"version": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"success": true,
"error": "<string>",
"data": [],
"total_records": 123
}