GET
/
v4
/
data
/
facilities
/
{network_code}
curl --request GET \
  --url https://api.openelectricity.org.au/v4/v4/data/facilities/{network_code} \
  --header 'Authorization: Bearer <token>'
{
  "version": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "success": true,
  "error": "<string>",
  "data": [],
  "total_records": 123
}

Get Facility Data

Authorizations

Authorization
string
header
required

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

Path Parameters

network_code
string
required

Query Parameters

metrics
enum<string>[]
required

The metrics to get data for

interval
enum<string>

The time interval to aggregate data by

Available options:
5m,
1h,
1d,
7d,
1M,
3M,
season,
1y,
fy
facility_code
string[] | null

The facility code to get data for

date_start
string | null

Start time for the query

date_end
string | null

End time for the query

with_clerk
boolean
default:true

Response

200
application/json

Successful Response

The response is of type object.