Package 'fecapi'

Title: 'OpenFEC' 'API' Client
Description: A client to interact with the 'OpenFEC' 'API' at <https://api.open.fec.gov/developers/>. The 'OpenFEC' 'API' provides programmatic access to campaign finance data stored by the Federal Election Commission.
Authors: Jon Harmon [aut, cre]
Maintainer: Jon Harmon <[email protected]>
License: MIT + file LICENSE
Version: 0.0.0.9001
Built: 2024-10-24 05:45:16 UTC
Source: https://github.com/jonthegeek/fecapi

Help Index


Call the OpenFEC API

Description

Generate and perform request to an OpenFEC endpoint.

Usage

fec_call_api(
  path,
  query = list(),
  body = NULL,
  method = NULL,
  pagination = c("none", "basic"),
  max_results = Inf,
  max_reqs = Inf,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY"),
  call = rlang::caller_env()
)

Arguments

path

The route to an API endpoint. Optionally, a list or character vector with the path as one or more unnamed arguments (which will be concatenated with "/") plus named arguments to glue::glue() into the path.

query

An optional list or character vector of parameters to pass in the query portion of the request. Can also include a .multi argument to pass to httr2::req_url_query() to control how elements containing multiple values are handled.

body

An object to use as the body of the request. If any component of the body is a path, pass it through fs::path() or otherwise give it the class "fs_path" to indicate that it is a path.

method

If the method is something other than GET or POST, supply it. Case is ignored.

pagination

The pagination scheme to use. Currently either "none" (the default) or "basic" (a scheme that uses per_page and returned pages information). If an endpoint has a per_page argument, use "basic".

max_results

The maximum number of results to return. Note that slightly more results may be returned if max_results is not evenly divisible by 100.

max_reqs

The maximum number of separate requests to perform. Passed to the max_reqs argument of httr2::req_perform_iterative() when next_req is supplied. The default 2 should likely be changed to Inf after you validate the function.

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.

call

The execution environment of a currently running function, e.g. caller_env(). The function will be mentioned in error messages as the source of the error. See the call argument of abort() for more information.

Value

A tibble with the results of the API call.


Get audit case

Description

This endpoint contains Final Audit Reports approved by the Commission since inception. The search can be based on information about the audited committee (Name, FEC ID Number, Type, Election Cycle) or the issues covered in the report.

Usage

fec_get_audit_case(
  audit_case_id,
  cycle,
  sub_category_id,
  sort_nulls_last,
  sort_hide_null,
  min_election_cycle,
  audit_id,
  q,
  per_page,
  max_election_cycle,
  candidate_id,
  committee_type,
  qq,
  page,
  committee_id,
  committee_designation,
  primary_category_id,
  sort_null_only,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

audit_case_id

Primary/foreign key for audit tables

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.

sub_category_id

The finding id of an audit. Finding are a category of broader issues. Each category has an unique ID.

sort_nulls_last

Toggle that sorts null values last

sort_hide_null

Hide null values on sorted column(s).

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.

audit_id

The audit issue. Each subcategory has an unique ID

q

The name of the committee. If a committee changes its name, the most recent name will be shown. Committee names are not unique. Use committee_id for looking up records.

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.

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

committee_type

The one-letter type code of the organization: - C communication cost - D delegate - E electioneering communication - H House - I independent expenditure filer (not a committee) - N PAC - nonqualified - O independent expenditure-only (super PACs) - P presidential - Q PAC - qualified - S Senate - U single candidate independent expenditure - V PAC with non-contribution account, nonqualified - W PAC with non-contribution account, qualified - X party, nonqualified - Y party, qualified - Z national party non-federal account

qq

Name of candidate running for office

page

For paginating through results, starting at page 1

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

committee_designation

Type of committee: - H or S - Congressional - P - Presidential - X or Y or Z - Party - N or Q - PAC - I - Independent expenditure - O - Super PAC

primary_category_id

Audit category ID (table PK)

sort_null_only

Toggle that filters out all rows having sort column that is non-null

sort

Provide a field to sort by. Use - for descending order. ex: -case_no

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


Get audit category

Description

This lists the options for the categories and subcategories available in the /audit-search/ endpoint.

Usage

fec_get_audit_category(
  sort_nulls_last,
  page,
  primary_category_name,
  sort_hide_null,
  primary_category_id,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

primary_category_name

Primary Audit Category - No Findings or Issues/Not a Committee - Net Outstanding Campaign/Convention Expenditures/Obligations - Payments/Disgorgements - Allocation Issues - Prohibited Contributions - Disclosure - Recordkeeping - Repayment to US Treasury - Other - Misstatement of Financial Activity - Excessive Contributions - Failure to File Reports/Schedules/Notices - Loans - Referred Findings Not Listed

sort_hide_null

Hide null values on sorted column(s).

primary_category_id

Audit category ID (table PK)

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.

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


Get audit primary category

Description

This lists the options for the primary categories available in the /audit-search/ endpoint.

Usage

fec_get_audit_primary_category(
  sort_nulls_last,
  page,
  primary_category_name,
  sort_hide_null,
  primary_category_id,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

primary_category_name

Primary Audit Category - No Findings or Issues/Not a Committee - Net Outstanding Campaign/Convention Expenditures/Obligations - Payments/Disgorgements - Allocation Issues - Prohibited Contributions - Disclosure - Recordkeeping - Repayment to US Treasury - Other - Misstatement of Financial Activity - Excessive Contributions - Failure to File Reports/Schedules/Notices - Loans - Referred Findings Not Listed

sort_hide_null

Hide null values on sorted column(s).

primary_category_id

Audit category ID (table PK)

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.

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


Get calendar dates

Description

Combines the election and reporting dates with Commission meetings, conferences, outreach, Advisory Opinions, rules, litigation dates and other events into one calendar. State and report type filtering is no longer available.

Usage

fec_get_calendar_dates(
  sort_nulls_last,
  page,
  min_start_date,
  calendar_category_id,
  sort_hide_null,
  min_end_date,
  event_id,
  sort_null_only,
  per_page,
  description,
  sort,
  max_end_date,
  summary,
  max_start_date,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

min_start_date

The minimum start date.(MM/DD/YYYY or YYYY-MM-DD)

calendar_category_id

Each type of event has a calendar category with an integer id. Options are: Open Meetings: 32, Executive Sessions: 39, Public Hearings: 40, Conferences: 33, Roundtables: 34, Election Dates: 36, Federal Holidays: 37, FEA Periods: 38, Commission Meetings: 20, Reporting Deadlines: 21, Conferences and Outreach: 22, AOs and Rules: 23, Other: 24, Quarterly: 25, Monthly: 26, Pre and Post-Elections: 27, EC Periods:28, and IE Periods: 29

sort_hide_null

Hide null values on sorted column(s).

min_end_date

The minimum end date.(MM/DD/YYYY or YYYY-MM-DD)

event_id

An unique ID for an event. Useful for downloading a single event to your calendar. This ID is not a permanent, persistent ID.

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.

description

Brief description of event

sort

Provide a field to sort by. Use - for descending order.

max_end_date

The maximum end date.(MM/DD/YYYY or YYYY-MM-DD)

summary

Longer description of event

max_start_date

The maximum start date.(MM/DD/YYYY or YYYY-MM-DD)

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


Get calendar dates export

Description

Returns CSV or ICS for downloading directly into calendar applications like Google, Outlook or other applications. Combines the election and reporting dates with Commission meetings, conferences, outreach, Advisory Opinions, rules, litigation dates and other events into one calendar. State filtering now applies to elections, reports and reporting periods. Presidential pre-primary report due dates are not shown on even years. Filers generally opt to file monthly rather than submit over 50 pre-primary election reports. All reporting deadlines are available at /reporting-dates/ for reference. This is the sql function that creates the calendar.

Usage

fec_get_calendar_dates_export(
  renderer,
  sort_nulls_last,
  page,
  min_start_date,
  calendar_category_id,
  sort_hide_null,
  min_end_date,
  event_id,
  sort_null_only,
  per_page,
  description,
  sort,
  max_end_date,
  summary,
  max_start_date,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

renderer

BKTODO: No description provided.

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

min_start_date

The minimum start date.(MM/DD/YYYY or YYYY-MM-DD)

calendar_category_id

Each type of event has a calendar category with an integer id. Options are: Open Meetings: 32, Executive Sessions: 39, Public Hearings: 40, Conferences: 33, Roundtables: 34, Election Dates: 36, Federal Holidays: 37, FEA Periods: 38, Commission Meetings: 20, Reporting Deadlines: 21, Conferences and Outreach: 22, AOs and Rules: 23, Other: 24, Quarterly: 25, Monthly: 26, Pre and Post-Elections: 27, EC Periods:28, and IE Periods: 29

sort_hide_null

Hide null values on sorted column(s).

min_end_date

The minimum end date.(MM/DD/YYYY or YYYY-MM-DD)

event_id

An unique ID for an event. Useful for downloading a single event to your calendar. This ID is not a permanent, persistent ID.

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.

description

Brief description of event

sort

Provide a field to sort by. Use - for descending order.

max_end_date

The maximum end date.(MM/DD/YYYY or YYYY-MM-DD)

summary

Longer description of event

max_start_date

The maximum start date.(MM/DD/YYYY or YYYY-MM-DD)

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


Get candidate candidate id

Description

This endpoint is useful for finding detailed information about a particular candidate. Use the candidate_id to find the most recent information about that candidate.

Usage

fec_get_candidate_candidate_id(
  office,
  candidate_status,
  cycle,
  sort_nulls_last,
  state,
  district,
  year,
  name,
  sort_hide_null,
  federal_funds_flag,
  per_page,
  page,
  sort,
  has_raised_funds,
  election_year,
  sort_null_only,
  incumbent_challenge,
  party,
  candidate_id,
  max_results = Inf,
  max_reqs = Inf,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

office

Federal office candidate runs for: H, S or P

candidate_status

One-letter code explaining if the candidate is: - C present candidate - F future candidate - N not yet a candidate - P prior candidate

cycle

Two-year election cycle in which a candidate runs for office. Calculated from Form 2. The cycle begins with an odd year and is named for its ending, even year. This cycle follows the traditional house election cycle and subdivides the presidential and Senate elections into comparable two-year blocks. To retrieve data for the entire four years of a presidential term or six years of a senatorial term, you will need the election_full flag.

sort_nulls_last

Toggle that sorts null values last

state

US state or territory where a candidate runs for office

district

Two-digit US House distirict of the office the candidate is running for. Presidential, Senate and House at-large candidates will have District 00.

year

Retrieve records pertaining to a particular election year. The list of election years is based on a candidate filing a statement of candidacy (F2) for that year.

name

Name (candidate or committee) to search for. Alias for 'q'.

sort_hide_null

Hide null values on sorted column(s).

federal_funds_flag

A boolean the describes if a presidential candidate has accepted federal funds. The flag will be false for House and Senate candidates.

per_page

The number of results returned per page. Defaults to 20.

page

For paginating through results, starting at page 1

sort

Provide a field to sort by. Use - for descending order.

has_raised_funds

A boolean that describes if a candidate's committee has ever received any receipts for their campaign for this particular office. (Candidates have separate candidate IDs for each office.)

election_year

Year of election

sort_null_only

Toggle that filters out all rows having sort column that is non-null

incumbent_challenge

One-letter code ('I', 'C', 'O') explaining if the candidate is an incumbent, a challenger, or if the seat is open.

party

Three-letter code for the party affiliated with a candidate or committee. For example, DEM for Democratic Party and REP for Republican Party.

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

max_results

The maximum number of results to return. Note that slightly more results may be returned if max_results is not evenly divisible by 100.

max_reqs

The maximum number of separate requests to perform. Passed to the max_reqs argument of httr2::req_perform_iterative() when next_req is supplied. The default 2 should likely be changed to Inf after you validate the function.

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


Get candidate candidate id committees

Description

This endpoint is useful for finding detailed information about a particular committee or filer. Use the committee_id to find the most recent information about the committee.

Usage

fec_get_candidate_candidate_id_committees(
  designation,
  committee_type,
  page,
  filing_frequency,
  cycle,
  sort_hide_null,
  year,
  sort_nulls_last,
  sort_null_only,
  per_page,
  organization_type,
  sort,
  candidate_id,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

designation

The one-letter designation code of the organization: - A authorized by a candidate - J joint fundraising committee - P principal campaign committee of a candidate - U unauthorized - B lobbyist/registrant PAC - D leadership PAC

committee_type

The one-letter type code of the organization: - C communication cost - D delegate - E electioneering communication - H House - I independent expenditure filer (not a committee) - N PAC - nonqualified - O independent expenditure-only (super PACs) - P presidential - Q PAC - qualified - S Senate - U single candidate independent expenditure - V PAC with non-contribution account, nonqualified - W PAC with non-contribution account, qualified - X party, nonqualified - Y party, qualified - Z national party non-federal account

page

For paginating through results, starting at page 1

filing_frequency

The one-letter code of the filing frequency: - A Administratively terminated - D Debt - M Monthly filer - Q Quarterly filer - T Terminated - W Waived

cycle

A two year election cycle that the committee was active- (after original registration date but before expiration date in Form 1s) 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).

year

A year that the committee was active— (after original registration date or filing but before expiration date)

sort_nulls_last

Toggle that sorts null values last

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.

organization_type

The one-letter code for the kind for organization: - C corporation - L labor organization - M membership organization - T trade association - V cooperative - W corporation without capital stock

sort

Provide a field to sort by. Use - for descending order.

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

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


Get candidate candidate id committees history

Description

Explore a filer's characteristics over time. This can be particularly useful if the committees change treasurers, designation, or committee_type.

Usage

fec_get_candidate_candidate_id_committees_history(
  designation,
  sort_nulls_last,
  page,
  sort_hide_null,
  election_full,
  sort_null_only,
  per_page,
  sort,
  candidate_id,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

designation

The one-letter designation code of the organization: - A authorized by a candidate - J joint fundraising committee - P principal campaign committee of a candidate - U unauthorized - B lobbyist/registrant PAC - D leadership PAC

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

sort_hide_null

Hide null values on sorted column(s).

election_full

True indicates that full election period of a candidate. False indicates that two year election cycle.

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.

sort

Provide a field to sort by. Use - for descending order.

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

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


Get candidate candidate id committees history cycle

Description

Explore a filer's characteristics over time. This can be particularly useful if the committees change treasurers, designation, or committee_type.

Usage

fec_get_candidate_candidate_id_committees_history_cycle(
  designation,
  sort_nulls_last,
  page,
  sort_hide_null,
  election_full,
  sort_null_only,
  per_page,
  sort,
  candidate_id,
  cycle,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

designation

The one-letter designation code of the organization: - A authorized by a candidate - J joint fundraising committee - P principal campaign committee of a candidate - U unauthorized - B lobbyist/registrant PAC - D leadership PAC

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

sort_hide_null

Hide null values on sorted column(s).

election_full

True indicates that full election period of a candidate. False indicates that two year election cycle.

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.

sort

Provide a field to sort by. Use - for descending order.

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

cycle

A two year election cycle that the committee was active- (after original registration date but before expiration date in Form 1s) The cycle begins with an odd year and is named for its ending, even year.

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


Get candidate candidate id filings

Description

All official records and reports filed by or delivered to the FEC. Note: because the filings data includes many records, counts for large result sets are approximate; you will want to page through the records until no records are returned.

Usage

fec_get_candidate_candidate_id_filings(
  office,
  file_number,
  form_category,
  cycle,
  district,
  document_type,
  sort_hide_null,
  state,
  amendment_indicator,
  sort_nulls_last,
  is_amended,
  filer_type,
  max_receipt_date,
  per_page,
  primary_general_indicator,
  request_type,
  report_year,
  form_type,
  committee_type,
  beginning_image_number,
  page,
  sort,
  min_receipt_date,
  sort_null_only,
  q_filer,
  report_type,
  party,
  most_recent,
  candidate_id,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

office

Federal office candidate runs for: H, S or P

file_number

Filing ID number

form_category

The forms filed are categorized based on the nature of the filing: - REPORT F3, F3X, F3P, F3L, F4, F5, F7, F13 - NOTICE F5, F24, F6, F9, F10, F11 - STATEMENT F1, F2 - OTHER F1M, F8, F99, F12, FRQ

cycle

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.

district

Two-digit US House distirict of the office the candidate is running for. Presidential, Senate and House at-large candidates will have District 00.

document_type

The type of document for documents other than reports: - 2 24 Hour Contribution Notice - 4 48 Hour Contribution Notice - A Debt Settlement Statement - B Acknowledgment of Receipt of Debt Settlement Statement - C RFAI: Debt Settlement First Notice - D Commission Debt Settlement Review - E Commission Response TO Debt Settlement Request - F Administrative Termination - G Debt Settlement Plan Amendment - H Disavowal Notice - I Disavowal Response - J Conduit Report - K Termination Approval - L Repeat Non-Filer Notice - M Filing Frequency Change Notice - N Paper Amendment to Electronic Report - O Acknowledgment of Filing Frequency Change - S RFAI: Debt Settlement Second - T Miscellaneous Report TO FEC - V Repeat Violation Notice (441A OR 441B) - P Notice of Paper Filing - R F3L Filing Frequency Change Notice - Q Acknowledgment of F3L Filing Frequency Change - U Unregistered Committee Notice

sort_hide_null

Hide null values on sorted column(s).

state

US state or territory where a candidate runs for office

amendment_indicator

Amendent types: -N new -A amendment -T terminated -C consolidated -M multi-candidate -S secondary NULL might be new or amendment. If amendment indicator is null and the filings is the first or first in a chain treat it as if it was a new. If it is not the first or first in a chain then treat the filing as an amendment.

sort_nulls_last

Toggle that sorts null values last

is_amended

False indicates that a report is the most recent. True indicates that the report has been superseded by an amendment.

filer_type

The method used to file with the FEC, either electronic or on paper.

max_receipt_date

Selects all filings received before this date(MM/DD/YYYY or YYYY-MM-DD)

per_page

The number of results returned per page. Defaults to 20.

primary_general_indicator

Primary, general or special election indicator.

request_type

Requests for additional information (RFAIs) sent to filers. The request type is based on the type of document filed: - 1 Statement of Organization - 2 Report of Receipts and Expenditures (Form 3 and 3X) - 3 Second Notice - Reports - 4 Request for Additional Information - 5 Informational - Reports - 6 Second Notice - Statement of Organization - 7 Failure to File - 8 From Public Disclosure - 9 From Multi Candidate Status

report_year

Forms with coverage date - year from the coverage ending date. Forms without coverage date - year from the receipt date.

form_type

The form where the underlying data comes from, for example, Form 1 would appear as F1: - F1 Statement of Organization - F1M Notification of Multicandidate Status - F2 Statement of Candidacy - F3 Report of Receipts and Disbursements for an Authorized Committee - F3P Report of Receipts and Disbursements by an Authorized Committee of a Candidate for The Office of President or Vice President - F3L Report of Contributions Bundled by Lobbyists/Registrants and Lobbyist/Registrant PACs - F3X Report of Receipts and Disbursements for other than an Authorized Committee - F4 Report of Receipts and Disbursements for a Committee or Organization Supporting a Nomination Convention - F5 Report of Independent Expenditures Made and Contributions Received - F6 48 Hour Notice of Contributions/Loans Received - F7 Report of Communication Costs by Corporations and Membership Organizations - F8 Debt Settlement Plan - F9 24 Hour Notice of Disbursements for Electioneering Communications - F13 Report of Donations Accepted for Inaugural Committee - F99 Miscellaneous Text - FRQ Request for Additional Information

committee_type

The one-letter type code of the organization: - C communication cost - D delegate - E electioneering communication - H House - I independent expenditure filer (not a committee) - N PAC - nonqualified - O independent expenditure-only (super PACs) - P presidential - Q PAC - qualified - S Senate - U single candidate independent expenditure - V PAC with non-contribution account, nonqualified - W PAC with non-contribution account, qualified - X party, nonqualified - Y party, qualified - Z national party non-federal account

beginning_image_number

Unique identifier for the electronic or paper report. This number is used to construct PDF URLs to the original document.

page

For paginating through results, starting at page 1

sort

Provide a field to sort by. Use - for descending order. ex: -case_no

min_receipt_date

Selects all filings received after this date(MM/DD/YYYY or YYYY-MM-DD)

sort_null_only

Toggle that filters out all rows having sort column that is non-null

q_filer

Keyword search for filer name or ID

report_type

Name of report where the underlying data comes from: - 10D Pre-Election - 10G Pre-General - 10P Pre-Primary - 10R Pre-Run-Off - 10S Pre-Special - 12C Pre-Convention - 12G Pre-General - 12P Pre-Primary - 12R Pre-Run-Off - 12S Pre-Special - 30D Post-Election - 30G Post-General - 30P Post-Primary - 30R Post-Run-Off - 30S Post-Special - 60D Post-Convention - M1 January Monthly - M10 October Monthly - M11 November Monthly - M12 December Monthly - M2 February Monthly - M3 March Monthly - M4 April Monthly - M5 May Monthly - M6 June Monthly - M7 July Monthly - M8 August Monthly - M9 September Monthly - MY Mid-Year Report - Q1 April Quarterly - Q2 July Quarterly - Q3 October Quarterly - TER Termination Report - YE Year-End - ADJ COMP ADJUST AMEND - CA COMPREHENSIVE AMEND - 90S Post Inaugural Supplement - 90D Post Inaugural - 48 48 Hour Notification - 24 24 Hour Notification - M7S July Monthly/Semi-Annual - MSA Monthly Semi-Annual (MY) - MYS Monthly Year End/Semi-Annual - Q2S July Quarterly/Semi-Annual - QSA Quarterly Semi-Annual (MY) - QYS Quarterly Year End/Semi-Annual - QYE Quarterly Semi-Annual (YE) - QMS Quarterly Mid-Year/ Semi-Annual - MSY Monthly Semi-Annual (YE)

party

Three-letter code for the party affiliated with a candidate or committee. For example, DEM for Democratic Party and REP for Republican Party.

most_recent

Report is either new or is the most-recently filed amendment

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

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


Get candidate candidate id history

Description

Find out a candidate's characteristics over time. This is particularly useful if the candidate runs for the same office in different districts or you want to know more about a candidate's previous races. This information is organized by candidate_id, so it won't help you find a candidate who ran for different offices over time; candidates get a new ID for each office.

Usage

fec_get_candidate_candidate_id_history(
  sort_nulls_last,
  per_page,
  sort_null_only,
  sort_hide_null,
  sort,
  election_full,
  page,
  candidate_id,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

sort_nulls_last

Toggle that sorts null values last

per_page

The number of results returned per page. Defaults to 20.

sort_null_only

Toggle that filters out all rows having sort column that is non-null

sort_hide_null

Hide null values on sorted column(s).

sort

Provide a field to sort by. Use - for descending order.

election_full

True indicates that full election period of a candidate. False indicates that two year election cycle.

page

For paginating through results, starting at page 1

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

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


Get candidate candidate id history cycle

Description

Find out a candidate's characteristics over time. This is particularly useful if the candidate runs for the same office in different districts or you want to know more about a candidate's previous races. This information is organized by candidate_id, so it won't help you find a candidate who ran for different offices over time; candidates get a new ID for each office.

Usage

fec_get_candidate_candidate_id_history_cycle(
  sort_nulls_last,
  per_page,
  sort_null_only,
  sort_hide_null,
  sort,
  election_full,
  page,
  candidate_id,
  cycle,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

sort_nulls_last

Toggle that sorts null values last

per_page

The number of results returned per page. Defaults to 20.

sort_null_only

Toggle that filters out all rows having sort column that is non-null

sort_hide_null

Hide null values on sorted column(s).

sort

Provide a field to sort by. Use - for descending order.

election_full

True indicates that full election period of a candidate. False indicates that two year election cycle.

page

For paginating through results, starting at page 1

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

cycle

Two-year election cycle in which a candidate runs for office. Calculated from Form 2. The cycle begins with an odd year and is named for its ending, even year. This cycle follows the traditional house election cycle and subdivides the presidential and Senate elections into comparable two-year blocks. To retrieve data for the entire four years of a presidential term or six years of a senatorial term, you will need the election_full flag.

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


Get candidate candidate id totals

Description

This endpoint provides information about a committee's Form 3, Form 3X, or Form 3P financial reports, which are aggregated by two-year period. We refer to two-year periods as a cycle. The cycle is named after the even-numbered year and includes the year before it. To obtain totals from 2013 and 2014, you would use 2014. In odd-numbered years, the current cycle is the next year — for example, in 2015, the current cycle is 2016. For presidential and Senate candidates, multiple two-year cycles exist between elections.

Usage

fec_get_candidate_candidate_id_totals(
  sort_nulls_last,
  cycle,
  page,
  sort_hide_null,
  election_full,
  sort_null_only,
  per_page,
  sort,
  candidate_id,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

sort_nulls_last

Toggle that sorts null values last

cycle

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.

page

For paginating through results, starting at page 1

sort_hide_null

Hide null values on sorted column(s).

election_full

True indicates that full election period of a candidate. False indicates that two year election cycle.

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.

sort

Provide a field to sort by. Use - for descending order.

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

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


Get candidates

Description

Fetch basic information about candidates, and use parameters to filter results to the candidates you're looking for. Each result reflects a unique FEC candidate ID. That ID is particular to the candidate for a particular office sought. If a candidate runs for the same office multiple times, the ID stays the same. If the same person runs for another office — for example, a House candidate runs for a Senate office — that candidate will get a unique ID for each office.

Usage

fec_get_candidates(
  office = NULL,
  candidate_status = NULL,
  cycle = NULL,
  district = NULL,
  year = NULL,
  state = NULL,
  name = NULL,
  is_active_candidate = NULL,
  federal_funds_flag = NULL,
  candidate_id = NULL,
  min_first_file_date = NULL,
  has_raised_funds = NULL,
  election_year = NULL,
  incumbent_challenge = NULL,
  max_first_file_date = NULL,
  party = NULL,
  sort = NULL,
  sort_hide_null = NULL,
  sort_null_only = NULL,
  sort_nulls_last = NULL,
  max_results = 100,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

office

Federal office candidate runs for: H, S or P

candidate_status

One-letter code explaining if the candidate is: - C present candidate - F future candidate - N not yet a candidate - P prior candidate

cycle

Two-year election cycle in which a candidate runs for office. Calculated from Form 2. The cycle begins with an odd year and is named for its ending, even year. This cycle follows the traditional house election cycle and subdivides the presidential and Senate elections into comparable two-year blocks. To retrieve data for the entire four years of a presidential term or six years of a senatorial term, you will need the election_full flag.

district

Two-digit US House distirict of the office the candidate is running for. Presidential, Senate and House at-large candidates will have District 00.

year

Retrieve records pertaining to a particular election year. The list of election years is based on a candidate filing a statement of candidacy (F2) for that year.

state

US state or territory where a candidate runs for office

name

Name of candidate running for office

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.

federal_funds_flag

A boolean the describes if a presidential candidate has accepted federal funds. The flag will be false for House and Senate candidates.

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

min_first_file_date

Selects all candidates whose first filing was received by the FEC after this date.

has_raised_funds

A boolean that describes if a candidate's committee has ever received any receipts for their campaign for this particular office. (Candidates have separate candidate IDs for each office.)

election_year

Year of election

incumbent_challenge

One-letter code ('I', 'C', 'O') explaining if the candidate is an incumbent, a challenger, or if the seat is open.

max_first_file_date

Selects all candidates whose first filing was received by the FEC before this date.

party

Three-letter code for the party affiliated with a candidate or committee. For example, DEM for Democratic Party and REP for Republican Party.

sort

Provide a field to sort by. Use - for descending order.

sort_hide_null

Hide null values on sorted column(s).

sort_null_only

Toggle that filters out all rows having sort column that is non-null

sort_nulls_last

Toggle that sorts null values last

max_results

The maximum number of results to return. Note that slightly more results may be returned if max_results is not evenly divisible by 100.

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


Get candidates totals

Description

Aggregated candidate receipts and disbursements grouped by cycle.

Usage

fec_get_candidates_totals(
  office,
  min_receipts,
  cycle,
  district,
  max_receipts,
  sort_hide_null,
  state,
  max_debts_owed_by_committee,
  sort_nulls_last,
  min_debts_owed_by_committee,
  is_active_candidate,
  q,
  federal_funds_flag,
  per_page,
  max_cash_on_hand_end_period,
  max_disbursements,
  candidate_id,
  page,
  has_raised_funds,
  election_full,
  election_year,
  sort_null_only,
  min_cash_on_hand_end_period,
  sort,
  party,
  min_disbursements,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

office

Federal office candidate runs for: H, S or P

min_receipts

Minimum aggregated receipts

cycle

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.

district

District of candidate

max_receipts

Maximum aggregated receipts

sort_hide_null

Hide null values on sorted column(s).

state

State of candidate

max_debts_owed_by_committee

Maximum debt

sort_nulls_last

Toggle that sorts null values last

min_debts_owed_by_committee

Minimum debt

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.

q

Name of candidate running for office

federal_funds_flag

A boolean the describes if a presidential candidate has accepted federal funds. The flag will be false for House and Senate candidates.

per_page

The number of results returned per page. Defaults to 20.

max_cash_on_hand_end_period

Maximum cash on hand

max_disbursements

Maximum aggregated disbursements

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

page

For paginating through results, starting at page 1

has_raised_funds

A boolean that describes if a candidate's committee has ever received any receipts for their campaign for this particular office. (Candidates have separate candidate IDs for each office.)

election_full

True indicates that full election period of a candidate. False indicates that two year election cycle.

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.

sort_null_only

Toggle that filters out all rows having sort column that is non-null

min_cash_on_hand_end_period

Minimum cash on hand

sort

Provide a field to sort by. Use - for descending order.

party

Three-letter party code

min_disbursements

Minimum aggregated disbursements

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


Get candidates totals aggregates

Description

Candidate total receipts and disbursements aggregated by aggregate_by.

Usage

fec_get_candidates_totals_aggregates(
  office,
  sort_nulls_last,
  district,
  state,
  min_election_cycle,
  sort_hide_null,
  is_active_candidate,
  per_page,
  max_election_cycle,
  aggregate_by,
  page,
  election_year,
  election_full,
  sort_null_only,
  sort,
  party,
  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

district

Two-digit US House distirict of the office the candidate is running for. Presidential, Senate and House at-large candidates will have District 00.

state

US state or territory where a candidate runs for office

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).

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.

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.

aggregate_by

Candidate totals aggregate_by (Chose one of dropdown options): - ' ' grouped by election year - office grouped by election year, by office - office-state grouped by election year, by office, by state - office-state-district grouped by election year, by office, by state, by district - office-party grouped by election year, by office, by party

page

For paginating through results, starting at page 1

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.

sort_null_only

Toggle that filters out all rows having sort column that is non-null

sort

Provide a field to sort by. Use - for descending order. ex: -case_no

party

Three-letter code for the party affiliated with a candidate or committee. For example, DEM for Democratic Party and REP for Republican Party.

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


Get candidates totals by office

Description

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


Get candidates totals by office by party

Description

Aggregated candidate receipts and disbursements grouped by office by party by cycle.

Usage

fec_get_candidates_totals_by_office_by_party(
  office,
  sort_nulls_last,
  page,
  sort_hide_null,
  election_year,
  election_full,
  is_active_candidate,
  sort_null_only,
  per_page,
  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

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.

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


Get committee committee id

Description

This endpoint is useful for finding detailed information about a particular committee or filer. Use the committee_id to find the most recent information about the committee.

Usage

fec_get_committee_committee_id(
  designation,
  committee_type,
  page,
  filing_frequency,
  cycle,
  sort_hide_null,
  year,
  sort_nulls_last,
  sort_null_only,
  per_page,
  organization_type,
  sort,
  committee_id,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

designation

The one-letter designation code of the organization: - A authorized by a candidate - J joint fundraising committee - P principal campaign committee of a candidate - U unauthorized - B lobbyist/registrant PAC - D leadership PAC

committee_type

The one-letter type code of the organization: - C communication cost - D delegate - E electioneering communication - H House - I independent expenditure filer (not a committee) - N PAC - nonqualified - O independent expenditure-only (super PACs) - P presidential - Q PAC - qualified - S Senate - U single candidate independent expenditure - V PAC with non-contribution account, nonqualified - W PAC with non-contribution account, qualified - X party, nonqualified - Y party, qualified - Z national party non-federal account

page

For paginating through results, starting at page 1

filing_frequency

The one-letter code of the filing frequency: - A Administratively terminated - D Debt - M Monthly filer - Q Quarterly filer - T Terminated - W Waived

cycle

A two year election cycle that the committee was active- (after original registration date but before expiration date in Form 1s) 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).

year

A year that the committee was active— (after original registration date or filing but before expiration date)

sort_nulls_last

Toggle that sorts null values last

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.

organization_type

The one-letter code for the kind for organization: - C corporation - L labor organization - M membership organization - T trade association - V cooperative - W corporation without capital stock

sort

Provide a field to sort by. Use - for descending order.

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

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


Get committee committee id candidates

Description

This endpoint is useful for finding detailed information about a particular candidate. Use the candidate_id to find the most recent information about that candidate.

Usage

fec_get_committee_committee_id_candidates(
  office,
  candidate_status,
  cycle,
  sort_nulls_last,
  state,
  district,
  year,
  name,
  sort_hide_null,
  federal_funds_flag,
  per_page,
  page,
  sort,
  has_raised_funds,
  election_year,
  sort_null_only,
  incumbent_challenge,
  party,
  committee_id,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

office

Federal office candidate runs for: H, S or P

candidate_status

One-letter code explaining if the candidate is: - C present candidate - F future candidate - N not yet a candidate - P prior candidate

cycle

Two-year election cycle in which a candidate runs for office. Calculated from Form 2. The cycle begins with an odd year and is named for its ending, even year. This cycle follows the traditional house election cycle and subdivides the presidential and Senate elections into comparable two-year blocks. To retrieve data for the entire four years of a presidential term or six years of a senatorial term, you will need the election_full flag.

sort_nulls_last

Toggle that sorts null values last

state

US state or territory where a candidate runs for office

district

Two-digit US House distirict of the office the candidate is running for. Presidential, Senate and House at-large candidates will have District 00.

year

Retrieve records pertaining to a particular election year. The list of election years is based on a candidate filing a statement of candidacy (F2) for that year.

name

Name (candidate or committee) to search for. Alias for 'q'.

sort_hide_null

Hide null values on sorted column(s).

federal_funds_flag

A boolean the describes if a presidential candidate has accepted federal funds. The flag will be false for House and Senate candidates.

per_page

The number of results returned per page. Defaults to 20.

page

For paginating through results, starting at page 1

sort

Provide a field to sort by. Use - for descending order.

has_raised_funds

A boolean that describes if a candidate's committee has ever received any receipts for their campaign for this particular office. (Candidates have separate candidate IDs for each office.)

election_year

Year of election

sort_null_only

Toggle that filters out all rows having sort column that is non-null

incumbent_challenge

One-letter code ('I', 'C', 'O') explaining if the candidate is an incumbent, a challenger, or if the seat is open.

party

Three-letter code for the party affiliated with a candidate or committee. For example, DEM for Democratic Party and REP for Republican Party.

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

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


Get committee committee id candidates history

Description

Find out a candidate's characteristics over time. This is particularly useful if the candidate runs for the same office in different districts or you want to know more about a candidate's previous races. This information is organized by candidate_id, so it won't help you find a candidate who ran for different offices over time; candidates get a new ID for each office.

Usage

fec_get_committee_committee_id_candidates_history(
  sort_nulls_last,
  per_page,
  sort_null_only,
  sort_hide_null,
  sort,
  election_full,
  page,
  committee_id,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

sort_nulls_last

Toggle that sorts null values last

per_page

The number of results returned per page. Defaults to 20.

sort_null_only

Toggle that filters out all rows having sort column that is non-null

sort_hide_null

Hide null values on sorted column(s).

sort

Provide a field to sort by. Use - for descending order.

election_full

True indicates that full election period of a candidate. False indicates that two year election cycle.

page

For paginating through results, starting at page 1

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

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


Get committee committee id candidates history cycle

Description

Find out a candidate's characteristics over time. This is particularly useful if the candidate runs for the same office in different districts or you want to know more about a candidate's previous races. This information is organized by candidate_id, so it won't help you find a candidate who ran for different offices over time; candidates get a new ID for each office.

Usage

fec_get_committee_committee_id_candidates_history_cycle(
  sort_nulls_last,
  per_page,
  sort_null_only,
  sort_hide_null,
  sort,
  election_full,
  page,
  committee_id,
  cycle,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

sort_nulls_last

Toggle that sorts null values last

per_page

The number of results returned per page. Defaults to 20.

sort_null_only

Toggle that filters out all rows having sort column that is non-null

sort_hide_null

Hide null values on sorted column(s).

sort

Provide a field to sort by. Use - for descending order.

election_full

True indicates that full election period of a candidate. False indicates that two year election cycle.

page

For paginating through results, starting at page 1

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

cycle

Two-year election cycle in which a candidate runs for office. Calculated from Form 2. The cycle begins with an odd year and is named for its ending, even year. This cycle follows the traditional house election cycle and subdivides the presidential and Senate elections into comparable two-year blocks. To retrieve data for the entire four years of a presidential term or six years of a senatorial term, you will need the election_full flag.

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


Get committee committee id filings

Description

All official records and reports filed by or delivered to the FEC. Note: because the filings data includes many records, counts for large result sets are approximate; you will want to page through the records until no records are returned.

Usage

fec_get_committee_committee_id_filings(
  office,
  file_number,
  form_category,
  cycle,
  district,
  document_type,
  sort_hide_null,
  state,
  amendment_indicator,
  sort_nulls_last,
  is_amended,
  filer_type,
  max_receipt_date,
  per_page,
  primary_general_indicator,
  request_type,
  report_year,
  form_type,
  committee_type,
  beginning_image_number,
  page,
  sort,
  min_receipt_date,
  sort_null_only,
  q_filer,
  report_type,
  party,
  most_recent,
  committee_id,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

office

Federal office candidate runs for: H, S or P

file_number

Filing ID number

form_category

The forms filed are categorized based on the nature of the filing: - REPORT F3, F3X, F3P, F3L, F4, F5, F7, F13 - NOTICE F5, F24, F6, F9, F10, F11 - STATEMENT F1, F2 - OTHER F1M, F8, F99, F12, FRQ

cycle

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.

district

Two-digit US House distirict of the office the candidate is running for. Presidential, Senate and House at-large candidates will have District 00.

document_type

The type of document for documents other than reports: - 2 24 Hour Contribution Notice - 4 48 Hour Contribution Notice - A Debt Settlement Statement - B Acknowledgment of Receipt of Debt Settlement Statement - C RFAI: Debt Settlement First Notice - D Commission Debt Settlement Review - E Commission Response TO Debt Settlement Request - F Administrative Termination - G Debt Settlement Plan Amendment - H Disavowal Notice - I Disavowal Response - J Conduit Report - K Termination Approval - L Repeat Non-Filer Notice - M Filing Frequency Change Notice - N Paper Amendment to Electronic Report - O Acknowledgment of Filing Frequency Change - S RFAI: Debt Settlement Second - T Miscellaneous Report TO FEC - V Repeat Violation Notice (441A OR 441B) - P Notice of Paper Filing - R F3L Filing Frequency Change Notice - Q Acknowledgment of F3L Filing Frequency Change - U Unregistered Committee Notice

sort_hide_null

Hide null values on sorted column(s).

state

US state or territory where a candidate runs for office

amendment_indicator

Amendent types: -N new -A amendment -T terminated -C consolidated -M multi-candidate -S secondary NULL might be new or amendment. If amendment indicator is null and the filings is the first or first in a chain treat it as if it was a new. If it is not the first or first in a chain then treat the filing as an amendment.

sort_nulls_last

Toggle that sorts null values last

is_amended

False indicates that a report is the most recent. True indicates that the report has been superseded by an amendment.

filer_type

The method used to file with the FEC, either electronic or on paper.

max_receipt_date

Selects all filings received before this date(MM/DD/YYYY or YYYY-MM-DD)

per_page

The number of results returned per page. Defaults to 20.

primary_general_indicator

Primary, general or special election indicator.

request_type

Requests for additional information (RFAIs) sent to filers. The request type is based on the type of document filed: - 1 Statement of Organization - 2 Report of Receipts and Expenditures (Form 3 and 3X) - 3 Second Notice - Reports - 4 Request for Additional Information - 5 Informational - Reports - 6 Second Notice - Statement of Organization - 7 Failure to File - 8 From Public Disclosure - 9 From Multi Candidate Status

report_year

Forms with coverage date - year from the coverage ending date. Forms without coverage date - year from the receipt date.

form_type

The form where the underlying data comes from, for example, Form 1 would appear as F1: - F1 Statement of Organization - F1M Notification of Multicandidate Status - F2 Statement of Candidacy - F3 Report of Receipts and Disbursements for an Authorized Committee - F3P Report of Receipts and Disbursements by an Authorized Committee of a Candidate for The Office of President or Vice President - F3L Report of Contributions Bundled by Lobbyists/Registrants and Lobbyist/Registrant PACs - F3X Report of Receipts and Disbursements for other than an Authorized Committee - F4 Report of Receipts and Disbursements for a Committee or Organization Supporting a Nomination Convention - F5 Report of Independent Expenditures Made and Contributions Received - F6 48 Hour Notice of Contributions/Loans Received - F7 Report of Communication Costs by Corporations and Membership Organizations - F8 Debt Settlement Plan - F9 24 Hour Notice of Disbursements for Electioneering Communications - F13 Report of Donations Accepted for Inaugural Committee - F99 Miscellaneous Text - FRQ Request for Additional Information

committee_type

The one-letter type code of the organization: - C communication cost - D delegate - E electioneering communication - H House - I independent expenditure filer (not a committee) - N PAC - nonqualified - O independent expenditure-only (super PACs) - P presidential - Q PAC - qualified - S Senate - U single candidate independent expenditure - V PAC with non-contribution account, nonqualified - W PAC with non-contribution account, qualified - X party, nonqualified - Y party, qualified - Z national party non-federal account

beginning_image_number

Unique identifier for the electronic or paper report. This number is used to construct PDF URLs to the original document.

page

For paginating through results, starting at page 1

sort

Provide a field to sort by. Use - for descending order. ex: -case_no

min_receipt_date

Selects all filings received after this date(MM/DD/YYYY or YYYY-MM-DD)

sort_null_only

Toggle that filters out all rows having sort column that is non-null

q_filer

Keyword search for filer name or ID

report_type

Name of report where the underlying data comes from: - 10D Pre-Election - 10G Pre-General - 10P Pre-Primary - 10R Pre-Run-Off - 10S Pre-Special - 12C Pre-Convention - 12G Pre-General - 12P Pre-Primary - 12R Pre-Run-Off - 12S Pre-Special - 30D Post-Election - 30G Post-General - 30P Post-Primary - 30R Post-Run-Off - 30S Post-Special - 60D Post-Convention - M1 January Monthly - M10 October Monthly - M11 November Monthly - M12 December Monthly - M2 February Monthly - M3 March Monthly - M4 April Monthly - M5 May Monthly - M6 June Monthly - M7 July Monthly - M8 August Monthly - M9 September Monthly - MY Mid-Year Report - Q1 April Quarterly - Q2 July Quarterly - Q3 October Quarterly - TER Termination Report - YE Year-End - ADJ COMP ADJUST AMEND - CA COMPREHENSIVE AMEND - 90S Post Inaugural Supplement - 90D Post Inaugural - 48 48 Hour Notification - 24 24 Hour Notification - M7S July Monthly/Semi-Annual - MSA Monthly Semi-Annual (MY) - MYS Monthly Year End/Semi-Annual - Q2S July Quarterly/Semi-Annual - QSA Quarterly Semi-Annual (MY) - QYS Quarterly Year End/Semi-Annual - QYE Quarterly Semi-Annual (YE) - QMS Quarterly Mid-Year/ Semi-Annual - MSY Monthly Semi-Annual (YE)

party

Three-letter code for the party affiliated with a candidate or committee. For example, DEM for Democratic Party and REP for Republican Party.

most_recent

Report is either new or is the most-recently filed amendment

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

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


Get committee committee id history

Description

Explore a filer's characteristics over time. This can be particularly useful if the committees change treasurers, designation, or committee_type.

Usage

fec_get_committee_committee_id_history(
  designation,
  sort_nulls_last,
  page,
  sort_hide_null,
  election_full,
  sort_null_only,
  per_page,
  sort,
  committee_id,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

designation

The one-letter designation code of the organization: - A authorized by a candidate - J joint fundraising committee - P principal campaign committee of a candidate - U unauthorized - B lobbyist/registrant PAC - D leadership PAC

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

sort_hide_null

Hide null values on sorted column(s).

election_full

True indicates that full election period of a candidate. False indicates that two year election cycle.

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.

sort

Provide a field to sort by. Use - for descending order.

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

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


Get committee committee id history cycle

Description

Explore a filer's characteristics over time. This can be particularly useful if the committees change treasurers, designation, or committee_type.

Usage

fec_get_committee_committee_id_history_cycle(
  designation,
  sort_nulls_last,
  page,
  sort_hide_null,
  election_full,
  sort_null_only,
  per_page,
  sort,
  committee_id,
  cycle,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

designation

The one-letter designation code of the organization: - A authorized by a candidate - J joint fundraising committee - P principal campaign committee of a candidate - U unauthorized - B lobbyist/registrant PAC - D leadership PAC

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

sort_hide_null

Hide null values on sorted column(s).

election_full

True indicates that full election period of a candidate. False indicates that two year election cycle.

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.

sort

Provide a field to sort by. Use - for descending order.

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

cycle

A two year election cycle that the committee was active- (after original registration date but before expiration date in Form 1s) The cycle begins with an odd year and is named for its ending, even year.

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


Get committee committee id reports

Description

Each report represents the summary information from Form 3, Form 3X and Form 3P. These reports have key statistics that illuminate the financial status of a given committee. Things like cash on hand, debts owed by committee, total receipts, and total disbursements are especially helpful for understanding a committee's financial dealings. By default, this endpoint includes both amended and final versions of each report. To restrict to only the final versions of each report, use is_amended=false; to retrieve only reports that have been amended, use is_amended=true. Several different reporting structures exist, depending on the type of organization that submits financial information. To see an example of these reporting requirements, look at the summary and detailed summary pages of Form 3, Form 3X, and Form 3P. DISCLAIMER: The field labels contained within this resource are subject to change. We are attempting to succinctly label these fields while conveying clear meaning to ensure accessibility for all users.

Usage

fec_get_committee_committee_id_reports(
  min_debts_owed_amount,
  max_disbursements_amount,
  max_total_contributions,
  max_debts_owed_expenditures,
  cycle,
  sort_nulls_last,
  sort_hide_null,
  year,
  max_receipts_amount,
  max_cash_on_hand_end_period_amount,
  is_amended,
  min_disbursements_amount,
  max_party_coordinated_expenditures,
  per_page,
  max_independent_expenditures,
  min_receipts_amount,
  min_party_coordinated_expenditures,
  candidate_id,
  beginning_image_number,
  page,
  type,
  sort,
  min_total_contributions,
  min_cash_on_hand_end_period_amount,
  sort_null_only,
  min_independent_expenditures,
  report_type,
  committee_id,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

min_debts_owed_amount

Filter for all amounts greater than a value.

max_disbursements_amount

Filter for all amounts less than a value.

max_total_contributions

Filter for all amounts less than a value.

max_debts_owed_expenditures

Filter for all amounts less than a value.

cycle

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.

sort_nulls_last

Toggle that sorts null values last

sort_hide_null

Hide null values on sorted column(s).

year

Forms with coverage date - year from the coverage ending date. Forms without coverage date - year from the receipt date.

max_receipts_amount

Filter for all amounts less than a value.

max_cash_on_hand_end_period_amount

Filter for all amounts less than a value.

is_amended

False indicates that a report is the most recent. True indicates that the report has been superseded by an amendment.

min_disbursements_amount

Filter for all amounts greater than a value.

max_party_coordinated_expenditures

Filter for all amounts less than a value.

per_page

The number of results returned per page. Defaults to 20.

max_independent_expenditures

Filter for all amounts less than a value.

min_receipts_amount

Filter for all amounts greater than a value.

min_party_coordinated_expenditures

Filter for all amounts greater than a value.

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

beginning_image_number

Unique identifier for the electronic or paper report. This number is used to construct PDF URLs to the original document.

page

For paginating through results, starting at page 1

type

The one-letter type code of the organization: - C communication cost - D delegate - E electioneering communication - H House - I independent expenditure filer (not a committee) - N PAC - nonqualified - O independent expenditure-only (super PACs) - P presidential - Q PAC - qualified - S Senate - U single candidate independent expenditure - V PAC with non-contribution account, nonqualified - W PAC with non-contribution account, qualified - X party, nonqualified - Y party, qualified - Z national party non-federal account

sort

Provide a field to sort by. Use - for descending order. ex: -case_no

min_total_contributions

Filter for all amounts greater than a value.

min_cash_on_hand_end_period_amount

Filter for all amounts greater than a value.

sort_null_only

Toggle that filters out all rows having sort column that is non-null

min_independent_expenditures

Filter for all amounts greater than a value.

report_type

Report type; prefix with "-" to exclude. Name of report where the underlying data comes from: - 10D Pre-Election - 10G Pre-General - 10P Pre-Primary - 10R Pre-Run-Off - 10S Pre-Special - 12C Pre-Convention - 12G Pre-General - 12P Pre-Primary - 12R Pre-Run-Off - 12S Pre-Special - 30D Post-Election - 30G Post-General - 30P Post-Primary - 30R Post-Run-Off - 30S Post-Special - 60D Post-Convention - M1 January Monthly - M10 October Monthly - M11 November Monthly - M12 December Monthly - M2 February Monthly - M3 March Monthly - M4 April Monthly - M5 May Monthly - M6 June Monthly - M7 July Monthly - M8 August Monthly - M9 September Monthly - MY Mid-Year Report - Q1 April Quarterly - Q2 July Quarterly - Q3 October Quarterly - TER Termination Report - YE Year-End - ADJ COMP ADJUST AMEND - CA COMPREHENSIVE AMEND

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

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


Get committee committee id totals

Description

This endpoint provides information about a committee's Form 3, Form 3X, or Form 3P financial reports, which are aggregated by two-year period. We refer to two-year periods as a cycle. The cycle is named after the even-numbered year and includes the year before it. To obtain totals from 2013 and 2014, you would use 2014. In odd-numbered years, the current cycle is the next year — for example, in 2015, the current cycle is 2016. For presidential and Senate candidates, multiple two-year cycles exist between elections.

Usage

fec_get_committee_committee_id_totals(
  cycle,
  sort_nulls_last,
  per_page,
  sort_null_only,
  sort_hide_null,
  sort,
  page,
  committee_id,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

cycle

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.

sort_nulls_last

Toggle that sorts null values last

per_page

The number of results returned per page. Defaults to 20.

sort_null_only

Toggle that filters out all rows having sort column that is non-null

sort_hide_null

Hide null values on sorted column(s).

sort

Provide a field to sort by. Use - for descending order.

page

For paginating through results, starting at page 1

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

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


Get committees

Description

Fetch basic information about committees and filers. Use parameters to filter for particular characteristics.

Usage

fec_get_committees(
  designation,
  max_first_f1_date,
  min_first_f1_date,
  cycle,
  filing_frequency,
  sort_nulls_last,
  sort_hide_null,
  year,
  state,
  sponsor_candidate_id,
  q,
  per_page,
  min_last_f1_date,
  candidate_id,
  committee_type,
  min_first_file_date,
  page,
  sort,
  committee_id,
  sort_null_only,
  max_last_f1_date,
  treasurer_name,
  organization_type,
  max_first_file_date,
  party,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

designation

The one-letter designation code of the organization: - A authorized by a candidate - J joint fundraising committee - P principal campaign committee of a candidate - U unauthorized - B lobbyist/registrant PAC - D leadership PAC

max_first_f1_date

Filter for committees whose first Form 1 was received on or before this date.

min_first_f1_date

Filter for committees whose first Form 1 was received on or after this date.

cycle

A two year election cycle that the committee was active- (after original registration date but before expiration date in Form 1s) The cycle begins with an odd year and is named for its ending, even year.

filing_frequency

The one-letter code of the filing frequency: - A Administratively terminated - D Debt - M Monthly filer - Q Quarterly filer - T Terminated - W Waived

sort_nulls_last

Toggle that sorts null values last

sort_hide_null

Hide null values on sorted column(s).

year

A year that the committee was active— (after original registration date or filing but before expiration date)

state

US state or territory

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office. This is a filter for Leadership PAC sponsor.

q

The name of the committee. If a committee changes its name, the most recent name will be shown. Committee names are not unique. Use committee_id for looking up records.

per_page

The number of results returned per page. Defaults to 20.

min_last_f1_date

Filter for committees whose latest Form 1 was received on or after this date.

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

committee_type

The one-letter type code of the organization: - C communication cost - D delegate - E electioneering communication - H House - I independent expenditure filer (not a committee) - N PAC - nonqualified - O independent expenditure-only (super PACs) - P presidential - Q PAC - qualified - S Senate - U single candidate independent expenditure - V PAC with non-contribution account, nonqualified - W PAC with non-contribution account, qualified - X party, nonqualified - Y party, qualified - Z national party non-federal account

min_first_file_date

Filter for committees whose first filing was received on or after this date.

page

For paginating through results, starting at page 1

sort

Provide a field to sort by. Use - for descending order.

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

sort_null_only

Toggle that filters out all rows having sort column that is non-null

max_last_f1_date

Filter for committees whose latest Form 1 was received on or before this date.

treasurer_name

Name of the Committee's treasurer. If multiple treasurers for the committee, the most recent treasurer will be shown.

organization_type

The one-letter code for the kind for organization: - C corporation - L labor organization - M membership organization - T trade association - V cooperative - W corporation without capital stock

max_first_file_date

Filter for committees whose first filing was received on or before this date.

party

Three-letter code for the party affiliated with a candidate or committee. For example, DEM for Democratic Party and REP for Republican Party.

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


Get communication costs

Description

52 U.S.C. 30118 allows "communications by a corporation to its stockholders and executive or administrative personnel and their families or by a labor organization to its members and their families on any subject," including the express advocacy of the election or defeat of any Federal candidate. The costs of such communications must be reported to the Federal Election Commission under certain circumstances.

Usage

fec_get_communication_costs(
  max_amount,
  max_image_number,
  sort_nulls_last,
  support_oppose_indicator,
  sort_hide_null,
  line_number,
  per_page,
  candidate_id,
  page,
  min_date,
  committee_id,
  min_amount,
  min_image_number,
  sort_null_only,
  image_number,
  sort,
  max_date,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

max_amount

Filter for all amounts less than a value.

max_image_number

Maxium image number of the page where the schedule item is reported

sort_nulls_last

Toggle that sorts null values last

support_oppose_indicator

Support or opposition

sort_hide_null

Hide null values on sorted column(s).

line_number

Filter for form and line number using the following format: FORM-LINENUMBER. For example an argument such as F3X-16 would filter down to all entries from form F3X line number 16.

per_page

The number of results returned per page. Defaults to 20.

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

page

For paginating through results, starting at page 1

min_date

Minimum date

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

min_amount

Filter for all amounts greater than a value.

min_image_number

Minium image number of the page where the schedule item is reported

sort_null_only

Toggle that filters out all rows having sort column that is non-null

image_number

An unique identifier for each page where the electronic or paper filing is reported.

sort

Provide a field to sort by. Use - for descending order.

max_date

Maximum date

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


Get communication costs aggregates

Description

Communication cost aggregated by candidate ID and committee ID.

Usage

fec_get_communication_costs_aggregates(
  candidate_id,
  page,
  cycle,
  support_oppose_indicator,
  sort_hide_null,
  sort_nulls_last,
  committee_id,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

page

For paginating through results, starting at page 1

cycle

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.

support_oppose_indicator

Support or opposition

sort_hide_null

Hide null values on sorted column(s).

sort_nulls_last

Toggle that sorts null values last

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

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.

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


Get communication costs by candidate

Description

Communication cost aggregated by candidate ID and committee ID.

Usage

fec_get_communication_costs_by_candidate(
  office,
  candidate_id,
  cycle,
  district,
  state,
  page,
  support_oppose,
  election_full,
  sort_hide_null,
  sort_nulls_last,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

office

Federal office candidate runs for: H, S or P

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

cycle

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.

district

Two-digit US House distirict of the office the candidate is running for. Presidential, Senate and House at-large candidates will have District 00.

state

US state or territory where a candidate runs for office

page

For paginating through results, starting at page 1

support_oppose

Support or opposition

election_full

True indicates that full election period of a candidate. False indicates that two year election cycle.

sort_hide_null

Hide null values on sorted column(s).

sort_nulls_last

Toggle that sorts null values last

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.

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


Get communication costs totals by candidate

Description

Total communications costs aggregated across committees on supported or opposed candidates by cycle or candidate election year.

Usage

fec_get_communication_costs_totals_by_candidate(
  candidate_id,
  sort_nulls_last,
  page,
  cycle,
  sort_hide_null,
  election_full,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

cycle

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.

sort_hide_null

Hide null values on sorted column(s).

election_full

True indicates that full election period of a candidate. False indicates that two year election cycle.

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.

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


Get efile filings

Description

Basic information about electronic files coming into the FEC, posted as they are received.

Usage

fec_get_efile_filings(
  file_number,
  sort_nulls_last,
  page,
  per_page,
  sort_hide_null,
  committee_id,
  min_receipt_date,
  max_receipt_date,
  q_filer,
  sort_null_only,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

file_number

Filing ID number

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

per_page

The number of results returned per page. Defaults to 20.

sort_hide_null

Hide null values on sorted column(s).

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

min_receipt_date

Selects all filings received after this date(MM/DD/YYYY or YYYY-MM-DD)

max_receipt_date

Selects all filings received before this date(MM/DD/YYYY or YYYY-MM-DD)

q_filer

Keyword search for filer name or ID

sort_null_only

Toggle that filters out all rows having sort column that is non-null

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


Get efile reports house senate

Description

Key financial data reported periodically by committees as they are reported. This feed includes summary information from the the House F3 reports, the presidential F3p reports and the PAC and party F3x reports. Generally, committees file reports on a quarterly or monthly basis, but some must also submit a report 12 days before primary elections. Therefore, during the primary season, the period covered by this file may be different for different committees. These totals also incorporate any changes made by committees, if any report covering the period is amended. DISCLAIMER: The field labels contained within this resource are subject to change. We are attempting to succinctly label these fields while conveying clear meaning to ensure accessibility for all users.

Usage

fec_get_efile_reports_house_senate(
  file_number,
  sort_nulls_last,
  page,
  per_page,
  sort_hide_null,
  committee_id,
  min_receipt_date,
  max_receipt_date,
  q_filer,
  sort_null_only,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

file_number

Filing ID number

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

per_page

The number of results returned per page. Defaults to 20.

sort_hide_null

Hide null values on sorted column(s).

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

min_receipt_date

Selects all filings received after this date(MM/DD/YYYY or YYYY-MM-DD)

max_receipt_date

Selects all filings received before this date(MM/DD/YYYY or YYYY-MM-DD)

q_filer

Keyword search for filer name or ID

sort_null_only

Toggle that filters out all rows having sort column that is non-null

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


Get efile reports pac party

Description

Key financial data reported periodically by committees as they are reported. This feed includes summary information from the the House F3 reports, the presidential F3p reports and the PAC and party F3x reports. Generally, committees file reports on a quarterly or monthly basis, but some must also submit a report 12 days before primary elections. Therefore, during the primary season, the period covered by this file may be different for different committees. These totals also incorporate any changes made by committees, if any report covering the period is amended. DISCLAIMER: The field labels contained within this resource are subject to change. We are attempting to succinctly label these fields while conveying clear meaning to ensure accessibility for all users.

Usage

fec_get_efile_reports_pac_party(
  file_number,
  sort_nulls_last,
  page,
  per_page,
  sort_hide_null,
  committee_id,
  min_receipt_date,
  max_receipt_date,
  q_filer,
  sort_null_only,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

file_number

Filing ID number

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

per_page

The number of results returned per page. Defaults to 20.

sort_hide_null

Hide null values on sorted column(s).

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

min_receipt_date

Selects all filings received after this date(MM/DD/YYYY or YYYY-MM-DD)

max_receipt_date

Selects all filings received before this date(MM/DD/YYYY or YYYY-MM-DD)

q_filer

Keyword search for filer name or ID

sort_null_only

Toggle that filters out all rows having sort column that is non-null

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


Get efile reports presidential

Description

Key financial data reported periodically by committees as they are reported. This feed includes summary information from the the House F3 reports, the presidential F3p reports and the PAC and party F3x reports. Generally, committees file reports on a quarterly or monthly basis, but some must also submit a report 12 days before primary elections. Therefore, during the primary season, the period covered by this file may be different for different committees. These totals also incorporate any changes made by committees, if any report covering the period is amended. DISCLAIMER: The field labels contained within this resource are subject to change. We are attempting to succinctly label these fields while conveying clear meaning to ensure accessibility for all users.

Usage

fec_get_efile_reports_presidential(
  file_number,
  sort_nulls_last,
  page,
  per_page,
  sort_hide_null,
  committee_id,
  min_receipt_date,
  max_receipt_date,
  q_filer,
  sort_null_only,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

file_number

Filing ID number

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

per_page

The number of results returned per page. Defaults to 20.

sort_hide_null

Hide null values on sorted column(s).

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

min_receipt_date

Selects all filings received after this date(MM/DD/YYYY or YYYY-MM-DD)

max_receipt_date

Selects all filings received before this date(MM/DD/YYYY or YYYY-MM-DD)

q_filer

Keyword search for filer name or ID

sort_null_only

Toggle that filters out all rows having sort column that is non-null

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


Get election dates

Description

FEC election dates since 1995.

Usage

fec_get_election_dates(
  max_update_date,
  sort_nulls_last,
  sort_hide_null,
  max_primary_general_date,
  min_update_date,
  max_create_date,
  per_page,
  min_election_date,
  election_party,
  election_type_id,
  page,
  min_create_date,
  min_primary_general_date,
  election_year,
  election_district,
  office_sought,
  sort_null_only,
  max_election_date,
  sort,
  election_state,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

max_update_date

The maximum date this record was last updated.(MM/DD/YYYY or YYYY-MM-DD)

sort_nulls_last

Toggle that sorts null values last

sort_hide_null

Hide null values on sorted column(s).

max_primary_general_date

The maximum date of primary or general election.(MM/DD/YYYY or YYYY-MM-DD)

min_update_date

The minimum date this record was last updated.(MM/DD/YYYY or YYYY-MM-DD)

max_create_date

The maximum date this record was added to the system.(MM/DD/YYYY or YYYY-MM-DD)

per_page

The number of results returned per page. Defaults to 20.

min_election_date

The minimum date of election.

election_party

Party, if applicable.

election_type_id

Election type id

page

For paginating through results, starting at page 1

min_create_date

The minimum date this record was added to the system.(MM/DD/YYYY or YYYY-MM-DD)

min_primary_general_date

The minimum date of primary or general election.(MM/DD/YYYY or YYYY-MM-DD)

election_year

Year of election

election_district

House district of the office sought, if applicable.

office_sought

House, Senate or presidential office.

sort_null_only

Toggle that filters out all rows having sort column that is non-null

max_election_date

The maximum date of election.

sort

Provide a field to sort by. Use - for descending order.

election_state

State or territory of the office sought.

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


Get electioneering

Description

An electioneering communication is any broadcast, cable or satellite communication that fulfills each of the following conditions: The communication refers to a clearly identified federal candidate. The communication is publicly distributed by a television station, radio station, cable television system or satellite system for a fee. The communication is distributed within 60 days prior to a general election or 30 days prior to a primary election to federal office.

Usage

fec_get_electioneering(
  candidate_id,
  max_amount,
  sort_nulls_last,
  page,
  sort_hide_null,
  committee_id,
  min_date,
  min_amount,
  per_page,
  sort_null_only,
  description,
  sort,
  report_year,
  last_index,
  max_date,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

max_amount

Filter for all amounts less than a value.

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

sort_hide_null

Hide null values on sorted column(s).

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

min_date

Minimum disbursement date

min_amount

Filter for all amounts greater than a value.

per_page

The number of results returned per page. Defaults to 20.

sort_null_only

Toggle that filters out all rows having sort column that is non-null

description

BKTODO: No description provided.

sort

Provide a field to sort by. Use - for descending order.

report_year

Forms with coverage date - year from the coverage ending date. Forms without coverage date - year from the receipt date.

last_index

Index of last result from previous page

max_date

Maximum disbursement date

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


Get electioneering aggregates

Description

Electioneering communications costs aggregates

Usage

fec_get_electioneering_aggregates(
  candidate_id,
  sort_nulls_last,
  page,
  cycle,
  sort_hide_null,
  committee_id,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

cycle

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.

sort_hide_null

Hide null values on sorted column(s).

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

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.

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


Get electioneering by candidate

Description

Electioneering costs aggregated by candidate

Usage

fec_get_electioneering_by_candidate(
  office,
  candidate_id,
  cycle,
  district,
  state,
  page,
  sort_hide_null,
  election_full,
  sort_nulls_last,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

office

Federal office candidate runs for: H, S or P

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

cycle

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.

district

Two-digit US House distirict of the office the candidate is running for. Presidential, Senate and House at-large candidates will have District 00.

state

US state or territory where a candidate runs for office

page

For paginating through results, starting at page 1

sort_hide_null

Hide null values on sorted column(s).

election_full

True indicates that full election period of a candidate. False indicates that two year election cycle.

sort_nulls_last

Toggle that sorts null values last

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.

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


Get electioneering totals by candidate

Description

Total electioneering communications spent on candidates by cycle or candidate election year

Usage

fec_get_electioneering_totals_by_candidate(
  candidate_id,
  sort_nulls_last,
  page,
  cycle,
  sort_hide_null,
  election_full,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

cycle

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.

sort_hide_null

Hide null values on sorted column(s).

election_full

True indicates that full election period of a candidate. False indicates that two year election cycle.

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.

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


Get elections

Description

Look at the top-level financial information for all candidates running for the same office. Choose a 2-year cycle, and house, senate or presidential. If you are looking for a Senate seat, you will need to select the state using a two-letter abbreviation. House races require state and a two-digit district number. Since this endpoint reflects financial information, it will only have candidates once they file financial reporting forms. Query the ⁠/candidates⁠ endpoint to retrieve an-up-to-date list of all the candidates that filed to run for a particular seat.

Usage

fec_get_elections(
  office,
  page,
  district,
  state,
  cycle,
  sort_hide_null,
  election_full,
  sort_nulls_last,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

office

Federal office candidate runs for: H, S or P

page

For paginating through results, starting at page 1

district

Two-digit US House distirict of the office the candidate is running for. Presidential, Senate and House at-large candidates will have District 00.

state

US state or territory where a candidate runs for office

cycle

Two-year election cycle in which a candidate runs for office. Calculated from Form 2. The cycle begins with an odd year and is named for its ending, even year. This cycle follows the traditional house election cycle and subdivides the presidential and Senate elections into comparable two-year blocks. To retrieve data for the entire four years of a presidential term or six years of a senatorial term, you will need the election_full flag.

sort_hide_null

Hide null values on sorted column(s).

election_full

True indicates that full election period of a candidate. False indicates that two year election cycle.

sort_nulls_last

Toggle that sorts null values last

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.

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


Get elections summary

Description

List elections by cycle, office, state, and district.

Usage

fec_get_elections_summary(
  office,
  cycle,
  district,
  state,
  election_full,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

office

Federal office candidate runs for: H, S or P

cycle

Two-year election cycle in which a candidate runs for office. Calculated from Form 2. The cycle begins with an odd year and is named for its ending, even year. This cycle follows the traditional house election cycle and subdivides the presidential and Senate elections into comparable two-year blocks. To retrieve data for the entire four years of a presidential term or six years of a senatorial term, you will need the election_full flag.

district

Two-digit US House distirict of the office the candidate is running for. Presidential, Senate and House at-large candidates will have District 00.

state

US state or territory where a candidate runs for office

election_full

True indicates that full election period of a candidate. False indicates that two year election cycle.

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


Get filings

Description

All official records and reports filed by or delivered to the FEC. Note: because the filings data includes many records, counts for large result sets are approximate; you will want to page through the records until no records are returned.

Usage

fec_get_filings(
  office,
  file_number,
  form_category,
  cycle,
  district,
  document_type,
  sort_hide_null,
  state,
  amendment_indicator,
  sort_nulls_last,
  is_amended,
  filer_type,
  max_receipt_date,
  per_page,
  primary_general_indicator,
  request_type,
  report_year,
  form_type,
  candidate_id,
  committee_type,
  beginning_image_number,
  page,
  sort,
  committee_id,
  min_receipt_date,
  sort_null_only,
  q_filer,
  report_type,
  party,
  most_recent,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

office

Federal office candidate runs for: H, S or P

file_number

Filing ID number

form_category

The forms filed are categorized based on the nature of the filing: - REPORT F3, F3X, F3P, F3L, F4, F5, F7, F13 - NOTICE F5, F24, F6, F9, F10, F11 - STATEMENT F1, F2 - OTHER F1M, F8, F99, F12, FRQ

cycle

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.

district

Two-digit US House distirict of the office the candidate is running for. Presidential, Senate and House at-large candidates will have District 00.

document_type

The type of document for documents other than reports: - 2 24 Hour Contribution Notice - 4 48 Hour Contribution Notice - A Debt Settlement Statement - B Acknowledgment of Receipt of Debt Settlement Statement - C RFAI: Debt Settlement First Notice - D Commission Debt Settlement Review - E Commission Response TO Debt Settlement Request - F Administrative Termination - G Debt Settlement Plan Amendment - H Disavowal Notice - I Disavowal Response - J Conduit Report - K Termination Approval - L Repeat Non-Filer Notice - M Filing Frequency Change Notice - N Paper Amendment to Electronic Report - O Acknowledgment of Filing Frequency Change - S RFAI: Debt Settlement Second - T Miscellaneous Report TO FEC - V Repeat Violation Notice (441A OR 441B) - P Notice of Paper Filing - R F3L Filing Frequency Change Notice - Q Acknowledgment of F3L Filing Frequency Change - U Unregistered Committee Notice

sort_hide_null

Hide null values on sorted column(s).

state

US state or territory where a candidate runs for office

amendment_indicator

Amendent types: -N new -A amendment -T terminated -C consolidated -M multi-candidate -S secondary NULL might be new or amendment. If amendment indicator is null and the filings is the first or first in a chain treat it as if it was a new. If it is not the first or first in a chain then treat the filing as an amendment.

sort_nulls_last

Toggle that sorts null values last

is_amended

False indicates that a report is the most recent. True indicates that the report has been superseded by an amendment.

filer_type

The method used to file with the FEC, either electronic or on paper.

max_receipt_date

Selects all filings received before this date(MM/DD/YYYY or YYYY-MM-DD)

per_page

The number of results returned per page. Defaults to 20.

primary_general_indicator

Primary, general or special election indicator.

request_type

Requests for additional information (RFAIs) sent to filers. The request type is based on the type of document filed: - 1 Statement of Organization - 2 Report of Receipts and Expenditures (Form 3 and 3X) - 3 Second Notice - Reports - 4 Request for Additional Information - 5 Informational - Reports - 6 Second Notice - Statement of Organization - 7 Failure to File - 8 From Public Disclosure - 9 From Multi Candidate Status

report_year

Forms with coverage date - year from the coverage ending date. Forms without coverage date - year from the receipt date.

form_type

The form where the underlying data comes from, for example, Form 1 would appear as F1: - F1 Statement of Organization - F1M Notification of Multicandidate Status - F2 Statement of Candidacy - F3 Report of Receipts and Disbursements for an Authorized Committee - F3P Report of Receipts and Disbursements by an Authorized Committee of a Candidate for The Office of President or Vice President - F3L Report of Contributions Bundled by Lobbyists/Registrants and Lobbyist/Registrant PACs - F3X Report of Receipts and Disbursements for other than an Authorized Committee - F4 Report of Receipts and Disbursements for a Committee or Organization Supporting a Nomination Convention - F5 Report of Independent Expenditures Made and Contributions Received - F6 48 Hour Notice of Contributions/Loans Received - F7 Report of Communication Costs by Corporations and Membership Organizations - F8 Debt Settlement Plan - F9 24 Hour Notice of Disbursements for Electioneering Communications - F13 Report of Donations Accepted for Inaugural Committee - F99 Miscellaneous Text - FRQ Request for Additional Information

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

committee_type

The one-letter type code of the organization: - C communication cost - D delegate - E electioneering communication - H House - I independent expenditure filer (not a committee) - N PAC - nonqualified - O independent expenditure-only (super PACs) - P presidential - Q PAC - qualified - S Senate - U single candidate independent expenditure - V PAC with non-contribution account, nonqualified - W PAC with non-contribution account, qualified - X party, nonqualified - Y party, qualified - Z national party non-federal account

beginning_image_number

Unique identifier for the electronic or paper report. This number is used to construct PDF URLs to the original document.

page

For paginating through results, starting at page 1

sort

Provide a field to sort by. Use - for descending order. ex: -case_no

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

min_receipt_date

Selects all filings received after this date(MM/DD/YYYY or YYYY-MM-DD)

sort_null_only

Toggle that filters out all rows having sort column that is non-null

q_filer

Keyword search for filer name or ID

report_type

Name of report where the underlying data comes from: - 10D Pre-Election - 10G Pre-General - 10P Pre-Primary - 10R Pre-Run-Off - 10S Pre-Special - 12C Pre-Convention - 12G Pre-General - 12P Pre-Primary - 12R Pre-Run-Off - 12S Pre-Special - 30D Post-Election - 30G Post-General - 30P Post-Primary - 30R Post-Run-Off - 30S Post-Special - 60D Post-Convention - M1 January Monthly - M10 October Monthly - M11 November Monthly - M12 December Monthly - M2 February Monthly - M3 March Monthly - M4 April Monthly - M5 May Monthly - M6 June Monthly - M7 July Monthly - M8 August Monthly - M9 September Monthly - MY Mid-Year Report - Q1 April Quarterly - Q2 July Quarterly - Q3 October Quarterly - TER Termination Report - YE Year-End - ADJ COMP ADJUST AMEND - CA COMPREHENSIVE AMEND - 90S Post Inaugural Supplement - 90D Post Inaugural - 48 48 Hour Notification - 24 24 Hour Notification - M7S July Monthly/Semi-Annual - MSA Monthly Semi-Annual (MY) - MYS Monthly Year End/Semi-Annual - Q2S July Quarterly/Semi-Annual - QSA Quarterly Semi-Annual (MY) - QYS Quarterly Year End/Semi-Annual - QYE Quarterly Semi-Annual (YE) - QMS Quarterly Mid-Year/ Semi-Annual - MSY Monthly Semi-Annual (YE)

party

Three-letter code for the party affiliated with a candidate or committee. For example, DEM for Democratic Party and REP for Republican Party.

most_recent

Report is either new or is the most-recently filed amendment

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


Get names audit candidates

Description

Search for candidates or committees by name. If you're looking for information on a particular person or group, using a name to find the candidate_id or committee_id on this endpoint can be a helpful first step.

Usage

fec_get_names_audit_candidates(
  q,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

q

Name (candidate or committee) to search for

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


Get names audit committees

Description

Search for candidates or committees by name. If you're looking for information on a particular person or group, using a name to find the candidate_id or committee_id on this endpoint can be a helpful first step.

Usage

fec_get_names_audit_committees(
  q,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

q

Name (candidate or committee) to search for

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


Get names candidates

Description

Search for candidates or committees by name. If you're looking for information on a particular person or group, using a name to find the candidate_id or committee_id on this endpoint can be a helpful first step.

Usage

fec_get_names_candidates(
  q,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

q

Name (candidate or committee) to search for

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


Get names committees

Description

Search for candidates or committees by name. If you're looking for information on a particular person or group, using a name to find the candidate_id or committee_id on this endpoint can be a helpful first step.

Usage

fec_get_names_committees(
  q,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

q

Name (candidate or committee) to search for

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


Get operations log

Description

The Operations log contains details of each report loaded into the database. It is primarily used as status check to determine when all of the data processes, from initial entry through review are complete.

Usage

fec_get_operations_log(
  max_coverage_end_date,
  sort_nulls_last,
  amendment_indicator,
  sort_hide_null,
  max_receipt_date,
  per_page,
  min_transaction_data_complete_date,
  form_type,
  max_transaction_data_complete_date,
  beginning_image_number,
  page,
  min_coverage_end_date,
  sort,
  min_receipt_date,
  sort_null_only,
  candidate_committee_id,
  report_type,
  report_year,
  status_num,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

max_coverage_end_date

Ending date of the reporting period before this date(MM/DD/YYYY or YYYY-MM-DD)

sort_nulls_last

Toggle that sorts null values last

amendment_indicator

Amendent types: -N new -A amendment -T terminated -C consolidated -M multi-candidate -S secondary NULL might be new or amendment. If amendment indicator is null and the filings is the first or first in a chain treat it as if it was a new. If it is not the first or first in a chain then treat the filing as an amendment.

sort_hide_null

Hide null values on sorted column(s).

max_receipt_date

Selects all filings received before this date(MM/DD/YYYY or YYYY-MM-DD)

per_page

The number of results returned per page. Defaults to 20.

min_transaction_data_complete_date

Select all filings processed completely after this date(MM/DD/YYYY or YYYY-MM-DD)

form_type

The form where the underlying data comes from, for example, Form 1 would appear as F1: - F1 Statement of Organization - F1M Notification of Multicandidate Status - F2 Statement of Candidacy - F3 Report of Receipts and Disbursements for an Authorized Committee - F3P Report of Receipts and Disbursements by an Authorized Committee of a Candidate for The Office of President or Vice President - F3L Report of Contributions Bundled by Lobbyists/Registrants and Lobbyist/Registrant PACs - F3X Report of Receipts and Disbursements for other than an Authorized Committee - F4 Report of Receipts and Disbursements for a Committee or Organization Supporting a Nomination Convention - F5 Report of Independent Expenditures Made and Contributions Received - F6 48 Hour Notice of Contributions/Loans Received - F7 Report of Communication Costs by Corporations and Membership Organizations - F8 Debt Settlement Plan - F9 24 Hour Notice of Disbursements for Electioneering Communications - F13 Report of Donations Accepted for Inaugural Committee - F99 Miscellaneous Text - FRQ Request for Additional Information

max_transaction_data_complete_date

Select all filings processed completely before this date(MM/DD/YYYY or YYYY-MM-DD)

beginning_image_number

Unique identifier for the electronic or paper report. This number is used to construct PDF URLs to the original document.

page

For paginating through results, starting at page 1

min_coverage_end_date

Ending date of the reporting period after this date(MM/DD/YYYY or YYYY-MM-DD)

sort

Provide a field to sort by. Use - for descending order. ex: -case_no

min_receipt_date

Selects all filings received after this date(MM/DD/YYYY or YYYY-MM-DD)

sort_null_only

Toggle that filters out all rows having sort column that is non-null

candidate_committee_id

A unique identifier of the registered filer.

report_type

Name of report where the underlying data comes from: - 10D Pre-Election - 10G Pre-General - 10P Pre-Primary - 10R Pre-Run-Off - 10S Pre-Special - 12C Pre-Convention - 12G Pre-General - 12P Pre-Primary - 12R Pre-Run-Off - 12S Pre-Special - 30D Post-Election - 30G Post-General - 30P Post-Primary - 30R Post-Run-Off - 30S Post-Special - 60D Post-Convention - M1 January Monthly - M10 October Monthly - M11 November Monthly - M12 December Monthly - M2 February Monthly - M3 March Monthly - M4 April Monthly - M5 May Monthly - M6 June Monthly - M7 July Monthly - M8 August Monthly - M9 September Monthly - MY Mid-Year Report - Q1 April Quarterly - Q2 July Quarterly - Q3 October Quarterly - TER Termination Report - YE Year-End - ADJ COMP ADJUST AMEND - CA COMPREHENSIVE AMEND - 90S Post Inaugural Supplement - 90D Post Inaugural - 48 48 Hour Notification - 24 24 Hour Notification - M7S July Monthly/Semi-Annual - MSA Monthly Semi-Annual (MY) - MYS Monthly Year End/Semi-Annual - Q2S July Quarterly/Semi-Annual - QSA Quarterly Semi-Annual (MY) - QYS Quarterly Year End/Semi-Annual - QYE Quarterly Semi-Annual (YE) - QMS Quarterly Mid-Year/ Semi-Annual - MSY Monthly Semi-Annual (YE)

report_year

Forms with coverage date - year from the coverage ending date. Forms without coverage date - year from the receipt date.

status_num

Status of the transactional report. -0- Transaction is entered into the system. But not verified. -1- Transaction is verified.

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


Get presidential contributions by candidate

Description

Net receipts per candidate. Filter with contributor_state='US' for national totals

Usage

fec_get_presidential_contributions_by_candidate(
  contributor_state,
  sort_nulls_last,
  page,
  sort_hide_null,
  election_year,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

contributor_state

State of contributor

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

sort_hide_null

Hide null values on sorted column(s).

election_year

Year of election

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.

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


Get presidential contributions by size

Description

Contribution receipts by size per candidate. Filter by candidate_id, election_year and/or size

Usage

fec_get_presidential_contributions_by_size(
  candidate_id,
  sort_nulls_last,
  page,
  sort_hide_null,
  election_year,
  size,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office. -P00000001 All candidates -P00000002 Democrasts -P00000003 Republicans

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

sort_hide_null

Hide null values on sorted column(s).

election_year

Year of election

size

The total all contributions in the following ranges: ⁠-0 $200 and under -200 $200.01 - $499.99 -500 $500 - $999.99 -1000 $1000 - $1999.99 -2000 $2000 +⁠ Unitemized contributions are included in the 0 category.

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.

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


Get presidential contributions by state

Description

Contribution receipts by state per candidate. Filter by candidate_id and/or election_year

Usage

fec_get_presidential_contributions_by_state(
  candidate_id,
  sort_nulls_last,
  page,
  sort_hide_null,
  election_year,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office. -P00000001 All candidates -P00000002 Democrasts -P00000003 Republicans

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

sort_hide_null

Hide null values on sorted column(s).

election_year

Year of election

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.

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


Get presidential coverage end date

Description

Coverage end date per candidate. Filter by candidate_id and/or election_year

Usage

fec_get_presidential_coverage_end_date(
  candidate_id,
  sort_nulls_last,
  page,
  sort_hide_null,
  election_year,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office. -P00000001 All candidates -P00000002 Democrasts -P00000003 Republicans

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

sort_hide_null

Hide null values on sorted column(s).

election_year

Year of election

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.

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


Get presidential financial summary

Description

Financial summary per candidate. Filter by candidate_id and/or election_year

Usage

fec_get_presidential_financial_summary(
  candidate_id,
  sort_nulls_last,
  page,
  sort_hide_null,
  election_year,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office. -P00000001 All candidates -P00000002 Democrasts -P00000003 Republicans

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

sort_hide_null

Hide null values on sorted column(s).

election_year

Year of election

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.

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


Get rad analyst

Description

Use this endpoint to look up the RAD Analyst for a committee. The mission of the Reports Analysis Division (RAD) is to ensure that campaigns and political committees file timely and accurate reports that fully disclose their financial activities. RAD is responsible for reviewing statements and financial reports filed by political committees participating in federal elections, providing assistance and guidance to the committees to properly file their reports, and for taking appropriate action to ensure compliance with the Federal Election Campaign Act (FECA).

Usage

fec_get_rad_analyst(
  min_assignment_update_date,
  max_assignment_update_date,
  analyst_short_id,
  email,
  page,
  sort_nulls_last,
  title,
  sort_hide_null,
  committee_id,
  name,
  telephone_ext,
  analyst_id,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

min_assignment_update_date

Filter results for assignment updates made after this date

max_assignment_update_date

Filter results for assignment updates made before this date

analyst_short_id

Short ID of RAD analyst

email

Email of RAD analyst

page

For paginating through results, starting at page 1

sort_nulls_last

Toggle that sorts null values last

title

Title of RAD analyst

sort_hide_null

Hide null values on sorted column(s).

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

name

Name of RAD analyst

telephone_ext

Telephone extension of RAD analyst

analyst_id

ID of RAD analyst

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.

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


Get reporting dates

Description

FEC election dates since 1995.

Usage

fec_get_reporting_dates(
  max_update_date,
  page,
  max_due_date,
  min_create_date,
  min_due_date,
  sort_hide_null,
  sort_nulls_last,
  min_update_date,
  max_create_date,
  per_page,
  sort_null_only,
  sort,
  report_year,
  report_type,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

max_update_date

The maximum date this record was last updated.(MM/DD/YYYY or YYYY-MM-DD)

page

For paginating through results, starting at page 1

max_due_date

The maximum date the report is due.(MM/DD/YYYY or YYYY-MM-DD)

min_create_date

The minimum date this record was added to the system.(MM/DD/YYYY or YYYY-MM-DD)

min_due_date

The minimum date the report is due.(MM/DD/YYYY or YYYY-MM-DD)

sort_hide_null

Hide null values on sorted column(s).

sort_nulls_last

Toggle that sorts null values last

min_update_date

The minimum date this record was last updated.(MM/DD/YYYY or YYYY-MM-DD)

max_create_date

The maximum date this record was added to the system.(MM/DD/YYYY or YYYY-MM-DD)

per_page

The number of results returned per page. Defaults to 20.

sort_null_only

Toggle that filters out all rows having sort column that is non-null

sort

Provide a field to sort by. Use - for descending order.

report_year

Forms with coverage date - year from the coverage ending date. Forms without coverage date - year from the receipt date.

report_type

Name of report where the underlying data comes from: - 10D Pre-Election - 10G Pre-General - 10P Pre-Primary - 10R Pre-Run-Off - 10S Pre-Special - 12C Pre-Convention - 12G Pre-General - 12P Pre-Primary - 12R Pre-Run-Off - 12S Pre-Special - 30D Post-Election - 30G Post-General - 30P Post-Primary - 30R Post-Run-Off - 30S Post-Special - 60D Post-Convention - M1 January Monthly - M10 October Monthly - M11 November Monthly - M12 December Monthly - M2 February Monthly - M3 March Monthly - M4 April Monthly - M5 May Monthly - M6 June Monthly - M7 July Monthly - M8 August Monthly - M9 September Monthly - MY Mid-Year Report - Q1 April Quarterly - Q2 July Quarterly - Q3 October Quarterly - TER Termination Report - YE Year-End - ADJ COMP ADJUST AMEND - CA COMPREHENSIVE AMEND - 90S Post Inaugural Supplement - 90D Post Inaugural - 48 48 Hour Notification - 24 24 Hour Notification - M7S July Monthly/Semi-Annual - MSA Monthly Semi-Annual (MY) - MYS Monthly Year End/Semi-Annual - Q2S July Quarterly/Semi-Annual - QSA Quarterly Semi-Annual (MY) - QYS Quarterly Year End/Semi-Annual - QYE Quarterly Semi-Annual (YE) - QMS Quarterly Mid-Year/ Semi-Annual - MSY Monthly Semi-Annual (YE)

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


Get reports entity type

Description

Each report represents the summary information from Form 3, Form 3X and Form 3P. These reports have key statistics that illuminate the financial status of a given committee. Things like cash on hand, debts owed by committee, total receipts, and total disbursements are especially helpful for understanding a committee's financial dealings. By default, this endpoint includes both amended and final versions of each report. To restrict to only the final versions of each report, use is_amended=false; to retrieve only reports that have been amended, use is_amended=true. Several different reporting structures exist, depending on the type of organization that submits financial information. To see an example of these reporting requirements, look at the summary and detailed summary pages of Form 3, Form 3X, and Form 3P. DISCLAIMER: The field labels contained within this resource are subject to change. We are attempting to succinctly label these fields while conveying clear meaning to ensure accessibility for all users.

Usage

fec_get_reports_entity_type(
  min_debts_owed_amount,
  max_debts_owed_expenditures,
  sort_hide_null,
  year,
  max_cash_on_hand_end_period_amount,
  filer_type,
  max_party_coordinated_expenditures,
  q_spender,
  max_receipt_date,
  per_page,
  max_independent_expenditures,
  min_party_coordinated_expenditures,
  committee_type,
  page,
  min_total_contributions,
  min_cash_on_hand_end_period_amount,
  min_receipt_date,
  sort_null_only,
  min_independent_expenditures,
  q_filer,
  max_disbursements_amount,
  max_total_contributions,
  cycle,
  amendment_indicator,
  sort_nulls_last,
  max_receipts_amount,
  is_amended,
  min_disbursements_amount,
  min_receipts_amount,
  candidate_id,
  beginning_image_number,
  sort,
  committee_id,
  report_type,
  most_recent,
  entity_type,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

min_debts_owed_amount

Filter for all amounts greater than a value.

max_debts_owed_expenditures

Filter for all amounts less than a value.

sort_hide_null

Hide null values on sorted column(s).

year

Forms with coverage date - year from the coverage ending date. Forms without coverage date - year from the receipt date.

max_cash_on_hand_end_period_amount

Filter for all amounts less than a value.

filer_type

The method used to file with the FEC, either electronic or on paper.

max_party_coordinated_expenditures

Filter for all amounts less than a value.

q_spender

Keyword search for spender name or ID

max_receipt_date

Selects all items received by FEC before this date(MM/DD/YYYY or YYYY-MM-DD)

per_page

The number of results returned per page. Defaults to 20.

max_independent_expenditures

Filter for all amounts less than a value.

min_party_coordinated_expenditures

Filter for all amounts greater than a value.

committee_type

The one-letter type code of the organization: - C communication cost - D delegate - E electioneering communication - H House - I independent expenditure filer (not a committee) - N PAC - nonqualified - O independent expenditure-only (super PACs) - P presidential - Q PAC - qualified - S Senate - U single candidate independent expenditure - V PAC with non-contribution account, nonqualified - W PAC with non-contribution account, qualified - X party, nonqualified - Y party, qualified - Z national party non-federal account

page

For paginating through results, starting at page 1

min_total_contributions

Filter for all amounts greater than a value.

min_cash_on_hand_end_period_amount

Filter for all amounts greater than a value.

min_receipt_date

Selects all items received by FEC after this date(MM/DD/YYYY or YYYY-MM-DD)

sort_null_only

Toggle that filters out all rows having sort column that is non-null

min_independent_expenditures

Filter for all amounts greater than a value.

q_filer

Keyword search for filer name or ID

max_disbursements_amount

Filter for all amounts less than a value.

max_total_contributions

Filter for all amounts less than a value.

cycle

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.

amendment_indicator

Amendent types: -N new -A amendment -T terminated -C consolidated -M multi-candidate -S secondary NULL might be new or amendment. If amendment indicator is null and the filings is the first or first in a chain treat it as if it was a new. If it is not the first or first in a chain then treat the filing as an amendment.

sort_nulls_last

Toggle that sorts null values last

max_receipts_amount

Filter for all amounts less than a value.

is_amended

False indicates that a report is the most recent. True indicates that the report has been superseded by an amendment.

min_disbursements_amount

Filter for all amounts greater than a value.

min_receipts_amount

Filter for all amounts greater than a value.

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

beginning_image_number

Unique identifier for the electronic or paper report. This number is used to construct PDF URLs to the original document.

sort

Provide a field to sort by. Use - for descending order. ex: -case_no

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

report_type

Report type; prefix with "-" to exclude. Name of report where the underlying data comes from: - 10D Pre-Election - 10G Pre-General - 10P Pre-Primary - 10R Pre-Run-Off - 10S Pre-Special - 12C Pre-Convention - 12G Pre-General - 12P Pre-Primary - 12R Pre-Run-Off - 12S Pre-Special - 30D Post-Election - 30G Post-General - 30P Post-Primary - 30R Post-Run-Off - 30S Post-Special - 60D Post-Convention - M1 January Monthly - M10 October Monthly - M11 November Monthly - M12 December Monthly - M2 February Monthly - M3 March Monthly - M4 April Monthly - M5 May Monthly - M6 June Monthly - M7 July Monthly - M8 August Monthly - M9 September Monthly - MY Mid-Year Report - Q1 April Quarterly - Q2 July Quarterly - Q3 October Quarterly - TER Termination Report - YE Year-End - ADJ COMP ADJUST AMEND - CA COMPREHENSIVE AMEND

most_recent

Report is either new or is the most-recently filed amendment

entity_type

Committee groupings based on FEC filing form. Choose one of: presidential, pac-party, house-senate, or ie-only

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


Get schedules schedule a

Description

This description is for both ​⁠/schedules​/schedule_a​/⁠ and ​ ⁠/schedules​/schedule_a​/{sub_id}​/⁠. This endpoint provides itemized receipts. Schedule A records describe itemized receipts, including contributions from individuals. If you are interested in contributions from an individual, use the ⁠/schedules/schedule_a/⁠ endpoint. For a more complete description of all Schedule A records visit About receipts data. If you are interested in our "is_individual" methodology visit our methodology page. ​The ⁠/schedules​/schedule_a​/⁠ endpoint is not paginated by page number. This endpoint uses keyset pagination to improve query performance and these indices are required to properly page through this large dataset. To request the next page, you should append the values found in the last_indexes object from pagination to the URL of your last request as additional parameters. For example, when sorting by contribution_receipt_date, you might receive a page of results with the two scenarios of following pagination information: case #1: ⁠pagination: { pages: 2152643, per_page: 20, count: 43052850, last_indexes: { last_index: &quot;230880619&quot;, last_contribution_receipt_date: &quot;2014-01-01&quot; } }⁠ <br/> case #2 (results which include contribution_receipt_date = NULL): ⁠pagination: { pages: 2152644, per_page: 20, count: 43052850, last_indexes: { last_index: &quot;230880639&quot;, sort_null_only: True } }⁠ To fetch the next page of sorted results, append last_index=230880619 and last_contribution_receipt_date=2014-01-01 to the URL and when reaching contribution_receipt_date=NULL, append last_index=230880639 and sort_null_only=True. We strongly advise paging through these results using sort indices. The default sort is acending by contribution_receipt_date (deprecated, will be descending). If you do not page using sort indices, some transactions may be unintentionally filtered out. Calls to ​⁠/schedules​/schedule_a​/⁠ may return many records. For large result sets, the record counts found in the pagination object are approximate; you will need to page through the records until no records are returned. To avoid throwing the "out of range" exception on the last page, one recommandation is to use total count and per_page to control the traverse loop of results. ​The ⁠/schedules​/schedule_a​/{sub_id}​/⁠ endpoint returns a single transaction, but it does include a pagination object class. Please ignore the information in that object class.

Usage

fec_get_schedules_schedule_a(
  max_load_date,
  max_amount,
  max_image_number,
  contributor_occupation,
  recipient_committee_designation,
  sort_hide_null,
  is_individual,
  line_number,
  contributor_type,
  recipient_committee_type,
  per_page,
  contributor_zip,
  contributor_city,
  last_index,
  last_contribution_receipt_amount,
  contributor_id,
  recipient_committee_org_type,
  contributor_state,
  sort,
  two_year_transaction_period,
  min_date,
  committee_id,
  contributor_employer,
  min_load_date,
  last_contribution_receipt_date,
  min_image_number,
  contributor_name,
  sort_null_only,
  image_number,
  min_amount,
  max_date,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

max_load_date

Maximum load date

max_amount

Filter for all amounts less than a value.

max_image_number

Maxium image number of the page where the schedule item is reported

contributor_occupation

Occupation of contributor, filers need to make an effort to gather this information

recipient_committee_designation

The one-letter designation code of the organization: - A authorized by a candidate - J joint fundraising committee - P principal campaign committee of a candidate - U unauthorized - B lobbyist/registrant PAC - D leadership PAC

sort_hide_null

Hide null values on sorted column(s).

is_individual

Restrict to non-earmarked individual contributions where memo code is true. Filtering individuals is useful to make sure contributions are not double reported and in creating breakdowns of the amount of money coming from individuals.

line_number

Filter for form and line number using the following format: FORM-LINENUMBER. For example an argument such as F3X-16 would filter down to all entries from form F3X line number 16.

contributor_type

Filters individual or committee contributions based on line number

recipient_committee_type

The one-letter type code of the organization: - C communication cost - D delegate - E electioneering communication - H House - I independent expenditure filer (not a committee) - N PAC - nonqualified - O independent expenditure-only (super PACs) - P presidential - Q PAC - qualified - S Senate - U single candidate independent expenditure - V PAC with non-contribution account, nonqualified - W PAC with non-contribution account, qualified - X party, nonqualified - Y party, qualified - Z national party non-federal account

per_page

The number of results returned per page. Defaults to 20.

contributor_zip

Zip code of contributor

contributor_city

City of contributor

last_index

Index of last result from previous page

last_contribution_receipt_amount

When sorting by contribution_receipt_amount, this is populated with the contribution_receipt_amount of the last result. However, you will need to pass the index of that last result to last_index to get the next page.

contributor_id

The FEC identifier should be represented here if the contributor is registered with the FEC.

recipient_committee_org_type

The one-letter code for the kind for organization: - C corporation - L labor organization - M membership organization - T trade association - V cooperative - W corporation without capital stock

contributor_state

State of contributor

sort

Provide a field to sort by. Use - for descending order.

two_year_transaction_period

This is a two-year period that is derived from the year a transaction took place in the Itemized Schedule A and Schedule B tables. In cases where we have the date of the transaction (contribution_receipt_date in schedules/schedule_a, disbursement_date in schedules/schedule_b) the two_year_transaction_period is named after the ending, even-numbered year. If we do not have the date of the transaction, we fall back to using the report year (report_year in both tables) instead, making the same cycle adjustment as necessary. If no transaction year is specified, the results default to the most current cycle.

min_date

Minimum date

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

contributor_employer

Employer of contributor, filers need to make an effort to gather this information

min_load_date

Minimum load date

last_contribution_receipt_date

When sorting by contribution_receipt_date, this is populated with the contribution_receipt_date of the last result. However, you will need to pass the index of that last result to last_index to get the next page.

min_image_number

Minium image number of the page where the schedule item is reported

contributor_name

Name of contributor

sort_null_only

Toggle that filters out all rows having sort column that is non-null

image_number

An unique identifier for each page where the electronic or paper filing is reported.

min_amount

Filter for all amounts greater than a value.

max_date

Maximum date

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


Get schedules schedule a by employer

Description

This endpoint provides itemized individual contributions received by a committee, aggregated by the contributor’s employer name. If you are interested in our “is_individual” methodology, review the methodology page. Unitemized individual contributions are not included.

Usage

fec_get_schedules_schedule_a_by_employer(
  employer,
  page,
  sort_nulls_last,
  cycle,
  sort_hide_null,
  committee_id,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

employer

Employer of contributor as reported on the committee's filing

page

For paginating through results, starting at page 1

sort_nulls_last

Toggle that sorts null values last

cycle

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.

sort_hide_null

Hide null values on sorted column(s).

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

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.

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


Get schedules schedule a by occupation

Description

This endpoint provides itemized individual contributions received by a committee, aggregated by the contributor’s occupation. If you are interested in our “is_individual” methodology, review the methodology page. Unitemized individual contributions are not included.

Usage

fec_get_schedules_schedule_a_by_occupation(
  occupation,
  page,
  sort_nulls_last,
  cycle,
  sort_hide_null,
  committee_id,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

occupation

Occupation of contributor as reported on the committee's filing

page

For paginating through results, starting at page 1

sort_nulls_last

Toggle that sorts null values last

cycle

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.

sort_hide_null

Hide null values on sorted column(s).

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

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.

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


Get schedules schedule a by size

Description

This endpoint provides individual contributions received by a committee, aggregated by size: ⁠- $200 and under - $200.01 - $499.99 - $500 - $999.99 - $1000 - $1999.99 - $2000 +⁠ The $200.00 and under category includes contributions of $200 or less combined with unitemized individual contributions.

Usage

fec_get_schedules_schedule_a_by_size(
  sort_nulls_last,
  page,
  cycle,
  sort_hide_null,
  committee_id,
  size,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

cycle

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.

sort_hide_null

Hide null values on sorted column(s).

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

size

The total all contributions in the following ranges: ⁠-0 $200 and under -200 $200.01 - $499.99 -500 $500 - $999.99 -1000 $1000 - $1999.99 -2000 $2000 +⁠ Unitemized contributions are included in the 0 category.

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.

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


Get schedules schedule a by size by candidate

Description

This endpoint provides itemized individual contributions received by a committee, aggregated by size of contribution and candidate. If you are interested in our “is_individual” methodology, review the methodology page. Unitemized individual contributions are not included.

Usage

fec_get_schedules_schedule_a_by_size_by_candidate(
  candidate_id,
  sort_nulls_last,
  cycle,
  page,
  sort_hide_null,
  election_full,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

sort_nulls_last

Toggle that sorts null values last

cycle

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.

page

For paginating through results, starting at page 1

sort_hide_null

Hide null values on sorted column(s).

election_full

True indicates that full election period of a candidate. False indicates that two year election cycle.

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.

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


Get schedules schedule a by state

Description

This endpoint provides itemized individual contributions received by a committee, aggregated by the contributor’s state. If you are interested in our “is_individual” methodology, review the methodology page. Unitemized individual contributions are not included.

Usage

fec_get_schedules_schedule_a_by_state(
  hide_null,
  page,
  cycle,
  state,
  sort_hide_null,
  sort_nulls_last,
  committee_id,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

hide_null

Exclude values with missing state

page

For paginating through results, starting at page 1

cycle

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.

state

State of contributor

sort_hide_null

Hide null values on sorted column(s).

sort_nulls_last

Toggle that sorts null values last

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

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.

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


Get schedules schedule a by state by candidate

Description

This endpoint provides itemized individual contributions received by a committee, aggregated by contributor’s state and candidate. If you are interested in our “is_individual” methodology, review the methodology page. Unitemized individual contributions are not included.

Usage

fec_get_schedules_schedule_a_by_state_by_candidate(
  candidate_id,
  sort_nulls_last,
  cycle,
  page,
  sort_hide_null,
  election_full,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

sort_nulls_last

Toggle that sorts null values last

cycle

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.

page

For paginating through results, starting at page 1

sort_hide_null

Hide null values on sorted column(s).

election_full

True indicates that full election period of a candidate. False indicates that two year election cycle.

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.

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


Get schedules schedule a by state by candidate totals

Description

Itemized individual contributions aggregated by contributor’s state, candidate, committee type and cycle. If you are interested in our “is_individual” methodology, review the methodology page. Unitemized individual contributions are not included.

Usage

fec_get_schedules_schedule_a_by_state_by_candidate_totals(
  candidate_id,
  sort_nulls_last,
  cycle,
  page,
  sort_hide_null,
  election_full,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

sort_nulls_last

Toggle that sorts null values last

cycle

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.

page

For paginating through results, starting at page 1

sort_hide_null

Hide null values on sorted column(s).

election_full

True indicates that full election period of a candidate. False indicates that two year election cycle.

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.

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


Get schedules schedule a by state totals

Description

This endpoint provides itemized individual contributions received by a committee, aggregated by contributor’s state, committee type and cycle. If you are interested in our “is_individual” methodology, review the methodology page. Unitemized individual contributions are not included.

Usage

fec_get_schedules_schedule_a_by_state_totals(
  committee_type,
  cycle,
  page,
  state,
  sort_hide_null,
  sort_nulls_last,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

committee_type

The one-letter type code of the organization: - C communication cost - D delegate - E electioneering communication - H House - I independent expenditure filer (not a committee) - N PAC - nonqualified - O independent expenditure-only (super PACs) - P presidential - Q PAC - qualified - S Senate - U single candidate independent expenditure - V PAC with non-contribution account, nonqualified - W PAC with non-contribution account, qualified - X party, nonqualified - Y party, qualified - Z national party non-federal account - all All Committee Types - all_candidates All Candidate Committee Types (H, S, P) - all_pacs All PAC Committee Types (N, O, Q, V, W)

cycle

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.

page

For paginating through results, starting at page 1

state

US state or territory

sort_hide_null

Hide null values on sorted column(s).

sort_nulls_last

Toggle that sorts null values last

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.

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


Get schedules schedule a by zip

Description

This endpoint provides itemized individual contributions received by a committee, aggregated by the contributor’s ZIP code. If you are interested in our “is_individual” methodology, review the methodology page. Unitemized individual contributions are not included.

Usage

fec_get_schedules_schedule_a_by_zip(
  page,
  cycle,
  zip,
  sort_hide_null,
  state,
  committee_id,
  sort_nulls_last,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

page

For paginating through results, starting at page 1

cycle

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.

zip

Zip code of contributor

sort_hide_null

Hide null values on sorted column(s).

state

State of contributor

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

sort_nulls_last

Toggle that sorts null values last

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.

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


Get schedules schedule a efile

Description

Efiling endpoints provide real-time campaign finance data received from electronic filers. Efiling endpoints only contain the most recent four months of data and don't contain the processed and coded data that you can find on other endpoints.

Usage

fec_get_schedules_schedule_a_efile(
  max_amount,
  contributor_occupation,
  max_image_number,
  sort_nulls_last,
  sort_hide_null,
  line_number,
  per_page,
  contributor_city,
  contributor_state,
  page,
  sort,
  committee_id,
  min_date,
  contributor_employer,
  contributor_name,
  min_image_number,
  sort_null_only,
  image_number,
  min_amount,
  max_date,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

max_amount

Filter for all amounts less than a value.

contributor_occupation

Occupation of contributor, filers need to make an effort to gather this information

max_image_number

Maxium image number of the page where the schedule item is reported

sort_nulls_last

Toggle that sorts null values last

sort_hide_null

Hide null values on sorted column(s).

line_number

Filter for form and line number using the following format: FORM-LINENUMBER. For example an argument such as F3X-16 would filter down to all entries from form F3X line number 16.

per_page

The number of results returned per page. Defaults to 20.

contributor_city

City of contributor

contributor_state

State of contributor

page

For paginating through results, starting at page 1

sort

Provide a field to sort by. Use - for descending order.

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

min_date

Minimum date

contributor_employer

Employer of contributor, filers need to make an effort to gather this information

contributor_name

Name of contributor

min_image_number

Minium image number of the page where the schedule item is reported

sort_null_only

Toggle that filters out all rows having sort column that is non-null

image_number

An unique identifier for each page where the electronic or paper filing is reported.

min_amount

Filter for all amounts greater than a value.

max_date

Maximum date

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


Get schedules schedule a sub id

Description

This description is for both ​⁠/schedules​/schedule_a​/⁠ and ​ ⁠/schedules​/schedule_a​/{sub_id}​/⁠. This endpoint provides itemized receipts. Schedule A records describe itemized receipts, including contributions from individuals. If you are interested in contributions from an individual, use the ⁠/schedules/schedule_a/⁠ endpoint. For a more complete description of all Schedule A records visit About receipts data. If you are interested in our "is_individual" methodology visit our methodology page. ​The ⁠/schedules​/schedule_a​/⁠ endpoint is not paginated by page number. This endpoint uses keyset pagination to improve query performance and these indices are required to properly page through this large dataset. To request the next page, you should append the values found in the last_indexes object from pagination to the URL of your last request as additional parameters. For example, when sorting by contribution_receipt_date, you might receive a page of results with the two scenarios of following pagination information: case #1: ⁠pagination: { pages: 2152643, per_page: 20, count: 43052850, last_indexes: { last_index: &quot;230880619&quot;, last_contribution_receipt_date: &quot;2014-01-01&quot; } }⁠ <br/> case #2 (results which include contribution_receipt_date = NULL): ⁠pagination: { pages: 2152644, per_page: 20, count: 43052850, last_indexes: { last_index: &quot;230880639&quot;, sort_null_only: True } }⁠ To fetch the next page of sorted results, append last_index=230880619 and last_contribution_receipt_date=2014-01-01 to the URL and when reaching contribution_receipt_date=NULL, append last_index=230880639 and sort_null_only=True. We strongly advise paging through these results using sort indices. The default sort is acending by contribution_receipt_date (deprecated, will be descending). If you do not page using sort indices, some transactions may be unintentionally filtered out. Calls to ​⁠/schedules​/schedule_a​/⁠ may return many records. For large result sets, the record counts found in the pagination object are approximate; you will need to page through the records until no records are returned. To avoid throwing the "out of range" exception on the last page, one recommandation is to use total count and per_page to control the traverse loop of results. ​The ⁠/schedules​/schedule_a​/{sub_id}​/⁠ endpoint returns a single transaction, but it does include a pagination object class. Please ignore the information in that object class.

Usage

fec_get_schedules_schedule_a_sub_id(
  max_load_date,
  max_amount,
  max_image_number,
  contributor_occupation,
  recipient_committee_designation,
  sort_hide_null,
  is_individual,
  line_number,
  contributor_type,
  recipient_committee_type,
  per_page,
  contributor_zip,
  contributor_city,
  last_index,
  last_contribution_receipt_amount,
  contributor_id,
  recipient_committee_org_type,
  contributor_state,
  sort,
  two_year_transaction_period,
  min_date,
  committee_id,
  contributor_employer,
  min_load_date,
  last_contribution_receipt_date,
  min_image_number,
  contributor_name,
  sort_null_only,
  image_number,
  min_amount,
  max_date,
  sub_id,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

max_load_date

Maximum load date

max_amount

Filter for all amounts less than a value.

max_image_number

Maxium image number of the page where the schedule item is reported

contributor_occupation

Occupation of contributor, filers need to make an effort to gather this information

recipient_committee_designation

The one-letter designation code of the organization: - A authorized by a candidate - J joint fundraising committee - P principal campaign committee of a candidate - U unauthorized - B lobbyist/registrant PAC - D leadership PAC

sort_hide_null

Hide null values on sorted column(s).

is_individual

Restrict to non-earmarked individual contributions where memo code is true. Filtering individuals is useful to make sure contributions are not double reported and in creating breakdowns of the amount of money coming from individuals.

line_number

Filter for form and line number using the following format: FORM-LINENUMBER. For example an argument such as F3X-16 would filter down to all entries from form F3X line number 16.

contributor_type

Filters individual or committee contributions based on line number

recipient_committee_type

The one-letter type code of the organization: - C communication cost - D delegate - E electioneering communication - H House - I independent expenditure filer (not a committee) - N PAC - nonqualified - O independent expenditure-only (super PACs) - P presidential - Q PAC - qualified - S Senate - U single candidate independent expenditure - V PAC with non-contribution account, nonqualified - W PAC with non-contribution account, qualified - X party, nonqualified - Y party, qualified - Z national party non-federal account

per_page

The number of results returned per page. Defaults to 20.

contributor_zip

Zip code of contributor

contributor_city

City of contributor

last_index

Index of last result from previous page

last_contribution_receipt_amount

When sorting by contribution_receipt_amount, this is populated with the contribution_receipt_amount of the last result. However, you will need to pass the index of that last result to last_index to get the next page.

contributor_id

The FEC identifier should be represented here if the contributor is registered with the FEC.

recipient_committee_org_type

The one-letter code for the kind for organization: - C corporation - L labor organization - M membership organization - T trade association - V cooperative - W corporation without capital stock

contributor_state

State of contributor

sort

Provide a field to sort by. Use - for descending order.

two_year_transaction_period

This is a two-year period that is derived from the year a transaction took place in the Itemized Schedule A and Schedule B tables. In cases where we have the date of the transaction (contribution_receipt_date in schedules/schedule_a, disbursement_date in schedules/schedule_b) the two_year_transaction_period is named after the ending, even-numbered year. If we do not have the date of the transaction, we fall back to using the report year (report_year in both tables) instead, making the same cycle adjustment as necessary. If no transaction year is specified, the results default to the most current cycle.

min_date

Minimum date

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

contributor_employer

Employer of contributor, filers need to make an effort to gather this information

min_load_date

Minimum load date

last_contribution_receipt_date

When sorting by contribution_receipt_date, this is populated with the contribution_receipt_date of the last result. However, you will need to pass the index of that last result to last_index to get the next page.

min_image_number

Minium image number of the page where the schedule item is reported

contributor_name

Name of contributor

sort_null_only

Toggle that filters out all rows having sort column that is non-null

image_number

An unique identifier for each page where the electronic or paper filing is reported.

min_amount

Filter for all amounts greater than a value.

max_date

Maximum date

sub_id

BKTODO: No description provided.

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


Get schedules schedule b

Description

Schedule B filings describe itemized disbursements. This data explains how committees and other filers spend their money. These figures are reported as part of forms F3, F3X and F3P. The data is divided in two-year periods, called two_year_transaction_period, which is derived from the report_year submitted of the corresponding form. If no value is supplied, the results will default to the most recent two-year period that is named after the ending, even-numbered year. Due to the large quantity of Schedule B filings, this endpoint is not paginated by page number. Instead, you can request the next page of results by adding the values in the last_indexes object from pagination to the URL of your last request. For example, when sorting by disbursement_date, you might receive a page of results with the following pagination information: ⁠pagination: { pages: 965191, per_page: 20, count: 19303814, last_indexes: { last_index: &quot;230906248&quot;, last_disbursement_date: &quot;2014-07-04&quot; } }⁠ To fetch the next page of sorted results, append last_index=230906248 and last_disbursement_date=2014-07-04 to the URL. We strongly advise paging through these results by using the sort indices (defaults to sort by disbursement date, e.g. last_disbursement_date), otherwise some resources may be unintentionally filtered out. This resource uses keyset pagination to improve query performance and these indices are required to properly page through this large dataset. Note: because the Schedule B data includes many records, counts for large result sets are approximate; you will want to page through the records until no records are returned.

Usage

fec_get_schedules_schedule_b(
  disbursement_description,
  max_amount,
  max_image_number,
  image_number,
  sort_hide_null,
  last_disbursement_date,
  line_number,
  spender_committee_designation,
  last_disbursement_amount,
  per_page,
  last_index,
  spender_committee_type,
  sort,
  two_year_transaction_period,
  min_date,
  committee_id,
  disbursement_purpose_category,
  recipient_name,
  recipient_state,
  recipient_city,
  min_image_number,
  spender_committee_org_type,
  sort_null_only,
  recipient_committee_id,
  min_amount,
  max_date,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

disbursement_description

Description of disbursement

max_amount

Filter for all amounts less than a value.

max_image_number

Maxium image number of the page where the schedule item is reported

image_number

An unique identifier for each page where the electronic or paper filing is reported.

sort_hide_null

Hide null values on sorted column(s).

last_disbursement_date

When sorting by disbursement_date, this is populated with the disbursement_date of the last result. However, you will need to pass the index of that last result to last_index to get the next page.

line_number

Filter for form and line number using the following format: FORM-LINENUMBER. For example an argument such as F3X-16 would filter down to all entries from form F3X line number 16.

spender_committee_designation

The one-letter designation code of the organization: - A authorized by a candidate - J joint fundraising committee - P principal campaign committee of a candidate - U unauthorized - B lobbyist/registrant PAC - D leadership PAC

last_disbursement_amount

When sorting by disbursement_amount, this is populated with the disbursement_amount of the last result. However, you will need to pass the index of that last result to last_index to get the next page.

per_page

The number of results returned per page. Defaults to 20.

last_index

Index of last result from previous page

spender_committee_type

The one-letter type code of the organization: - C communication cost - D delegate - E electioneering communication - H House - I independent expenditure filer (not a committee) - N PAC - nonqualified - O independent expenditure-only (super PACs) - P presidential - Q PAC - qualified - S Senate - U single candidate independent expenditure - V PAC with non-contribution account, nonqualified - W PAC with non-contribution account, qualified - X party, nonqualified - Y party, qualified - Z national party non-federal account

sort

Provide a field to sort by. Use - for descending order.

two_year_transaction_period

This is a two-year period that is derived from the year a transaction took place in the Itemized Schedule A and Schedule B tables. In cases where we have the date of the transaction (contribution_receipt_date in schedules/schedule_a, disbursement_date in schedules/schedule_b) the two_year_transaction_period is named after the ending, even-numbered year. If we do not have the date of the transaction, we fall back to using the report year (report_year in both tables) instead, making the same cycle adjustment as necessary. If no transaction year is specified, the results default to the most current cycle.

min_date

Minimum date

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

disbursement_purpose_category

Disbursement purpose category

recipient_name

Name of the entity receiving the disbursement

recipient_state

State of recipient

recipient_city

City of recipient

min_image_number

Minium image number of the page where the schedule item is reported

spender_committee_org_type

The one-letter code for the kind for organization: - C corporation - L labor organization - M membership organization - T trade association - V cooperative - W corporation without capital stock

sort_null_only

Toggle that filters out all rows having sort column that is non-null

recipient_committee_id

The FEC identifier should be represented here if the contributor is registered with the FEC.

min_amount

Filter for all amounts greater than a value.

max_date

Maximum date

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


Get schedules schedule b by purpose

Description

Schedule B disbursements aggregated by disbursement purpose category. To avoid double counting, memoed items are not included. Purpose is a combination of transaction codes, category codes and disbursement description. Inspect the disbursement_purpose sql function within the migrations for more details.

Usage

fec_get_schedules_schedule_b_by_purpose(
  purpose,
  sort_nulls_last,
  page,
  cycle,
  sort_hide_null,
  committee_id,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

purpose

Disbursement purpose category

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

cycle

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.

sort_hide_null

Hide null values on sorted column(s).

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

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.

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


Get schedules schedule b by recipient

Description

Schedule B disbursements aggregated by recipient name. To avoid double counting, memoed items are not included.

Usage

fec_get_schedules_schedule_b_by_recipient(
  sort_nulls_last,
  page,
  cycle,
  sort_hide_null,
  committee_id,
  recipient_name,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

cycle

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.

sort_hide_null

Hide null values on sorted column(s).

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

recipient_name

Name of the entity receiving the disbursement

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.

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


Get schedules schedule b by recipient id

Description

Schedule B disbursements aggregated by recipient committee ID, if applicable. To avoid double counting, memoed items are not included.

Usage

fec_get_schedules_schedule_b_by_recipient_id(
  sort_nulls_last,
  page,
  cycle,
  sort_hide_null,
  committee_id,
  sort_null_only,
  per_page,
  recipient_id,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

cycle

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.

sort_hide_null

Hide null values on sorted column(s).

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

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.

recipient_id

The FEC identifier should be represented here if the entity receiving the disbursement is registered with the FEC.

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


Get schedules schedule b efile

Description

Efiling endpoints provide real-time campaign finance data received from electronic filers. Efiling endpoints only contain the most recent four months of data and don't contain the processed and coded data that you can find on other endpoints.

Usage

fec_get_schedules_schedule_b_efile(
  disbursement_description,
  max_amount,
  page,
  sort_nulls_last,
  sort,
  sort_hide_null,
  committee_id,
  min_date,
  recipient_state,
  recipient_city,
  sort_null_only,
  per_page,
  image_number,
  min_amount,
  max_date,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

disbursement_description

Description of disbursement

max_amount

Filter for all amounts less than a value.

page

For paginating through results, starting at page 1

sort_nulls_last

Toggle that sorts null values last

sort

Provide a field to sort by. Use - for descending order.

sort_hide_null

Hide null values on sorted column(s).

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

min_date

When sorting by disbursement_date, this is populated with the disbursement_date of the last result. However, you will need to pass the index of that last result to last_index to get the next page.

recipient_state

State of recipient

recipient_city

City of recipient

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.

image_number

An unique identifier for each page where the electronic or paper filing is reported.

min_amount

Filter for all amounts less than a value.

max_date

When sorting by disbursement_date, this is populated with the disbursement_date of the last result. However, you will need to pass the index of that last result to last_index to get the next page.

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


Get schedules schedule b sub id

Description

Schedule B filings describe itemized disbursements. This data explains how committees and other filers spend their money. These figures are reported as part of forms F3, F3X and F3P. The data is divided in two-year periods, called two_year_transaction_period, which is derived from the report_year submitted of the corresponding form. If no value is supplied, the results will default to the most recent two-year period that is named after the ending, even-numbered year. Due to the large quantity of Schedule B filings, this endpoint is not paginated by page number. Instead, you can request the next page of results by adding the values in the last_indexes object from pagination to the URL of your last request. For example, when sorting by disbursement_date, you might receive a page of results with the following pagination information: ⁠pagination: { pages: 965191, per_page: 20, count: 19303814, last_indexes: { last_index: &quot;230906248&quot;, last_disbursement_date: &quot;2014-07-04&quot; } }⁠ To fetch the next page of sorted results, append last_index=230906248 and last_disbursement_date=2014-07-04 to the URL. We strongly advise paging through these results by using the sort indices (defaults to sort by disbursement date, e.g. last_disbursement_date), otherwise some resources may be unintentionally filtered out. This resource uses keyset pagination to improve query performance and these indices are required to properly page through this large dataset. Note: because the Schedule B data includes many records, counts for large result sets are approximate; you will want to page through the records until no records are returned.

Usage

fec_get_schedules_schedule_b_sub_id(
  disbursement_description,
  max_amount,
  max_image_number,
  image_number,
  sort_hide_null,
  last_disbursement_date,
  line_number,
  spender_committee_designation,
  last_disbursement_amount,
  per_page,
  last_index,
  spender_committee_type,
  sort,
  two_year_transaction_period,
  min_date,
  committee_id,
  disbursement_purpose_category,
  recipient_name,
  recipient_state,
  recipient_city,
  min_image_number,
  spender_committee_org_type,
  sort_null_only,
  recipient_committee_id,
  min_amount,
  max_date,
  sub_id,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

disbursement_description

Description of disbursement

max_amount

Filter for all amounts less than a value.

max_image_number

Maxium image number of the page where the schedule item is reported

image_number

An unique identifier for each page where the electronic or paper filing is reported.

sort_hide_null

Hide null values on sorted column(s).

last_disbursement_date

When sorting by disbursement_date, this is populated with the disbursement_date of the last result. However, you will need to pass the index of that last result to last_index to get the next page.

line_number

Filter for form and line number using the following format: FORM-LINENUMBER. For example an argument such as F3X-16 would filter down to all entries from form F3X line number 16.

spender_committee_designation

The one-letter designation code of the organization: - A authorized by a candidate - J joint fundraising committee - P principal campaign committee of a candidate - U unauthorized - B lobbyist/registrant PAC - D leadership PAC

last_disbursement_amount

When sorting by disbursement_amount, this is populated with the disbursement_amount of the last result. However, you will need to pass the index of that last result to last_index to get the next page.

per_page

The number of results returned per page. Defaults to 20.

last_index

Index of last result from previous page

spender_committee_type

The one-letter type code of the organization: - C communication cost - D delegate - E electioneering communication - H House - I independent expenditure filer (not a committee) - N PAC - nonqualified - O independent expenditure-only (super PACs) - P presidential - Q PAC - qualified - S Senate - U single candidate independent expenditure - V PAC with non-contribution account, nonqualified - W PAC with non-contribution account, qualified - X party, nonqualified - Y party, qualified - Z national party non-federal account

sort

Provide a field to sort by. Use - for descending order.

two_year_transaction_period

This is a two-year period that is derived from the year a transaction took place in the Itemized Schedule A and Schedule B tables. In cases where we have the date of the transaction (contribution_receipt_date in schedules/schedule_a, disbursement_date in schedules/schedule_b) the two_year_transaction_period is named after the ending, even-numbered year. If we do not have the date of the transaction, we fall back to using the report year (report_year in both tables) instead, making the same cycle adjustment as necessary. If no transaction year is specified, the results default to the most current cycle.

min_date

Minimum date

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

disbursement_purpose_category

Disbursement purpose category

recipient_name

Name of the entity receiving the disbursement

recipient_state

State of recipient

recipient_city

City of recipient

min_image_number

Minium image number of the page where the schedule item is reported

spender_committee_org_type

The one-letter code for the kind for organization: - C corporation - L labor organization - M membership organization - T trade association - V cooperative - W corporation without capital stock

sort_null_only

Toggle that filters out all rows having sort column that is non-null

recipient_committee_id

The FEC identifier should be represented here if the contributor is registered with the FEC.

min_amount

Filter for all amounts greater than a value.

max_date

Maximum date

sub_id

BKTODO: No description provided.

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


Get schedules schedule c

Description

Schedule C shows all loans, endorsements and loan guarantees a committee receives or makes. The committee continues to report the loan until it is repaid.

Usage

fec_get_schedules_schedule_c(
  min_incurred_date,
  candidate_name,
  max_amount,
  max_image_number,
  sort_nulls_last,
  sort_hide_null,
  line_number,
  max_incurred_date,
  per_page,
  last_index,
  loan_source_name,
  page,
  sort,
  max_payment_to_date,
  min_payment_to_date,
  committee_id,
  min_image_number,
  sort_null_only,
  image_number,
  min_amount,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

min_incurred_date

Minimum incurred date

candidate_name

Name of candidate running for office

max_amount

Filter for all amounts less than a value.

max_image_number

Maxium image number of the page where the schedule item is reported

sort_nulls_last

Toggle that sorts null values last

sort_hide_null

Hide null values on sorted column(s).

line_number

Filter for form and line number using the following format: FORM-LINENUMBER. For example an argument such as F3X-16 would filter down to all entries from form F3X line number 16.

max_incurred_date

Maximum incurred date

per_page

The number of results returned per page. Defaults to 20.

last_index

Index of last result from previous page

loan_source_name

Source of the loan (i.e., bank loan, brokerage account, credit card, home equity line of credit, other line of credit, or personal funds of the candidate

page

For paginating through results, starting at page 1

sort

Provide a field to sort by. Use - for descending order.

max_payment_to_date

Maximum payment to date

min_payment_to_date

Minimum payment to date

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

min_image_number

Minium image number of the page where the schedule item is reported

sort_null_only

Toggle that filters out all rows having sort column that is non-null

image_number

An unique identifier for each page where the electronic or paper filing is reported.

min_amount

Filter for all amounts greater than a value.

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


Get schedules schedule c sub id

Description

Schedule C shows all loans, endorsements and loan guarantees a committee receives or makes. The committee continues to report the loan until it is repaid.

Usage

fec_get_schedules_schedule_c_sub_id(
  sort_nulls_last,
  per_page,
  sort_null_only,
  sort_hide_null,
  sort,
  page,
  sub_id,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

sort_nulls_last

Toggle that sorts null values last

per_page

The number of results returned per page. Defaults to 20.

sort_null_only

Toggle that filters out all rows having sort column that is non-null

sort_hide_null

Hide null values on sorted column(s).

sort

Provide a field to sort by. Use - for descending order.

page

For paginating through results, starting at page 1

sub_id

BKTODO: No description provided.

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


Get schedules schedule d

Description

Schedule D, it shows debts and obligations owed to or by the committee that are required to be disclosed.

Usage

fec_get_schedules_schedule_d(
  creditor_debtor_name,
  max_image_number,
  sort_nulls_last,
  max_amount_outstanding_beginning,
  sort_hide_null,
  min_payment_period,
  max_amount_incurred,
  nature_of_debt,
  per_page,
  max_amount_outstanding_close,
  candidate_id,
  page,
  min_date,
  committee_id,
  min_amount_outstanding_close,
  max_payment_period,
  min_image_number,
  min_amount_incurred,
  sort_null_only,
  image_number,
  sort,
  min_amount_outstanding_beginning,
  max_date,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

creditor_debtor_name

BKTODO: No description provided.

max_image_number

Maxium image number of the page where the schedule item is reported

sort_nulls_last

Toggle that sorts null values last

max_amount_outstanding_beginning

BKTODO: No description provided.

sort_hide_null

Hide null values on sorted column(s).

min_payment_period

BKTODO: No description provided.

max_amount_incurred

BKTODO: No description provided.

nature_of_debt

BKTODO: No description provided.

per_page

The number of results returned per page. Defaults to 20.

max_amount_outstanding_close

BKTODO: No description provided.

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

page

For paginating through results, starting at page 1

min_date

Minimum load date

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

min_amount_outstanding_close

BKTODO: No description provided.

max_payment_period

BKTODO: No description provided.

min_image_number

Minium image number of the page where the schedule item is reported

min_amount_incurred

BKTODO: No description provided.

sort_null_only

Toggle that filters out all rows having sort column that is non-null

image_number

An unique identifier for each page where the electronic or paper filing is reported.

sort

Provide a field to sort by. Use - for descending order.

min_amount_outstanding_beginning

BKTODO: No description provided.

max_date

Maximum load date

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


Get schedules schedule d sub id

Description

Schedule D, it shows debts and obligations owed to or by the committee that are required to be disclosed.

Usage

fec_get_schedules_schedule_d_sub_id(
  sort_nulls_last,
  per_page,
  sort_null_only,
  sort_hide_null,
  sort,
  page,
  sub_id,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

sort_nulls_last

Toggle that sorts null values last

per_page

The number of results returned per page. Defaults to 20.

sort_null_only

Toggle that filters out all rows having sort column that is non-null

sort_hide_null

Hide null values on sorted column(s).

sort

Provide a field to sort by. Use - for descending order.

page

For paginating through results, starting at page 1

sub_id

BKTODO: No description provided.

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


Get schedules schedule e

Description

Schedule E covers the line item expenditures for independent expenditures. For example, if a super PAC bought ads on TV to oppose a federal candidate, each ad purchase would be recorded here with the expenditure amount, name and id of the candidate, and whether the ad supported or opposed the candidate. An independent expenditure is an expenditure for a communication "expressly advocating the election or defeat of a clearly identified candidate that is not made in cooperation, consultation, or concert with, or at the request or suggestion of, a candidate, a candidate’s authorized committee, or their agents, or a political party or its agents." Aggregates by candidate do not include 24 and 48 hour reports. This ensures we don't double count expenditures and the totals are more accurate. You can still find the information from 24 and 48 hour reports in ⁠/schedule/schedule_e/⁠. Due to the large quantity of Schedule E filings, this endpoint is not paginated by page number. Instead, you can request the next page of results by adding the values in the last_indexes object from pagination to the URL of your last request. For example, when sorting by expenditure_amount, you might receive a page of results with the following pagination information: ⁠&quot;pagination&quot;: { &quot;count&quot;: 152623, &quot;last_indexes&quot;: { &quot;last_index&quot;: &quot;3023037&quot;, &quot;last_expenditure_amount&quot;: -17348.5 }, &quot;per_page&quot;: 20, &quot;pages&quot;: 7632 } }⁠ To fetch the next page of sorted results, append last_index=3023037 and ⁠last_expenditure_amount=⁠ to the URL. We strongly advise paging through these results by using the sort indices (defaults to sort by disbursement date, e.g. last_disbursement_date), otherwise some resources may be unintentionally filtered out. This resource uses keyset pagination to improve query performance and these indices are required to properly page through this large dataset. Note: because the Schedule E data includes many records, counts for large result sets are approximate; you will want to page through the records until no records are returned.

Usage

fec_get_schedules_schedule_e(
  max_dissemination_date,
  sort_hide_null,
  payee_name,
  q_spender,
  per_page,
  last_index,
  min_dissemination_date,
  candidate_office_state,
  filing_form,
  sort_null_only,
  max_amount,
  max_image_number,
  min_filing_date,
  cycle,
  sort_nulls_last,
  support_oppose_indicator,
  candidate_office,
  is_notice,
  line_number,
  last_expenditure_amount,
  last_expenditure_date,
  candidate_id,
  last_office_total_ytd,
  last_support_oppose_indicator,
  min_date,
  candidate_party,
  committee_id,
  min_image_number,
  max_filing_date,
  candidate_office_district,
  min_amount,
  image_number,
  sort,
  max_date,
  most_recent,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

max_dissemination_date

Selects all items distributed by this committee before this date

sort_hide_null

Hide null values on sorted column(s).

payee_name

Name of the entity that received the payment.

q_spender

Keyword search for spender name or ID

per_page

The number of results returned per page. Defaults to 20.

last_index

Index of last result from previous page

min_dissemination_date

Selects all items distributed by this committee after this date

candidate_office_state

US state or territory

filing_form

The form where the underlying data comes from, for example, Form 1 would appear as F1: - F1 Statement of Organization - F1M Notification of Multicandidate Status - F2 Statement of Candidacy - F3 Report of Receipts and Disbursements for an Authorized Committee - F3P Report of Receipts and Disbursements by an Authorized Committee of a Candidate for The Office of President or Vice President - F3L Report of Contributions Bundled by Lobbyists/Registrants and Lobbyist/Registrant PACs - F3X Report of Receipts and Disbursements for other than an Authorized Committee - F4 Report of Receipts and Disbursements for a Committee or Organization Supporting a Nomination Convention - F5 Report of Independent Expenditures Made and Contributions Received - F6 48 Hour Notice of Contributions/Loans Received - F7 Report of Communication Costs by Corporations and Membership Organizations - F8 Debt Settlement Plan - F9 24 Hour Notice of Disbursements for Electioneering Communications - F13 Report of Donations Accepted for Inaugural Committee - F99 Miscellaneous Text - FRQ Request for Additional Information

sort_null_only

Toggle that filters out all rows having sort column that is non-null

max_amount

Filter for all amounts less than a value.

max_image_number

Maxium image number of the page where the schedule item is reported

min_filing_date

Selects all filings received after this date

cycle

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.

sort_nulls_last

Toggle that sorts null values last

support_oppose_indicator

Explains if the money was spent in order to support or oppose a candidate or candidates. (Coded S or O for support or oppose.) This indicator applies to independent expenditures and communication costs.

candidate_office

Federal office candidate runs for: H, S or P

is_notice

Record filed as 24- or 48-hour notice.

line_number

Filter for form and line number using the following format: FORM-LINENUMBER. For example an argument such as F3X-16 would filter down to all entries from form F3X line number 16.

last_expenditure_amount

When sorting by expenditure_amount, this is populated with the expenditure_amount of the last result. However, you will need to pass the index of that last result to last_index to get the next page.

last_expenditure_date

When sorting by expenditure_date, this is populated with the expenditure_date of the last result. However, you will need to pass the index of that last result to last_index to get the next page.

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

last_office_total_ytd

When sorting by office_total_ytd, this is populated with the office_total_ytd of the last result. However, you will need to pass the index of that last result to last_index to get the next page.'

last_support_oppose_indicator

When sorting by support_oppose_indicator, this is populated with the support_oppose_indicator of the last result. However, you will need to pass the index of that last result to last_index to get the next page.'

min_date

Minimum date

candidate_party

Three-letter code for the party affiliated with a candidate or committee. For example, DEM for Democratic Party and REP for Republican Party.

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

min_image_number

Minium image number of the page where the schedule item is reported

max_filing_date

Selects all filings received before this date

candidate_office_district

Two-digit US House distirict of the office the candidate is running for. Presidential, Senate and House at-large candidates will have District 00.

min_amount

Filter for all amounts greater than a value.

image_number

An unique identifier for each page where the electronic or paper filing is reported.

sort

Provide a field to sort by. Use - for descending order.

max_date

Maximum date

most_recent

The report associated with the transaction is either new or is the most-recently filed amendment. Undetermined version (null) is always included.

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


Get schedules schedule e by candidate

Description

Schedule E receipts aggregated by recipient candidate. To avoid double counting, memoed items are not included.

Usage

fec_get_schedules_schedule_e_by_candidate(
  office,
  candidate_id,
  cycle,
  district,
  state,
  page,
  support_oppose,
  election_full,
  committee_id,
  sort_hide_null,
  sort_nulls_last,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

office

Federal office candidate runs for: H, S or P

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

cycle

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.

district

Two-digit US House distirict of the office the candidate is running for. Presidential, Senate and House at-large candidates will have District 00.

state

US state or territory where a candidate runs for office

page

For paginating through results, starting at page 1

support_oppose

Support or opposition

election_full

True indicates that full election period of a candidate. False indicates that two year election cycle.

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

sort_hide_null

Hide null values on sorted column(s).

sort_nulls_last

Toggle that sorts null values last

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.

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


Get schedules schedule e efile

Description

Efiling endpoints provide real-time campaign finance data received from electronic filers. Efiling endpoints only contain the most recent four months of data and don't contain the processed and coded data that you can find on other endpoints.

Usage

fec_get_schedules_schedule_e_efile(
  spender_name,
  min_expenditure_date,
  sort_nulls_last,
  max_dissemination_date,
  support_oppose_indicator,
  sort_hide_null,
  candidate_office,
  is_notice,
  payee_name,
  per_page,
  candidate_search,
  max_expenditure_amount,
  min_dissemination_date,
  min_filed_date,
  candidate_id,
  candidate_office_state,
  max_filed_date,
  page,
  min_expenditure_amount,
  committee_id,
  candidate_party,
  max_expenditure_date,
  filing_form,
  sort_null_only,
  candidate_office_district,
  image_number,
  sort,
  most_recent,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

spender_name

The name of the committee. If a committee changes its name, the most recent name will be shown. Committee names are not unique. Use committee_id for looking up records.

min_expenditure_date

Selects all items expended by this committee after this date

sort_nulls_last

Toggle that sorts null values last

max_dissemination_date

Selects all items distributed by this committee before this date

support_oppose_indicator

Explains if the money was spent in order to support or oppose a candidate or candidates. (Coded S or O for support or oppose.) This indicator applies to independent expenditures and communication costs.

sort_hide_null

Hide null values on sorted column(s).

candidate_office

Federal office candidate runs for: H, S or P

is_notice

Record filed as 24- or 48-hour notice.

payee_name

Name of the entity that received the payment.

per_page

The number of results returned per page. Defaults to 20.

candidate_search

Search for candidates by candiate id or candidate first or last name

max_expenditure_amount

Selects all items expended by this committee less than this amount

min_dissemination_date

Selects all items distributed by this committee after this date

min_filed_date

Timestamp of electronic or paper record that FEC received

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

candidate_office_state

US state or territory where a candidate runs for office

max_filed_date

Timestamp of electronic or paper record that FEC received

page

For paginating through results, starting at page 1

min_expenditure_amount

Selects all items expended by this committee greater than this amount

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

candidate_party

Three-letter code for the party affiliated with a candidate or committee. For example, DEM for Democratic Party and REP for Republican Party.

max_expenditure_date

Selects all items expended by this committee before this date

filing_form

The form where the underlying data comes from, for example, Form 1 would appear as F1: - F1 Statement of Organization - F1M Notification of Multicandidate Status - F2 Statement of Candidacy - F3 Report of Receipts and Disbursements for an Authorized Committee - F3P Report of Receipts and Disbursements by an Authorized Committee of a Candidate for The Office of President or Vice President - F3L Report of Contributions Bundled by Lobbyists/Registrants and Lobbyist/Registrant PACs - F3X Report of Receipts and Disbursements for other than an Authorized Committee - F4 Report of Receipts and Disbursements for a Committee or Organization Supporting a Nomination Convention - F5 Report of Independent Expenditures Made and Contributions Received - F6 48 Hour Notice of Contributions/Loans Received - F7 Report of Communication Costs by Corporations and Membership Organizations - F8 Debt Settlement Plan - F9 24 Hour Notice of Disbursements for Electioneering Communications - F13 Report of Donations Accepted for Inaugural Committee - F99 Miscellaneous Text - FRQ Request for Additional Information

sort_null_only

Toggle that filters out all rows having sort column that is non-null

candidate_office_district

Two-digit US House distirict of the office the candidate is running for. Presidential, Senate and House at-large candidates will have District 00.

image_number

An unique identifier for each page where the electronic or paper filing is reported.

sort

Provide a field to sort by. Use - for descending order.

most_recent

The report associated with the transaction is either new or is the most-recently filed amendment. Undetermined version (null) is always included.

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


Get schedules schedule e totals by candidate

Description

Total independent expenditure on supported or opposed candidates by cycle or candidate election year.

Usage

fec_get_schedules_schedule_e_totals_by_candidate(
  candidate_id,
  sort_nulls_last,
  page,
  cycle,
  sort_hide_null,
  election_full,
  sort_null_only,
  per_page,
  sort,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

sort_nulls_last

Toggle that sorts null values last

page

For paginating through results, starting at page 1

cycle

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.

sort_hide_null

Hide null values on sorted column(s).

election_full

True indicates that full election period of a candidate. False indicates that two year election cycle.

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.

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


Get schedules schedule f

Description

Schedule F, it shows all special expenditures a national or state party committee makes in connection with the general election campaigns of federal candidates. These coordinated party expenditures do not count against the contribution limits but are subject to other limits, these limits are detailed in Chapter 7 of the FEC Campaign Guide for Political Party Committees.

Usage

fec_get_schedules_schedule_f(
  max_amount,
  max_image_number,
  cycle,
  sort_nulls_last,
  sort_hide_null,
  line_number,
  payee_name,
  per_page,
  candidate_id,
  page,
  min_date,
  committee_id,
  min_amount,
  min_image_number,
  sort_null_only,
  image_number,
  sort,
  max_date,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

max_amount

Filter for all amounts less than a value.

max_image_number

Maxium image number of the page where the schedule item is reported

cycle

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.

sort_nulls_last

Toggle that sorts null values last

sort_hide_null

Hide null values on sorted column(s).

line_number

Filter for form and line number using the following format: FORM-LINENUMBER. For example an argument such as F3X-16 would filter down to all entries from form F3X line number 16.

payee_name

BKTODO: No description provided.

per_page

The number of results returned per page. Defaults to 20.

candidate_id

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.

page

For paginating through results, starting at page 1

min_date

Minimum date

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

min_amount

Filter for all amounts greater than a value.

min_image_number

Minium image number of the page where the schedule item is reported

sort_null_only

Toggle that filters out all rows having sort column that is non-null

image_number

An unique identifier for each page where the electronic or paper filing is reported.

sort

Provide a field to sort by. Use - for descending order.

max_date

Maximum date

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


Get schedules schedule f sub id

Description

Schedule F, it shows all special expenditures a national or state party committee makes in connection with the general election campaigns of federal candidates. These coordinated party expenditures do not count against the contribution limits but are subject to other limits, these limits are detailed in Chapter 7 of the FEC Campaign Guide for Political Party Committees.

Usage

fec_get_schedules_schedule_f_sub_id(
  per_page,
  page,
  sub_id,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

per_page

The number of results returned per page. Defaults to 20.

page

For paginating through results, starting at page 1

sub_id

BKTODO: No description provided.

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


Get state election office

Description

State laws and procedures govern elections for state or local offices as well as how candidates appear on election ballots. Contact the appropriate state election office for more information.

Usage

fec_get_state_election_office(
  sort_null_only,
  sort_nulls_last,
  per_page,
  state,
  sort_hide_null,
  sort,
  page,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

sort_null_only

Toggle that filters out all rows having sort column that is non-null

sort_nulls_last

Toggle that sorts null values last

per_page

The number of results returned per page. Defaults to 20.

state

Enter a state (Ex: AK, TX, VA etc..) to find the local election offices contact information.

sort_hide_null

Hide null values on sorted column(s).

sort

Provide a field to sort by. Use - for descending order.

page

For paginating through results, starting at page 1

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


Get totals by entity

Description

Provides cumulative receipt totals by entity type, over a two year cycle. Totals are adjusted to avoid double counting. This is the sql that creates these calculations.

Usage

fec_get_totals_by_entity(
  cycle,
  sort_nulls_last,
  per_page,
  sort_null_only,
  sort_hide_null,
  sort,
  page,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

cycle

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.

sort_nulls_last

Toggle that sorts null values last

per_page

The number of results returned per page. Defaults to 20.

sort_null_only

Toggle that filters out all rows having sort column that is non-null

sort_hide_null

Hide null values on sorted column(s).

sort

Provide a field to sort by. Use - for descending order.

page

For paginating through results, starting at page 1

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


Get totals entity type

Description

This endpoint provides information about a committee's Form 3, Form 3X, or Form 3P financial reports, which are aggregated by two-year period. We refer to two-year periods as a cycle. The cycle is named after the even-numbered year and includes the year before it. To obtain totals from 2013 and 2014, you would use 2014. In odd-numbered years, the current cycle is the next year — for example, in 2015, the current cycle is 2016. For presidential and Senate candidates, multiple two-year cycles exist between elections.

Usage

fec_get_totals_entity_type(
  max_first_f1_date,
  min_receipts,
  cycle,
  filing_frequency,
  max_receipts,
  sort_hide_null,
  sort_nulls_last,
  min_last_debts_owed_by_committee,
  max_last_cash_on_hand_end_period,
  treasurer_name,
  sponsor_candidate_id,
  per_page,
  max_disbursements,
  committee_state,
  committee_type,
  page,
  max_last_debts_owed_by_committee,
  committee_id,
  committee_designation,
  sort_null_only,
  min_first_f1_date,
  organization_type,
  sort,
  min_disbursements,
  min_last_cash_on_hand_end_period,
  entity_type,
  api_key = Sys.getenv("FEC_API_KEY", unset = "DEMO_KEY")
)

Arguments

max_first_f1_date

Filter for committees whose first Form 1 was received on or before this date.

min_receipts

Filter for all amounts greater than a value.

cycle

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.

filing_frequency

The one-letter code of the filing frequency: - A Administratively terminated - D Debt - M Monthly filer - Q Quarterly filer - T Terminated - W Waived

max_receipts

Filter for all amounts less than a value.

sort_hide_null

Hide null values on sorted column(s).

sort_nulls_last

Toggle that sorts null values last

min_last_debts_owed_by_committee

Filter for all amounts greater than a value.

max_last_cash_on_hand_end_period

Filter for all amounts less than a value.

treasurer_name

Name of the Committee's treasurer. If multiple treasurers for the committee, the most recent treasurer will be shown.

A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office. This is a filter for Leadership PAC sponsor.

per_page

The number of results returned per page. Defaults to 20.

max_disbursements

Filter for all amounts less than a value.

committee_state

US state or territory

committee_type

The one-letter type code of the organization: - C communication cost - D delegate - E electioneering communication - H House - I independent expenditure filer (not a committee) - N PAC - nonqualified - O independent expenditure-only (super PACs) - P presidential - Q PAC - qualified - S Senate - U single candidate independent expenditure - V PAC with non-contribution account, nonqualified - W PAC with non-contribution account, qualified - X party, nonqualified - Y party, qualified - Z national party non-federal account

page

For paginating through results, starting at page 1

max_last_debts_owed_by_committee

Filter for all amounts less than a value.

committee_id

A unique identifier assigned to each committee or filer registered with the FEC. In general committee id's begin with the letter C which is followed by eight digits.

committee_designation

The one-letter designation code of the organization: - A authorized by a candidate - J joint fundraising committee - P principal campaign committee of a candidate - U unauthorized - B lobbyist/registrant PAC - D leadership PAC

sort_null_only

Toggle that filters out all rows having sort column that is non-null

min_first_f1_date

Filter for committees whose first Form 1 was received on or after this date.

organization_type

The one-letter code for the kind for organization: - C corporation - L labor organization - M membership organization - T trade association - V cooperative - W corporation without capital stock

sort

Provide a field to sort by. Use - for descending order.

min_disbursements

Filter for all amounts greater than a value.

min_last_cash_on_hand_end_period

Filter for all amounts greater than a value.

entity_type

Committee groupings based on FEC filing form. Choose one of: presidential, pac, party, pac-party, house-senate, or ie-only

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