sfa_get_info: Get basic company information

View source: R/sfa_get_info.R

sfa_get_infoR Documentation

Get basic company information

Description

Get basic company information

Usage

sfa_get_info(
  ticker = NULL,
  simfin_id = NULL,
  api_key = getOption("sfa_api_key"),
  cache_dir = getOption("sfa_cache_dir"),
  sfplus = getOption("sfa_sfplus", default = FALSE)
)

Arguments

ticker

integer Ticker of the companies of interest.

simfin_id

integer 'SimFin' IDs of the companies of interest. Any simfin_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 simfin_id.

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.

sfplus

logical SetTRUE if you have a SimFin+ account. It's recommended to set sfplus globally using sfa_set_sfplus.


simfinapi documentation built on April 14, 2023, 12:27 a.m.