Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.engrate.io/llms.txt

Use this file to discover all available pages before exploring further.

A named timeseries with known resolution and unit. Used both for describing registered datasets (see below) as well as for naming the intermediate results that get created by each step in a function pipeline.

Absent values

All datasets in this API are fixed resolution. For an hourly dataset, there is some “slot” for each hour’s value. However, some operations - Select for instance - can remove values from datasets, leaving “holes” or absent values behind. This is used for instance to select only weekends or certain times of year, “clearing” the rest of the dataset. We leave it up to users of the API to decide how they wish to represent absent values. A common strategy is to use NaN to represent absent values, another common option is bit masking.

Registered datasets

These are “well known” datasets that Tariff Components take as inputs. These you need to provide “from the outside” to the calculation to determine the cost. Note that most calculations only use a subset of these - and for some metering points a dataset may not exist, in which case you can safely skip the dataset.
NameResolutionUnitDescription
quarter-hourly-energy-offtakequarter_hourlykWhEnergy consumed (imported) per quarter hour
quarter-hourly-energy-injectionquarter_hourlykWhEnergy exported (injected) per quarter hour
yearly-firm-subscribed-offtake-capacityyearlykWFirm (prima) subscribed power offtake capacity
yearly-firm-subscribed-injection-capacityyearlykWFirm (prima) subscribed power injection capacity
yearly-conditional-subscribed-offtake-capacityyearlykWConditional (secunda) subscribed power offtake capacity
yearly-conditional-subscribed-injection-capacityyearlykWConditional (secunda) subscribed power injection capacity
hourly-available-conditional-offtake-capacityhourlykWConditional (secunda) offtake capacity actually available each hour — equals the subscribed level when not curtailed, lower or zero during DSO-initiated curtailment
hourly-available-conditional-injection-capacityhourlykWConditional (secunda) injection capacity actually available each hour — equals the subscribed level when not curtailed, lower or zero during DSO-initiated curtailment
quarter-hourly-day-ahead-price-se1quarter_hourlySEK_per_kWhDay-ahead spot price, zone SE1
quarter-hourly-day-ahead-price-se2quarter_hourlySEK_per_kWhDay-ahead spot price, zone SE2
quarter-hourly-day-ahead-price-se3quarter_hourlySEK_per_kWhDay-ahead spot price, zone SE3
quarter-hourly-day-ahead-price-se4quarter_hourlySEK_per_kWhDay-ahead spot price, zone SE4