Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Gunratan authored Aug 9, 2021
1 parent 846ed53 commit c2de03f
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,13 @@ The package is maintained on
# Implementation of the edgar package

## SEC guidelines on downloading EDGAR files
Please download only what you need and moderate downlaod requests to minimize server load. A user is required to declare user agent in request headers. The following link explains these requirements in details.
Please download only what you need and moderate downlaod requests to minimize EDGAR server load. A user is required to declare user agent in request headers. The following link explains these requirements in details.
https://www.sec.gov/os/accessing-edgar-data

Accordingly, `edgar` package requires user to pass user agent in every function. It should be in the form of
``` r
useragent = "Your Name [email protected]"
```

## Download daily filing information
The `getDailyMaster` function takes date as an input parameter from a user, and downloads master index for the date from the U.S. SEC EDGAR server https://www.sec.gov/Archives/edgar/daily-index/. It strips headers and converts this daily filing information into dataframe format. Function creates new directory 'Daily Indexes' into working directory to save these downloaded daily master index files in Rda format.
Expand Down

0 comments on commit c2de03f

Please sign in to comment.