sfa_get_shares: Shares Outstanding

Description Usage Arguments Fiscal year Parallel processing

View source: R/sfa_get_shares.R

Description

Common shares outstanding (point-in-time) and weighted average basic/diluted shares outstanding for all periods can be retrieved here. These shares are the aggregate figures for the entire company. If you are interested in more details, take a look at this page: https://simfin.com/data/help/main?topic=apiv2-shares

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
sfa_get_shares(
  ticker = NULL,
  simfin_id = NULL,
  type,
  period = "fy",
  fyear = data.table::year(Sys.Date()) - 1L,
  start = NULL,
  end = 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.

type

character Type of shares outstanding to be retrieved.

  • "common": Common shares outstanding.

  • "wa-basic": Weighted average basic shares outstanding for a period.

  • "wa-diluted": Weighted average diluted shares outstanding for a period.

period

character Filter for periods. As a non-SimFin+ user, you have to provide exactly one period. As SimFin+ user, this filter can be omitted to retrieve all statements available for the company.

  • "q1": First fiscal quarter.

  • "q2": Second fiscal quarter.

  • "q3": Third fiscal quarter.

  • "q4": Fourth fiscal quarter.

  • "fy": Full fiscal year.

  • "h1": First 6 months of fiscal year.

  • "h2": Last 6 months of fiscal year.

  • "9m": First nine months of fiscal year.

  • "6m": Any fiscal 6 month period (first + second half years; reserved for SimFin+ users).

  • "quarters": All quarters (q1 + q2 + q3 + q4; reserved for SimFin+ users).

fyear

integer Filter for fiscal year. As a non-SimFin+ user, you have to provide exactly one fiscal year. As SimFin+ user, this filter can be omitted to retrieve all data available for the company.

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.

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.

Fiscal year

Only works with type = "wa-basic" and type = "wa-diluted".

Parallel processing

This function supports parallel processing via future.apply. If your machine has several cores (most have), you can make the API calls in parallel. To do so, define a future::plan() before calling the function.


simfinapi documentation built on Sept. 11, 2021, 5:06 p.m.