getFilingHeader {edgar}

Scrape EDGAR filing header information

Description

getFilingHeader Extract EDGAR filing header information

Usage

getFilingHeader(cik.no, form.type, filing.year)

Arguments

cik.no

vector of CIK(s) in integer format. Suppress leading zeroes from CIKs. cik.no = 'ALL' considers all the CIKs.

form.type

character vector containing form type to be downloaded. form.type = 'ALL' if need to download all forms.

filing.year

vector of four digit numeric year

Details

getFilingHeader function takes CIK(s), form type(s), and year(s) as input parameters. The function first imports available downloaded filings in local working directory 'edgar_Filings' created by getFilings function; otherwise, it automatically downloads the filings which are not already been downloaded. It then parses all the important header information from filings. The function returns a dataframe with filing and header information. User must follow the US SEC's fair access policy, i.e. download only what you need and limit your request rates, see https://www.sec.gov/os/accessing-edgar-data.

Value

Function returns dataframe containing CIK number, company name, date of filing, accession number, confirmed period of report, fiscal year end, Standard Industrial Classification (SIC) code, Internal Revenue Code (IRS) code, state of incorporation, business address, and mailing address. If a filing contains multiple filers then output will contain header information on all the filers in multiple rows.

Examples

## Not run: 

header.df <- getFilingHeader(cik.no = c('1000180', '38079'), 
                         form.type = '10-K', filing.year = 2006) 
              
header.df <- getFilingHeader(cik.no = '38079', c('10-K', '10-Q'), 
                         filing.year = c(2005, 2006))

## End(Not run)