GET
/
v4
/
facilities
/
Get Facilities
curl --request GET \
  --url https://api.openelectricity.org.au/v4/v4/facilities/ \
  --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.

Query Parameters

​
facility_code
string[] | null

Filter by facility code(s)

​
status_id
enum<string>[] | null

Filter by unit status(es)

​
fueltech_id
enum<string>[] | null

Filter by unit fuel technology type(s)

​
network_id
string[] | null

Filter by network code(s)

​
network_region
string | null

Filter by network region

​
with_clerk
boolean
default:true

Response

200
application/json

Successful Response

The response is of type object.