R/company_information.R

In mwaldstein/edgarWebR: SEC Filings Access

#' SEC Company Info
#'
#' Fetches basic information on a given company from the SEC site
#'
#' @param x Either a stock symbol (for the 10,000 largest companies) or CIK
#'   code
#'
#' @return a dataframe with all SEC company information
#' @importFrom methods is
#' @examples
#' \donttest{
#' try(company_information("INTC"))
#' }
#' @export
company_information <- function(x) {
  # We want to accept a pre-fetched document or possibly a sub-page node
  doc <- if (is(x, "xml_node")) {
           x
         } else {
           browse_edgar(x)
         }

  entry_xpath <- "company-info"

  info_pieces <- list(
    "name" = "conformed-name",
    "cik" = "cik",
    "fiscal_year_end" = "fiscal-year-end",
    "company_href" = "cik-href",
    "sic" = "assigned-sic",
    "sic_description" = "assigned-sic-desc",
    "state_location" = "state-location",
    "state_incorporation" = "state-of-incorporation",
    "mailing_city" = "//address[@type='mailing']/city",
    "mailing_state" = "//address[@type='mailing']/state",
    "mailing_zip" = "//address[@type='mailing']/zip",
    "mailing_street" = "//address[@type='mailing']/street1",
    "mailing_street2" = "//address[@type='mailing']/street2",
    "business_city" = "//address[@type='business']/city",
    "business_state" = "//address[@type='business']/state",
    "business_zip" = "//address[@type='business']/zip",
    "business_street" = "//address[@type='business']/street1",
    "business_street2" = "//address[@type='business']/street2",
    "business_phone" = "//address[@type='business']/phone"
    )

  res <- map_xml(doc, entry_xpath, info_pieces)
  return(res)
}