Skip to main content
GET
/
v4
/
data
/
facilities
/
{network_code}
Get Facility Data
curl --request GET \
  --url https://api.example.com/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

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) 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,
emissions,
renewable_proportion
​
interval
enum<string>
default:5m

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<date-time> | null

Start time for the query

​
date_end
string<date-time> | null

End time for the query

​
with_clerk
boolean
default:true

Response

Successful Response

​
version
string
​
created_at
string<date-time>
​
success
boolean
default:true
​
error
string | null
​
data
any[]
​
total_records
integer | null