gie_getumm: gie_getumm - Download info on IIP urgent market messages

In gie: API Wrapper for the Natural Gas Transparency Platforms of Gas Infrastructure Europe

gie_getumm – Download info on IIP urgent market messages

Description

Function to download urgent market messages (UMM) from the Inside Information Platform (IIP)

Usage

gie_getumm(
  from = NULL,
  to = NULL,
  published_date = NULL,
  eic_entity = NULL,
  eic_participant = NULL,
  eic_asset = NULL,
  status = NULL,
  direction = NULL,
  timeout = 3,
  size = 300,
  apikey = Sys.getenv("GIE_APIKEY")
)

Arguments

from	Character. Date the UMM is being in place from (format: YYYY-MM-DD).
to	Character. Date the UMM is being in place to (format: YYYY-MM-DD).
published_date	Character. Filter by publication date of UMM. Can be partial (e.g.: "2025-02-25", "2025-02", "2025").
eic_entity	Character. EIC code of the UMM issuing entity.
eic_participant	Character. EIC code of the UMM issuing market participant.
eic_asset	Character. EIC code of the asset the UMM is issued for.
status	Character. Can be 'active', 'inactive' or 'dismissed'. Default is all.
direction	Character. Direction of gas flows. Can be "entry" or "exit". Default is all.
timeout	Numeric. If the amount of pages of your request exceeds 60, a timeout will be enforced to prevent the API from timing out. Defaults to 3 seconds, any values must be set in seconds, too.
size	Integer. The number of results per page.
apikey	Character. Your personal API key.

Value

A nested list with UMMs for your specific API query to IIP. Note: The results are not parsed for there are too many data variants a user could want.

Examples

## Not run: 
umm <- gie_getumm(from = "2024-01-01", to = "2024-12-31")

## End(Not run)

gie documentation built on April 4, 2025, 12:02 a.m.