R/congress.R

In congress: Access the Congress.gov API

#' Request Congress Information
#'
#' @param congress Congress number to search for. 81 or later are supported. Also
#' accepts the string `'current'` to get the current Congress.
#' @param from_date start date for search, e.g. `'2022-04-01'`. Defaults to most recent.
#' @param to_date end date for search, e.g. `'2022-04-03'`. Defaults to most recent.
#' @param limit number of records to return. Default is 20. Will be truncated to between 1 and 250.
#' @param offset number of records to skip. Default is 0. Must be non-negative.
#' @param format Output format for `clean = FALSE`. One of `xml` or `json`.
#' @param clean Default is TRUE. Should output be returned as a `tibble` (`TRUE`) or requested `format`.
#'
#' @return a `tibble::tibble` or HTTP response if `clean = FALSE`
#' @export
#'
#' @examplesIf congress::has_congress_key()
#'
#' # Requires API Key
#'
#' cong_congress()
#'
#' cong_congress(congress = 116)
#'
#' cong_congress(congress = 'current')
#'
cong_congress <- function(congress = NULL,
                          from_date = NULL, to_date = NULL,
                          limit = 20, offset = 0,
                          format = 'json', clean = TRUE) {
  sort <- NULL
  check_format(format)
  if (clean) {
    format <- 'json'
  }

  from_date <- check_date(from_date)
  to_date <- check_date(to_date)
  if (is.null(from_date) & !is.null(to_date) || !is.null(from_date) & is.null(to_date)) {
    cli::cli_abort('Either both or neither of {.arg from_date} and {.arg to_date} must be specified.')
  }

  endpt <- congress_endpoint(congress = congress)
  req <- httr2::request(base_url = api_url()) |>
    httr2::req_url_path_append(endpt) |>
    httr2::req_url_query(
      'api_key' = get_congress_key(),
      'fromDateTime' = from_date,
      'toDateTime' = to_date,
      'sort' = sort,
      'limit' = min(max(limit, 1), 250),
      'offset' = max(offset, 0)
    ) |>
    httr2::req_headers(
      'accept' = glue::glue('application/{format}')
    )

  resp <- req |>
    httr2::req_perform()

  formatter <- switch(format,
    'json' = httr2::resp_body_json,
    'xml' = httr2::resp_body_xml
  )

  out <- resp |>
    formatter()

  if (clean) {
    if (is.null(congress)) {
      out <- out |>
        purrr::pluck('congresses') |>
        dplyr::bind_rows() |>
        tidyr::unnest_wider(col = dplyr::all_of('sessions')) |>
        clean_names()
    } else {
      out <- out |>
        purrr::pluck('congress') |>
        widen() |>
        clean_names()
    }
    out <- out |>
      add_resp_info(resp) |>
      cast_date_columns()
  }
  out
}

congress_endpoint <- function(congress, type) {
  out <- 'congress'
  if (!is.null(congress)) {
    out <- paste0(out, '/', congress)
  }

  tolower(out)
}