surplus_or_deficit_cumulative_RTD: Surplus/deficit, cumulative - real time data

In finnishgrid: 'Fingrid Open Data API' R Client

Surplus/deficit, cumulative - real time data

Description

Check https://data.fingrid.fi/en/dataset/surplus-deficit-cumulative-real-time-data

Usage

surplus_or_deficit_cumulative_RTD(
  start_time = NA,
  end_time = NA,
  user_key = NA
)

Arguments

start_time	Start time in UTC with offset. Character array in ISO8601, YYYY-MM-ddTHH:mm:ssZ
end_time	End time in UTC with offset. Character array in ISO8601, YYYY-MM-ddTHH:mm:ssZ
user_key	Character array holding API-key. Free from https://data.fingrid.fi/open-data-forms/registration/

Value

A data frame object that contains power deficit/surplus represents the balance between production and consumption in Finland, taking into account imports and exports. It is calculated as the difference between the measured net import/export and the confirmed net exchange program between Finland and the other Nordic countries. The cumulative production deficit/surplus is the hourly energy generated from the difference. Sign convention: production deficit -, surplus +. The data is updated every 3 minutes.

Examples

## Not run: 
library(finnishgrid)
start = "2021-01-01T00:00:00+0200"  # UTC+2 offset, Helsinki time
end = "2021-01-10T00:00:00+0200"    # UTC+2 offset, Helsinki time
key = "MY_SUPER_SECRET"
df <- surplus_or_deficit_cumulative_RTD(
    start_time = start,
    end_time = end,
    user_key = key)
summary(df)

## End(Not run)

finnishgrid documentation built on March 18, 2022, 7:23 p.m.