getGenscapePipeOil: Genscape API call for oil pipelines

In risktoollib/RTL: Risk Tool Library - Trading, Risk, 'Analytics' for Commodities

Genscape API call for oil pipelines

Description

Returns oil pipeline flows in barrels per day data from Genscape API.You need your own credentials. Refer to API documentation for argument values. It is assumed if you use this function that you know the pipelines you need to extract to build supply demand balances. Use the online API to identify the pipeline IDs. https://developer.genscape.com/docs/services/oil-transportation/operations/GetPipelineFlowValuesV2/

Usage

getGenscapePipeOil(
  frequency = "daily",
  regions = "Canada",
  pipelineIDs = c(97),
  revision = "revised",
  limit = 5000,
  offset = 0,
  startDate = "2015-01-01",
  endDate = as.character(Sys.Date()),
  apikey = "yourapikey"
)

Arguments

frequency	"daily" DEFAULT. character
regions	See API webpage. Multiple values separated by commas e.g. "Canada", "GulfCoast"). character
pipelineIDs	See API webpage. c(98,54...) for specific pipes. numeric
revision	See API webpage. character
limit	See API webpage. Max 5000. numeric
offset	See API webpage. numeric
startDate	"yyyy-mm-dd". character
endDate	"yyyy-mm-dd". character
apikey	Your API key. character

Value

wide data frame. tibble

Author(s)

Philippe Cote

Examples

## Not run: 
getGenscapePipeOil(
  frequency = "daily", regions = "Canada", pipelineIDs = c(97),
  revision = "revised", limit = 5000, offset = 0,
  startDate = "2015-01-01", endDate = as.character(Sys.Date()),
  apikey = "yourapikey"
)

## End(Not run)

risktoollib/RTL documentation built on April 17, 2024, 1:35 p.m.