RTL (version 0.1.8)

getGenscapeStorageOil: getGenscapeStorageOil

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"
)

Arguments

feed

"owner-volumes" DEFAULT or "tank-volumes"

regions

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

products

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

revision

See API webpage.

limit

See API webpage. Max 5000

offset

See API webpage.

startDate

"yyyy-mm-dd" as character string

endDate

"yyyy-mm-dd" as character string

apikey

Your API key as a character string.

Value

wide data frame

Examples

# NOT RUN {
# 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)
# }