Skip to main content
GET
/
v4
/
facilities
Get Facilities
curl --request GET \
  --url https://api.example.com/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)

Available options:
committed,
operating,
retired
​
fueltech_id
enum<string>[] | null

Filter by unit fuel technology type(s)

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
​
network_id
string[] | null

Filter by network code(s)

​
network_region
string | null

Filter by network region

​
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