sfa_load_shareprices {simfinapi}

Load share prices

Description

Retrieve share price data and ratios.

Usage

sfa_load_shareprices(
  ticker = NULL,
  id = NULL,
  start = NULL,
  end = NULL,
  ratios = FALSE,
  asreported = FALSE,
  api_key = getOption("sfa_api_key"),
  cache_dir = getOption("sfa_cache_dir")
)

Arguments

ticker

integer Ticker of the companies of interest.

id

integer 'SimFin' IDs of the companies of interest. Any id will be internally translated to the respective ticker. This reduces the number of queries in case you query the same company via ticker and id.

start

Date Filter for the report dates (reserved for SimFin+ users). With this filter you can filter the statements by the date on which the reported period ended ('Report Date'). By specifying a value here, only statements will be retrieved with report dates ending AFTER the specified date.

end

Date Filter for the report dates (reserved for SimFin+ users). With this filter you can filter the statements by the date on which the reported period ended ('Report Date'). By specifying a value here, only statements will be retrieved with report dates ending BEFORE the specified date.

ratios

logical If TRUE, additional ratios and derived metrics are included.

asreported

logical If TRUE, retrieves the as-reported (not restated) data.

api_key

character Your 'SimFin' API key. It's recommended to set the API key globally using sfa_set_api_key.

cache_dir

character Your cache directory. It's recommended to set the cache directory globally using sfa_set_cache_dir.

Value

data.table with share price data.