getFilings {edgar} | R Documentation |
Retrieves EDGAR filings from SEC server
Description
getFilings
retrieves EDGAR filings for a specific CIKs, form-type,
filing year and quarter of the filing.
Usage
getFilings(cik.no, form.type, filing.year, quarter, downl.permit)
Arguments
cik.no |
vector of CIK number of firms in integer format. Suppress leading zeroes from CIKs. Keep cik.no = 'ALL' if needs to download for all 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 |
quarter |
vector of one digit quarter integer number. By default, it is kept as c(1 ,2, 3, 4). |
downl.permit |
"y" or "n". The default value of downl.permit is "n". It asks a user permission to download fillings. This permission helps the user to decide in case if number of filings are large. Setting downl.permit = "y" will not ask for user permission to download filings. |
Details
getFilings function takes CIKs, form type, filing year, and quarter of the filing as input. It creates new directory "edgar_Filings" to store all downloaded filings. All the filings will be stored in the current working directory. Keep the same current working directory for further process. 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 downloads EDGAR filings and returns download status in dataframe format with CIK, company name, form type, date filed, accession number, and download status.
Examples
## Not run:
output <- getFilings(cik.no = c(1000180, 38079), c('10-K','10-Q'),
2006, quarter = c(1, 2, 3), downl.permit = "n")
## download '10-Q' and '10-K' filings filed by the firm with
CIK = 1000180 in quarters 1,2, and 3 of the year 2006. These
filings will be stored in the current working directory.
## End(Not run)