get_cashflow {yfinancer} | R Documentation |
Get cash flow statement for a ticker
Description
Retrieves cash flow statement data from Yahoo Finance for a specified ticker symbol. Cash flow statements show how changes in balance sheet accounts and income affect cash and cash equivalents, breaking the analysis down to operating, investing, and financing activities.
Usage
get_cashflow(
ticker,
freq = c("annual", "quarterly"),
start = NULL,
end = NULL,
cashflow_keys = NULL,
pretty = TRUE,
wide = TRUE,
proxy = NULL,
output = c("tibble", "response", "request")
)
Arguments
ticker |
A ticker object created with |
freq |
Frequency of data: "annual" or "quarterly" (default "annual") |
start |
Start timestamp as date, datetime, or string (default EOY 2016) |
end |
End timestamp as date, datetime, or string (default current timestamp) |
cashflow_keys |
Vector of specific cash flow statement keys to include (default all)
See |
pretty |
Format column names to be more readable (default TRUE) |
wide |
Return data in wide format with dates as columns (default TRUE). If FALSE, returns data in long format with a date column. |
proxy |
Optional proxy settings for the request |
output |
Object to return. Can be "tibble", "response", or "request" (default "tibble") |
Value
Either a tibble with cash flow statement data, an httr2 response object, or an httr2 request object depending on the value of the output argument.
Available Cashflow Keys
Examples:
OperatingCashFlow
FreeCashFlow
See valid_cashflow_keys
for a full list of available cashflow keys.
Examples
## Not run:
apple <- get_tickers("AAPL")
# Get annual cash flow statement
cash_flow <- get_cashflow(apple)
# Get quarterly cash flow statement
quarterly_cash_flow <- get_cashflow(apple, freq = "quarterly")
# Get specific cash flow items
operating_cash <- get_cashflow(apple,
cashflow_keys = c("OperatingCashFlow", "FreeCashFlow")
)
# Get data for a specific time period
cash_2020_2022 <- get_cashflow(apple,
start = "2020-01-01",
end = "2022-12-31"
)
## End(Not run)