RTL (version 1.3.5)

getGenscapeStorageOil: Genscape API call for oil storage

Description

Returns oil storage data from Genscape API.You need your own credentials. Refer to API documentation for argument values. https://developer.genscape.com/docs/services/oil-storage/operations/StorageVolumeByOwnerGet

Usage

getGenscapeStorageOil(
  feed = "owner-volumes",
  regions = "Canada",
  products = "Crude",
  revision = "revised",
  limit = 5000,
  offset = 0,
  startDate = "2011-01-01",
  endDate = as.character(Sys.Date()),
  apikey = "yourapikey"
)

Value

wide data frame tibble

Arguments

feed

"owner-volumes" DEFAULT or "tank-volumes". character

regions

See API webpage. Multiple values separated by commas e.g. "Canada, Cushing"). character

products

See API webpage. Multiple values separated by commas e.g. "Crude, JetFuel"). character

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 as a character string. character

Author

Philippe Cote

Examples

if (FALSE) {
# where yourapikey = "yourapikey".
getGenscapeStorageOil(
  feed = "owner-volumes", regions = "Canada", products = "Crude",
  revision = "revised", limit = 5000, offset = 0,
  startDate = "2011-01-01", endDate = "2020-11-01", apikey = yourapikey
)
}