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.

Describes some component of the cost of energy of a Tariff, like peak tariffs, taxes, fixed monthly fees etc.

Tariff components describe how to transform some Datasets through a series of Functions, arriving at a cost dataset.

When tariffs are changed, as they frequently are, a new Tariff Component is created, and the applicable_from/applicable_to fields are set to represent when the switch-over occurred.

This allows you to model historic cost as well as upcoming transitions to new tariffs.

​
cost
Dataset · object
required

The pipeline's final output Dataset, either a Registered Dataset or - more commonly - the result of the functions pipeline.

Example:
{
  "id": "quarter-hourly-energy-offtake",
  "resolution": "quarter_hourly",
  "unit": "kWh"
}
​
datasets
Dataset · object[]
required

Input datasets, these are all Registered Datasets that must be supplied to the function pipeline

​
functions
(Constant · object | Add · object | Subtract · object | Divide · object | Multiply · object | Aggregate · object | Resample · object | Select · object | Mask · object | Clip · object | Lookup · object)[]
required

This is describes the core function pipeline - ordered Functions that transform the input dataset(s) to the final output cost dataset. Each step produces a named output Dataset that subsequent Functions may take as inputs or that become the final output

Minimum array length: 1

Emit a constant value at a given resolution.

Example:
{
  "output": {
    "id": "cost",
    "resolution": "monthly",
    "unit": "SEK"
  },
  "resolution": "monthly",
  "type": "constant",
  "value": { "unit": "SEK", "value": 500 }
}
​
name
string
required

Name of the tariff component as given by the issuing Party.

Examples:

"Energiskatt"

"Överföringsavgift"

"Effektavgift"

"Abonnemangsavgift"

"Nätnytta"

"Överuttagsavgift"

​
timezone
string
required

Timezone in which time-dependent functions (filtering, grouping) are evaluated. Typically local time, but can also be a fixed UTC offset.

Examples:

"Europe/Stockholm"

"UTC+01:00"

​
applicable_from
string<date-time> | null

ISO 8601 formatted datetime from when the tariff component becomes applicable, if any. If null or not included, applicable immediately.

Example:

"2025-01-01T00:00:00+01:00"

​
applicable_to
string<date-time> | null

ISO 8601 formatted datetime after which the tariff component ceases to be applicable. If null or not included, applicable until further notice.

Example:

"2026-01-01T00:00:00+01:00"