Get candidates totals by office — fec_get_candidates_totals_by

Aggregated candidate receipts and disbursements grouped by office by cycle.

Usage

fec_get_candidates_totals_by_office(
  office,
  sort_nulls_last,
  page,
  min_election_cycle,
  sort_hide_null,
  election_year,
  election_full,
  is_active_candidate,
  sort_null_only,
  per_page,
  max_election_cycle,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

office: Federal office candidate runs for: H, S or P
sort_nulls_last: Toggle that sorts null values last
page: For paginating through results, starting at page 1
min_election_cycle: Filter records to only those that are applicable to a given two-year period. This cycle follows the traditional House election cycle and subdivides the presidential and Senate elections into comparable two-year blocks. The cycle begins with an odd year and is named for its ending, even year.
sort_hide_null: Hide null values on sorted column(s).
election_year: Filter records to only those that were applicable to a given two-year period.The cycle begins with an odd year and is named for its ending, even year.
election_full: True indicates that full election period of a candidate. False indicates that two year election cycle.
is_active_candidate: Candidates who are actively seeking office. If no value is specified, all candidates are returned. When True is specified, only active candidates are returned. When False is specified, only inactive candidates are returned.
sort_null_only: Toggle that filters out all rows having sort column that is non-null
per_page: The number of results returned per page. Defaults to 20.
max_election_cycle: Filter records to only those that are applicable to a given two-year period. This cycle follows the traditional House election cycle and subdivides the presidential and Senate elections into comparable two-year blocks. The cycle begins with an odd year and is named for its ending, even year.
sort: Provide a field to sort by. Use - for descending order.
api_key: An API key provided by the API provider. This key is not clearly documented in the API description. Check the API documentation for details.

Value

BKTODO: Return descriptions are not yet implemented in beekeeper