fundamental {limexhub}

Get Fundamental Data

Description

Fetches fundamental data for a specified stock symbol and range of dates, and for specified accounting quarter(s), using the Limex API. Authentication is done via an API token stored in an environment variable 'LIMEX_API_TOKEN'.

Usage

fundamental(
  symbol = NULL,
  from = "2010-01-01",
  to = Sys.Date(),
  quarter = NULL,
  fields = NULL
)

Arguments

symbol

The stock symbol for which fundamental data is requested.

from

The start date for the data retrieval in 'YYYY-MM-DD' format.

to

The end date for the data retrieval in 'YYYY-MM-DD' format.

quarter

Optional; specify the quarter and year 'Q1-2023', 'Q2-2023', 'Q1-2024'... for quarterly data.

fields

Optional; specify particular fields of interest like 'roe'.

Value

A data frame containing the requested fundamental data if successful, NULL otherwise.

Examples

## Not run: 
  company_fundamental <- fundamental(symbol = "AAPL")
  universe <- fundamental(fields = 'pe-ratio',quarter = 'Q2-2023')
  hist_data <- fundamental(symbol = "AAPL",fields = 'pe-ratio')

## End(Not run)