Portfolios in an entity
The portfolios under a grid entity, descending the tree: aggregate (an ENTSO-E unit that is several plants), aggregator, virtual (an Elexon virtual lead party) and supplier_base (an Elexon supplier's base demand), see portfolio_kind. Sorted by capacity. Paged: next is the path of the next page, filters and cursor included; request it as it is. Items are portfolio cards; the card's plants count says whether the portfolio's plants are linked.
Authorization
apiKey Optional. The Grid API key, also accepted as ?api_key=; without it a request is answered at 30 per minute per IP address. How to get a key: grid.rebase.energy/docs/v1/guides/authentication/. The key is in the API tab of the grid map.
In: header
Path Parameters
The entity id, e.g. SE-SE3, Sweden, sync:NSA, ca:DE-Amprion, bnd:GB-B1, sub:Blyth, border:FI~SE-SE3, icx:BritNed, or a plant, unit or portfolio: plant:11WD4SAEK2HS---S, unit:…, portfolio:… — the key, or the name after the kind prefix (plant:Säckingen hydroelectric plant). A name shared by several records is 404 listing their ids. See the Entities guide for every kind.
Query Parameters
aggregate: an ENTSO-E production unit that is several plants under one registration (a hydro cascade, a developer's cluster of wind farms, a stacked solar site); the plants are its plants. aggregator: a party that trades or balances other owners' plants as one unit (an ENTSO-E aggregator's trading unit, an Elexon aggregator). virtual: an Elexon virtual lead party BM unit (V__), a virtual power plant; Elexon publishes no site list for these, so plants is empty. supplier_base: an Elexon supplier's base BM unit in one GSP group (register type G); demand, no plants. supplier_additional: a supplier's additional BM unit in one GSP group (type S, 2__ or C__); sometimes one embedded farm traded through the supplier, so technology and fuel_type say what it is; no plants.
"aggregator" | "aggregate" | "virtual" | "supplier_base" | "supplier_additional"1001 <= value <= 1000Set for you in next, which is a whole path; do not copy next into this parameter.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://grid.rebase.energy/api/v1/entities/string/portfolios"{
"id": "string",
"total": 0,
"items": [
{
"id": "string",
"kind": "plant",
"name": "string",
"common_name": "string",
"parent": "string",
"technology": "string",
"sub_technology": "string",
"psr_type": "string",
"capacity_mw": 0,
"location": {
"latitude": 0,
"longitude": 0,
"accuracy": "exact"
},
"portfolio": "string",
"provider": {
"name": "string",
"id": "string",
"registry_name": "string"
},
"units": 0,
"timeseries": 0
}
],
"next": "string"
}{
"error": "not_found",
"message": "string",
"param": "string",
"anonymous": true,
"limit_rpm": 0,
"key_limit_rpm": 0,
"retry_after_s": 0,
"sign_up": "string",
"docs": "string",
"info": "string",
"reason": "string",
"closest": [
"string"
],
"providers": [
"string"
]
}{
"error": "not_found",
"message": "string",
"param": "string",
"anonymous": true,
"limit_rpm": 0,
"key_limit_rpm": 0,
"retry_after_s": 0,
"sign_up": "string",
"docs": "string",
"info": "string",
"reason": "string",
"closest": [
"string"
],
"providers": [
"string"
]
}{
"error": "not_found",
"message": "string",
"param": "string",
"anonymous": true,
"limit_rpm": 0,
"key_limit_rpm": 0,
"retry_after_s": 0,
"sign_up": "string",
"docs": "string",
"info": "string",
"reason": "string",
"closest": [
"string"
],
"providers": [
"string"
]
}{
"error": "not_found",
"message": "string",
"param": "string",
"anonymous": true,
"limit_rpm": 0,
"key_limit_rpm": 0,
"retry_after_s": 0,
"sign_up": "string",
"docs": "string",
"info": "string",
"reason": "string",
"closest": [
"string"
],
"providers": [
"string"
]
}{
"error": "not_found",
"message": "string",
"param": "string",
"anonymous": true,
"limit_rpm": 0,
"key_limit_rpm": 0,
"retry_after_s": 0,
"sign_up": "string",
"docs": "string",
"info": "string",
"reason": "string",
"closest": [
"string"
],
"providers": [
"string"
]
}