View source: R/sfa_get_shares.R
sfa_get_shares | R Documentation |
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://www.simfin.com/data/help/main?topic=apiv2-shares
sfa_get_shares(
ticker = NULL,
simfin_id = NULL,
type,
period = NULL,
fyear = NULL,
start = NULL,
end = NULL,
api_key = getOption("sfa_api_key"),
cache_dir = getOption("sfa_cache_dir"),
sfplus = getOption("sfa_sfplus", default = FALSE)
)
ticker |
integer Ticker of the companies of interest. |
simfin_id |
integer 'SimFin' IDs of the companies of interest. Any
|
type |
character Type of shares outstanding to be retrieved.
|
period |
character Filter for periods. Only works with
You can select several periods by passing several of the above items at
once, e.g. |
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 Set |
Only works with type = "wa-basic"
and type = "wa-diluted"
.
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.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.