gie_batchload: gie_batchload - Load data in batch

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

gie_batchload – Load data in batch

Description

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

Usage

gie_batchload(
  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: 
gie_batchload(countries = c("DE", "AT", "FR"), date = "2022-04-01")

## End(Not run)

gie documentation built on June 22, 2024, 9:33 a.m.