R/browse_edgar.R

In edgarWebR: SEC Filings Access

#' Browse Edgar Web
#'
#' Attempts to access Edgar Web's browse page for a given company
#'
#' @param ticker either a stock ticker or CIK number
#' @param ownership boolean for inclusion of company change filings
#' @param type Type of filing to fetch
#' @param before yyyymmdd format of latest filing to fetch
#' @param count Number of filings to fetch per page
#' @param page Which page of results to return
#'
#' @keywords internal
#'
#' @importFrom utils URLencode
#'
#' @return A xml document
browse_edgar <- function(ticker,
                         ownership = FALSE,
                         type = "",
                         before="",
                         count = 40,
                         page = 1) {
  href <- paste0("https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany",
                "&CIK=", URLencode(ticker, reserved = TRUE),
                "&owner=", ifelse(ownership, "include", "exclude"),
                "&type=", URLencode(type, reserved = TRUE),
                "&dateb=", before,
                "&start=", (page - 1) * count,
                "&count=", count,
                "&output=atom")

  res <- edgar_GET(href)
  if (res$status != "200" | res$headers["content-type"] != "application/atom+xml") {
    stop(paste0("Could not find company: ", ticker));
  }

  xml2::read_xml(res, base_url = href, options = "HUGE")
}