candidate

GET /v1/candidates/totals/aggregates/

Candidate total receipts and disbursements aggregated by aggregate_by.

Request

Query parameters

pageinteger

For paginating through results, starting at page 1

per_pageinteger

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

election_yearinteger[]

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.

office'' | 'H' | 'S' | 'P'

Federal office candidate runs for: H, S or P

is_active_candidateboolean

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.

election_fullboolean

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

min_election_cycleinteger

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.

max_election_cycleinteger

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.

statestring[]

US state or territory where a candidate runs for office

districtstring[]

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

party'' | 'DEM' | 'REP' | 'OTHER'

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

aggregate_by'office' | 'office-state' | 'office-state-district' | 'office-party'

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

sortstring[]

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

sort_hide_nullboolean

Hide null values on sorted column(s).

sort_null_onlyboolean

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

sort_nulls_lastboolean

Toggle that sorts null values last

api_keystring

Response

Default response

Changes

No recorded changes to this operation across all 20 revisions of this API.