get_giedata2: get_giedata2

In giedata: API Wrapper for GIE's AGSI+/ALSI+ Natural Gas Storage Transparency Platform

get_giedata2

Description

Function to download data from GIE's AGSI+ API in bulk

Usage

get_giedata2(
  countries,
  companies = NULL,
  facilities = NULL,
  from = NULL,
  to = NULL,
  date = NULL,
  size = 30,
  timeout = 3,
  database = "agsi",
  verbose = FALSE,
  apikey = Sys.getenv("GIE_APIKEY")
)

Arguments

countries	Character. Specify the countries of interest as two-digit country codes (e.g., 'DE', 'IE'). Must be of length one (i.e., one country) if you want to specify multiple companies and/or multiple facilities.
companies	A character vector of company EIC codes to get data from. Must be of length one (i.e., one company) if you want to specify multiple facilities.
facilities	A character vector of facility EIC codes to get data from.
from	Character. Specify the start of the time span you are interested in downloading (format: YYYY-MM-DD).
to	Character. Specify the end of the time span you are interested in downloading (format: YYYY-MM-DD).
date	Character. If you want to have data only for one date. If you set 'date', you cannot set the 'from' and/or 'to' parameters (format: YYYY-MM-DD).
size	Integer. The number of results per page.
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.
database	Character. The type of API you want to address ('agsi' or 'alsi').
verbose	Logical. Prints information on function progress to the console (default: FALSE).
apikey	Character. Your personal API key.

Value

A data.frame with results

Examples

## Not run: 
get_giedata2(countries = c("DE", "AT", "FR"), date = "2022-04-01")

## End(Not run)

giedata documentation built on Nov. 27, 2022, 1:05 a.m.