Get Facilities - OpenElectricity Documentation

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
}

GET

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
}

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

facility_code

string[] | null

Filter by facility code(s)

status_id

enum<string>[] | null

Filter by unit status(es)

Show child attributes

fueltech_id

enum<string>[] | null

Filter by unit fuel technology type(s)

Show child attributes

network_id

string[] | null

Filter by network code(s)

network_region

string | null

Filter by network region

with_clerk

boolean

default:true

200

application/json

Successful Response

The response is of type object.