simfinR_get_aggregated_shares_outstanding: Get aggregated shares outstanding data for a group of...

In msperlin/simfinR: Import Financial Data from the 'SimFin' Project

Description

This function will use the simfin api to grab aggregated shares outstanding of stocks.

Usage

simfinR_get_aggregated_shares_outstanding(
  id_companies,
  api_key,
  filter = "all",
  cache_folder = "simfin_cache"
)

Arguments

id_companies	A vector of ids of companies
api_key	Your api key
filter	Omit to return all types of shares outstanding, or one of "common-outstanding", "common-outstanding-basic", "common-outstanding-diluted", "preferred". See https://simfin.com/api/v1/documentation/#operation/getCompSharesAggregated for more detail.
cache_folder	The cache folder to save files

Value

A dataframe with aggregated shares outstanding data

Examples

## Not run: 
df <- simfinR_get_aggregated_shares_outstanding(59265, 'YOURAPIKEY')

## End(Not run)

msperlin/simfinR documentation built on June 19, 2021, 10:21 p.m.