Entities
The objects that hold timeseries, and how they nest.
An entity is an object that holds timeseries. Entities form a tree: each one has at most one parent and any number of children, of the kinds listed below. Relations connect two entities and are listed on both.
| Entity | Example id | Represents | Parents | Children |
|---|---|---|---|---|
sync_area | sync:NSA | a synchronous area: the grids that share one frequency. Every entity carries it as a tag rather than a parent | — | — |
country | Sweden | a state; holds the data published for the whole country | — | price_zone |
price_zone | SE-SE3 | a bidding zone of the electricity market | country, or none when a zone spans several states (SEM, GB) | area, boundary, substation, plant, portfolio |
area | ca:DE-50Hertz | a part of a zone or of another area: a control area, the national part of a multi-country zone, a region, an island system, or a GB grid supply point group | price_zone, area | area, substation, plant, portfolio |
aggregate | NORDICS | a named set of zones that owns the data published for the whole, such as the Nordic system price | — | — |
boundary | bnd:GB-B6 | a transmission boundary inside a zone, with its flow and limit | price_zone | — |
substation | sub:Revsing | a grid node, the end of an interconnector | price_zone, area | — |
plant | plant:46WPU0000000015W | a power plant at one location; holds the plant-level data (installed capacity, outages). Its portfolio field names the portfolio it belongs to, if any | price_zone, area | unit |
unit | unit:46WGU0000000137O | one generation, storage or demand unit; holds the unit-level data (actual output) | plant | — |
portfolio | portfolio:bmu-2__AANGE001 | a group of plants that a market registers and settles as one: an ENTSO-E production unit that covers several plants (a hydro cascade, a cluster of wind farms, an aggregator), or an Elexon BM unit for a supplier's base demand (2__) or a virtual lead party (V__). It has no location of its own; its plants name it in their portfolio field, and the portfolio call lists them under plants | price_zone, area | — |
border | border:FI~SE-SE3 | a relation: the market link between two price zones; holds the flows, schedules and capacities between them | the two price zones | interconnector |
interconnector | icx:BritNed | a relation: a cable between two substations, and the border it sits on | the two substations | — |
Every id is accepted wherever an entity is expected. An unknown id returns 404 with the three
closest ids. Ids are read from the API, not composed: a country is its English name
(Germany-Luxembourg, not Germany or DE), a price zone its code (IT-NO, not IT-NORD), and
ISO country codes and bare EIC codes are not ids. A border id is its two zone ids in alphabetical
order joined by ~ (border:FR~GB, not border:GB~FR), and only the pairs listed in a zone's
relations exist. Timeseries names differ per entity and per provider: a name found on one border
or zone need not exist on another, so list each entity's names
(Timeseries names) before reading values. Plants, units and portfolios are also reachable by name after the kind prefix; see
Plants, units and portfolios.
The tree
GET /entities returns the whole tree, nested, with the number
of timeseries on each entity; plants, units and portfolios stay out of it and appear as one summary
line per kind on their zone. GET /entities/{entity} returns one
entity with its parent, country, synchronous area, children and relations.