simfinapi (version 1.0.0)

sfa_load_companies: List Companies

Description

Get a list of all companies in the SimFin database. See https://simfin.readme.io/reference/list-1 and https://simfin.readme.io/reference/general-1 for more information.

Usage

sfa_load_companies(
  api_key = getOption("sfa_api_key"),
  cache_dir = getOption("sfa_cache_dir"),
  details = FALSE
)

Value

data.table::data.table() containing basic company information.

Arguments

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.

details

logical(1): If TRUE, return a more detailed data.table with additional columns. Default: FALSE.