R/os_legislator.R

In rsunlight: Interface to 'Sunlight' Foundation 'APIs'

#' Lookup a Legislator by ID
#'
#' @param id legislator id (character)
#' @param as (character) One of table (default), list, or response
#' @param key your SunlightLabs API key; loads from .Rprofile
#' @param ... Curl options passed on to [crul::HttpClient]
#' @return List of output fields.
#' @export
#' @examples \dontrun{
#' os_legislator(id = 'DCL000012')
#' }
os_legislator <- function(id, as = 'table', key = NULL, ...) {
  key <- check_key(key, 'OPEN_STATES_KEY')
  out <- query(url = osurl(),
  	path = file.path("api/v1/legislators/", id), list(),
    headers = list(`X-API-KEY` = key), ...)
	return_obj_notibbles(as, out)
}