Package 'finreportr'

Title: Financial Data from U.S. Securities and Exchange Commission
Description: Download and display company financial data from the U.S. Securities and Exchange Commission's EDGAR database. It contains a suite of functions with web scraping and XBRL parsing capabilities that allows users to extract data from EDGAR in an automated and scalable manner. See <https://www.sec.gov/edgar/searchedgar/companysearch.html> for more information.
Authors: Seward Lee
Maintainer: Seward Lee <[email protected]>
License: MIT + file LICENSE
Version: 1.0.4
Built: 2024-11-09 03:22:10 UTC
Source: https://github.com/sewardlee337/finreportr

Help Index

Acquire listing of company annual reports.

Description

Extracts and displays listing of annual reports filed by a company in a data frame.

Usage

AnnualReports(symbol, foreign = FALSE)

Arguments

symbol

A character vector specifying the stock symbol of the company of interest.
foreign

A logical vector indicating whether the company is domestic or foreign. foreign = FALSE by default.

Examples

## Not run: 
AnnualReports("TSLA")
AnnualReports("BABA", foreign = TRUE)

## End(Not run)

Acquire basic company information.

Description

Extracts and displays basic information relating to a given company in a data frame.

Usage

CompanyInfo(symbol)

Arguments

symbol

A character vector specifying the stock symbol of the company of interest.

Examples

## Not run: 
CompanyInfo("GOOG")
CompanyInfo("TSLA")

## End(Not run)

Acquire balance sheet.

Description

Extracts and displays balance sheet from the annual report of a given company. This functionality is only available for queries fo balance sheets that belong to domestic companies. Note that all data returned by this function comes from the company's Form 10-K, not Form 10-K/A.

Usage

GetBalanceSheet(symbol, year)

Arguments

symbol

A character vector specifying the stock symbol of the company of interest.
year

A numeric vector specifying the year during which the annual report was filed.

Examples

## Not run: 
GetBalanceSheet("FB", 2016)

## End(Not run)

Acquire statement of cash flow.

Description

Extracts and displays statement of cash flow from the annual report of a given company. This functionality is only available for queries of cash flow statements that belong to domestic company. Note that all data returned by this function comes from the company's Form 10-K, not Form 10-K/A.

Usage

GetCashFlow(symbol, year)

Arguments

symbol

A character vector specifying the stock symbol of the company of interest.
year

A numeric vector specifying the year during which the annual report was filed.

Examples

## Not run: 
GetCashFlow("FB", 2016)

## End(Not run)

Acquire income statement.

Description

Extracts and displays income statement from the annual report of a given company. This functionality is only available for queries of income statements that belong to domestic companies. Note that all data returned by this function comes from the company's 10-K, not 10-K/A.

Usage

GetIncome(symbol, year)

Arguments

symbol

A character vector specifying the stock symbol of the company of interest.
year

A numeric vector specifying the year during which the annual report was filed.

Examples

## Not run: 
GetIncome("FB", 2016)

## End(Not run)

Standard Industrial Classification Code List

Description

A dataset containing SIC codes and industries that they represent

Usage

siccodes

Format

A data frame with 444 rows and 2 variables:

  • SIC: Standard Industrial Classification Code

  • industry: Industry Title

Source

https://www.sec.gov/info/edgar/siccodes.htm

EDGAR State and Country Codes

Description

A dataset containing state and country codes used in the SEC EDGAR database.

Usage

statecodes

Format

A data frame with 310 rows and 2 variables:

  • state: State or Country Code

  • state.name: State or Country Name

Source

https://www.sec.gov/edgar/searchedgar/edgarstatecodes.htm