@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api OpenFEC
@version 1.0
@auth ApiKey X-Api-Key in header | ApiKey api_key in query | ApiKey api_key in query
@common_fields {api_key: any}
@endpoints 100
@hint download_for_search
@toc audit-case(1), audit-category(1), audit-primary-category(1), calendar-dates(2), candidate(8), candidates(4), committee(9), committees(1), communication_costs(4), efile(6), election-dates(1), electioneering(4), elections(3), filings(1), legal(2), names(4), national_party(3), operations-log(1), presidential(5), rad-analyst(1), reporting-dates(1), reports(1), rulemaking(1), schedules(31), state-election-office(1), totals(3)

@group audit-case
@endpoint GET /v1/audit-case/
@optional {page: any, per_page: any, q: any, qq: any, primary_category_id: any, sub_category_id: any, audit_case_id: any, cycle: any, committee_id: any, committee_type: any, committee_designation: any, audit_id: any, candidate_id: any, min_election_cycle: any, max_election_cycle: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endgroup

@group audit-category
@endpoint GET /v1/audit-category/
@optional {page: any, per_page: any, primary_category_id: any, primary_category_name: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endgroup

@group audit-primary-category
@endpoint GET /v1/audit-primary-category/
@optional {page: any, per_page: any, primary_category_id: any, primary_category_name: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endgroup

@group calendar-dates
@endpoint GET /v1/calendar-dates/
@optional {page: any, per_page: any, calendar_category_id: any, description: any, summary: any, min_start_date: any, min_end_date: any, max_start_date: any, max_end_date: any, event_id: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/calendar-dates/export/
@optional {renderer: any, page: any, per_page: any, calendar_category_id: any, description: any, summary: any, min_start_date: any, min_end_date: any, max_start_date: any, max_end_date: any, event_id: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endgroup

@group candidate
@endpoint GET /v1/candidate/{candidate_id}/
@required {candidate_id: any}
@optional {page: any, per_page: any, cycle: any, election_year: any, office: any, state: any, party: any, year: any, district: any, candidate_status: any, incumbent_challenge: any, federal_funds_flag: any, has_raised_funds: any, name: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/candidate/{candidate_id}/committees/
@required {candidate_id: any}
@optional {page: any, per_page: any, year: any, cycle: any, filing_frequency: any, designation: any, organization_type: any, committee_type: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/candidate/{candidate_id}/committees/history/
@required {candidate_id: any}
@optional {page: any, per_page: any, election_full: any, designation: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/candidate/{candidate_id}/committees/history/{cycle}/
@required {cycle: any, candidate_id: any}
@optional {page: any, per_page: any, election_full: any, designation: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/candidate/{candidate_id}/filings/
@required {candidate_id: any}
@optional {page: any, per_page: any, committee_type: any, cycle: any, is_amended: any, most_recent: any, report_type: any, request_type: any, document_type: any, beginning_image_number: any, report_year: any, min_receipt_date: any, max_receipt_date: any, form_type: any, state: any, district: any, office: any, party: any, filer_type: any, file_number: any, primary_general_indicator: any, amendment_indicator: any, form_category: any, q_filer: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/candidate/{candidate_id}/history/
@required {candidate_id: any}
@optional {page: any, per_page: any, election_full: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/candidate/{candidate_id}/history/{cycle}/
@required {cycle: any, candidate_id: any}
@optional {page: any, per_page: any, election_full: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/candidate/{candidate_id}/totals/
@required {candidate_id: any}
@optional {page: any, per_page: any, election_full: any, cycle: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endgroup

@group candidates
@endpoint GET /v1/candidates/
@optional {page: any, per_page: any, q: any, candidate_id: any, min_first_file_date: any, max_first_file_date: any, is_active_candidate: any, cycle: any, election_year: any, office: any, state: any, party: any, year: any, district: any, candidate_status: any, incumbent_challenge: any, federal_funds_flag: any, has_raised_funds: any, name: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/candidates/search/
@optional {page: any, per_page: any, q: any, candidate_id: any, min_first_file_date: any, max_first_file_date: any, is_active_candidate: any, cycle: any, election_year: any, office: any, state: any, party: any, year: any, district: any, candidate_status: any, incumbent_challenge: any, federal_funds_flag: any, has_raised_funds: any, name: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/candidates/totals/
@optional {page: any, per_page: any, q: any, candidate_id: any, election_year: any, cycle: any, office: any, election_full: any, state: any, district: any, party: any, min_receipts: any, max_receipts: any, min_disbursements: any, max_disbursements: any, min_cash_on_hand_end_period: any, max_cash_on_hand_end_period: any, min_debts_owed_by_committee: any, max_debts_owed_by_committee: any, federal_funds_flag: any, has_raised_funds: any, is_active_candidate: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/candidates/totals/aggregates/
@optional {page: any, per_page: any, election_year: any, office: any, is_active_candidate: any, election_full: any, min_election_cycle: any, max_election_cycle: any, state: any, district: any, party: any, aggregate_by: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endgroup

@group committee
@endpoint GET /v1/committee/{committee_id}/
@required {committee_id: any}
@optional {page: any, per_page: any, year: any, cycle: any, filing_frequency: any, designation: any, organization_type: any, committee_type: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/committee/{committee_id}/candidates/
@required {committee_id: any}
@optional {page: any, per_page: any, cycle: any, election_year: any, office: any, state: any, party: any, year: any, district: any, candidate_status: any, incumbent_challenge: any, federal_funds_flag: any, has_raised_funds: any, name: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/committee/{committee_id}/candidates/history/
@required {committee_id: any}
@optional {page: any, per_page: any, election_full: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/committee/{committee_id}/candidates/history/{cycle}/
@required {cycle: any, committee_id: any}
@optional {page: any, per_page: any, election_full: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/committee/{committee_id}/filings/
@required {committee_id: any}
@optional {page: any, per_page: any, committee_type: any, cycle: any, is_amended: any, most_recent: any, report_type: any, request_type: any, document_type: any, beginning_image_number: any, report_year: any, min_receipt_date: any, max_receipt_date: any, form_type: any, state: any, district: any, office: any, party: any, filer_type: any, file_number: any, primary_general_indicator: any, amendment_indicator: any, form_category: any, q_filer: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/committee/{committee_id}/history/
@required {committee_id: any}
@optional {page: any, per_page: any, election_full: any, designation: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/committee/{committee_id}/history/{cycle}/
@required {cycle: any, committee_id: any}
@optional {page: any, per_page: any, election_full: any, designation: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/committee/{committee_id}/reports/
@required {committee_id: any}
@optional {page: any, per_page: any, year: any, cycle: any, beginning_image_number: any, report_type: any, is_amended: any, min_disbursements_amount: any, max_disbursements_amount: any, min_receipts_amount: any, max_receipts_amount: any, min_cash_on_hand_end_period_amount: any, max_cash_on_hand_end_period_amount: any, min_debts_owed_amount: any, max_debts_owed_expenditures: any, min_independent_expenditures: any, max_independent_expenditures: any, min_party_coordinated_expenditures: any, max_party_coordinated_expenditures: any, min_total_contributions: any, max_total_contributions: any, type: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/committee/{committee_id}/totals/
@required {committee_id: any}
@optional {page: any, per_page: any, cycle: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endgroup

@group committees
@endpoint GET /v1/committees/
@optional {page: any, per_page: any, year: any, cycle: any, filing_frequency: any, designation: any, organization_type: any, committee_type: any, q: any, committee_id: any, candidate_id: any, state: any, party: any, min_first_file_date: any, max_first_file_date: any, min_last_file_date: any, max_last_file_date: any, min_first_f1_date: any, max_first_f1_date: any, min_last_f1_date: any, max_last_f1_date: any, treasurer_name: any, sponsor_candidate_id: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endgroup

@group communication_costs
@endpoint GET /v1/communication_costs/
@optional {page: any, per_page: any, image_number: any, min_image_number: any, max_image_number: any, min_amount: any, max_amount: any, min_date: any, max_date: any, committee_id: any, candidate_id: any, support_oppose_indicator: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/communication_costs/aggregates/
@optional {page: any, per_page: any, cycle: any, candidate_id: any, committee_id: any, support_oppose_indicator: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/communication_costs/by_candidate/
@optional {page: any, per_page: any, state: any, district: any, cycle: any, office: any, election_full: any, candidate_id: any, support_oppose: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/communication_costs/totals/by_candidate/
@optional {page: any, per_page: any, cycle: any, candidate_id: any, election_full: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endgroup

@group efile
@endpoint GET /v1/efile/filings/
@optional {page: any, per_page: any, file_number: any, committee_id: any, min_receipt_date: any, max_receipt_date: any, q_filer: any, form_type: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/efile/form1/
@optional {page: any, per_page: any, file_number: any, committee_id: any, candidate_id: any, election_state: any, candidate_office: any, candidate_district: any, candidate_party: any, image_number: any, min_load_timestamp: any, max_load_timestamp: any, committee_type: any, organization_type: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/efile/form2/
@optional {page: any, per_page: any, file_number: any, committee_id: any, candidate_id: any, election_state: any, candidate_office: any, candidate_district: any, candidate_party: any, image_number: any, min_load_timestamp: any, max_load_timestamp: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/efile/reports/house-senate/
@optional {page: any, per_page: any, file_number: any, committee_id: any, min_receipt_date: any, max_receipt_date: any, q_filer: any, form_type: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/efile/reports/pac-party/
@optional {page: any, per_page: any, file_number: any, committee_id: any, min_receipt_date: any, max_receipt_date: any, q_filer: any, form_type: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/efile/reports/presidential/
@optional {page: any, per_page: any, file_number: any, committee_id: any, min_receipt_date: any, max_receipt_date: any, q_filer: any, form_type: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endgroup

@group election-dates
@endpoint GET /v1/election-dates/
@optional {page: any, per_page: any, election_state: any, election_district: any, election_party: any, office_sought: any, min_election_date: any, max_election_date: any, election_type_id: any, min_create_date: any, max_create_date: any, min_update_date: any, max_update_date: any, election_year: any, min_primary_general_date: any, max_primary_general_date: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endgroup

@group electioneering
@endpoint GET /v1/electioneering/
@optional {page: any, per_page: any, committee_id: any, candidate_id: any, report_year: any, min_amount: any, max_amount: any, min_date: any, max_date: any, disbursement_description: any, last_index: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/electioneering/aggregates/
@optional {page: any, per_page: any, cycle: any, candidate_id: any, committee_id: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/electioneering/by_candidate/
@optional {page: any, per_page: any, state: any, district: any, cycle: any, office: any, election_full: any, candidate_id: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/electioneering/totals/by_candidate/
@optional {page: any, per_page: any, cycle: any, candidate_id: any, election_full: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endgroup

@group elections
@endpoint GET /v1/elections/
@required {cycle: any, office: any}
@optional {page: any, per_page: any, state: any, district: any, election_full: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/elections/search/
@optional {page: any, per_page: any, state: any, district: any, cycle: any, zip: any, office: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/elections/summary/
@required {cycle: any, office: any}
@optional {state: any, district: any, election_full: any}

@endgroup

@group filings
@endpoint GET /v1/filings/
@optional {page: any, per_page: any, committee_type: any, cycle: any, is_amended: any, most_recent: any, report_type: any, request_type: any, document_type: any, beginning_image_number: any, report_year: any, min_receipt_date: any, max_receipt_date: any, form_type: any, state: any, district: any, office: any, party: any, filer_type: any, file_number: any, primary_general_indicator: any, amendment_indicator: any, form_category: any, q_filer: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any, committee_id: any, candidate_id: any}

@endgroup

@group legal
@endpoint GET /v1/legal/docs/{doc_type}/{no}
@required {no: any, doc_type: any}

@endpoint GET /v1/legal/search/
@optional {q: any, from_hit: any, hits_returned: any, type: any, ao_no: any, ao_year: any, ao_name: any, ao_min_issue_date: any, ao_max_issue_date: any, ao_min_request_date: any, ao_max_request_date: any, ao_min_document_date: any, ao_max_document_date: any, ao_doc_category_id: any, ao_is_pending: any, ao_status: any, ao_requestor: any, ao_requestor_type: any, ao_regulatory_citation: any, ao_statutory_citation: any, ao_citation_require_all: any, ao_commenter: any, ao_representative: any, case_no: any, case_respondents: any, case_election_cycles: any, case_min_open_date: any, primary_subject_id: any, secondary_subject_id: any, case_max_open_date: any, case_min_close_date: any, case_max_close_date: any, case_min_document_date: any, case_max_document_date: any, case_regulatory_citation: any, case_statutory_citation: any, case_citation_require_all: any, q_exclude: any, case_doc_category_id: any, mur_type: any, mur_disposition_category_id: any, af_name: any, af_committee_id: any, af_report_year: any, af_min_rtb_date: any, af_max_rtb_date: any, af_rtb_fine_amount: any, af_min_fd_date: any, af_max_fd_date: any, af_fd_fine_amount: any, sort: any, case_min_penalty_amount: any, case_max_penalty_amount: any, q_proximity: any, max_gaps: any, proximity_preserve_order: any, proximity_filter: any, proximity_filter_term: any, filename: any}

@endgroup

@group names
@endpoint GET /v1/names/audit_candidates/
@required {q: any}

@endpoint GET /v1/names/audit_committees/
@required {q: any}

@endpoint GET /v1/names/candidates/
@required {q: any}

@endpoint GET /v1/names/committees/
@required {q: any}

@endgroup

@group national_party
@endpoint GET /v1/national_party/schedule_a/
@optional {page: any, per_page: any, committee_id: any, contributor_id: any, two_year_transaction_period: any, contributor_name: any, contributor_city: any, contributor_state: any, contributor_zip: any, contributor_occupation: any, contributor_employer: any, image_number: any, min_contribution_receipt_date: any, max_contribution_receipt_date: any, is_individual: any, contributor_type: any, contributor_committee_type: any, contributor_committee_designation: any, min_contribution_receipt_amount: any, max_contribution_receipt_amount: any, party_account_type: any, receipt_type: any, sort: any, sort_hide_null: any, sort_null_only: any}

@endpoint GET /v1/national_party/schedule_b/
@optional {page: any, per_page: any, committee_id: any, disbursement_type: any, disbursement_description: any, disbursement_purpose_category: any, image_number: any, line_number: any, min_disbursement_amount: any, max_disbursement_amount: any, min_disbursement_date: any, max_disbursement_date: any, recipient_city: any, recipient_committee_id: any, recipient_name: any, recipient_state: any, recipient_zip: any, recipient_committee_designation: any, recipient_committee_type: any, two_year_transaction_period: any, party_account_type: any, sort: any, sort_hide_null: any, sort_null_only: any}

@endpoint GET /v1/national_party/totals/
@optional {page: any, per_page: any, committee_id: any, two_year_transaction_period: any, sort: any, sort_hide_null: any, sort_null_only: any}

@endgroup

@group operations-log
@endpoint GET /v1/operations-log/
@optional {page: any, per_page: any, candidate_committee_id: any, report_type: any, beginning_image_number: any, report_year: any, form_type: any, amendment_indicator: any, status_num: any, min_receipt_date: any, max_receipt_date: any, min_coverage_end_date: any, max_coverage_end_date: any, min_transaction_data_complete_date: any, max_transaction_data_complete_date: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endgroup

@group presidential
@endpoint GET /v1/presidential/contributions/by_candidate/
@optional {page: any, per_page: any, election_year: any, contributor_state: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/presidential/contributions/by_size/
@optional {page: any, per_page: any, election_year: any, candidate_id: any, size: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/presidential/contributions/by_state/
@optional {page: any, per_page: any, election_year: any, candidate_id: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/presidential/coverage_end_date/
@optional {page: any, per_page: any, election_year: any, candidate_id: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/presidential/financial_summary/
@optional {page: any, per_page: any, election_year: any, candidate_id: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endgroup

@group rad-analyst
@endpoint GET /v1/rad-analyst/
@optional {page: any, per_page: any, committee_id: any, analyst_id: any, analyst_short_id: any, telephone_ext: any, name: any, email: any, title: any, min_assignment_update_date: any, max_assignment_update_date: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endgroup

@group reporting-dates
@endpoint GET /v1/reporting-dates/
@optional {page: any, per_page: any, min_due_date: any, max_due_date: any, report_year: any, report_type: any, min_create_date: any, max_create_date: any, min_update_date: any, max_update_date: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endgroup

@group reports
@endpoint GET /v1/reports/{entity_type}/
@required {entity_type: any}
@optional {page: any, per_page: any, year: any, cycle: any, beginning_image_number: any, report_type: any, is_amended: any, most_recent: any, filer_type: any, min_disbursements_amount: any, max_disbursements_amount: any, min_receipts_amount: any, max_receipts_amount: any, max_receipt_date: any, min_receipt_date: any, min_cash_on_hand_end_period_amount: any, max_cash_on_hand_end_period_amount: any, min_debts_owed_amount: any, max_debts_owed_expenditures: any, min_independent_expenditures: any, max_independent_expenditures: any, min_party_coordinated_expenditures: any, max_party_coordinated_expenditures: any, min_total_contributions: any, max_total_contributions: any, committee_type: any, candidate_id: any, committee_id: any, amendment_indicator: any, q_filer: any, q_spender: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endgroup

@group rulemaking
@endpoint GET /v1/rulemaking/search/
@optional {q: any, q_exclude: any, from_hit: any, hits_returned: any, rm_no: any, rm_name: any, rm_year: any, doc_category_id: any, min_federal_registry_publish_date: any, max_federal_registry_publish_date: any, min_hearing_date: any, max_hearing_date: any, min_vote_date: any, max_vote_date: any, is_key_document: any, is_open_for_comment: any, entity_name: any, entity_role_type: any, filename: any, sort: any, q_proximity: any, max_gaps: any, proximity_preserve_order: any, proximity_filter: any, proximity_filter_term: any}

@endgroup

@group schedules
@endpoint GET /v1/schedules/schedule_a/
@optional {image_number: any, min_image_number: any, max_image_number: any, min_amount: any, max_amount: any, min_date: any, max_date: any, committee_id: any, contributor_id: any, contributor_name: any, contributor_city: any, contributor_state: any, contributor_zip: any, contributor_employer: any, contributor_occupation: any, last_contribution_receipt_date: any, last_contribution_receipt_amount: any, line_number: any, is_individual: any, contributor_type: any, two_year_transaction_period: any, recipient_committee_type: any, recipient_committee_org_type: any, recipient_committee_designation: any, min_load_date: any, max_load_date: any, per_page: any, last_index: any, sort: any, sort_hide_null: any, sort_null_only: any}

@endpoint GET /v1/schedules/schedule_a/by_employer/
@optional {page: any, per_page: any, cycle: any, employer: any, committee_id: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/schedules/schedule_a/by_occupation/
@optional {page: any, per_page: any, cycle: any, occupation: any, committee_id: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/schedules/schedule_a/by_size/
@optional {page: any, per_page: any, cycle: any, size: any, committee_id: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/schedules/schedule_a/by_size/by_candidate/
@required {candidate_id: any, cycle: any}
@optional {page: any, per_page: any, election_full: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/schedules/schedule_a/by_state/
@optional {page: any, per_page: any, cycle: any, state: any, committee_id: any, hide_null: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/schedules/schedule_a/by_state/by_candidate/
@required {candidate_id: any, cycle: any}
@optional {page: any, per_page: any, election_full: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/schedules/schedule_a/by_state/by_candidate/totals/
@required {candidate_id: any, cycle: any}
@optional {page: any, per_page: any, election_full: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/schedules/schedule_a/by_state/totals/
@optional {cycle: any, state: any, committee_type: any, page: any, per_page: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/schedules/schedule_a/by_zip/
@optional {page: any, per_page: any, cycle: any, zip: any, state: any, committee_id: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/schedules/schedule_a/efile/
@optional {page: any, per_page: any, committee_id: any, contributor_name: any, contributor_city: any, contributor_state: any, contributor_employer: any, contributor_occupation: any, image_number: any, min_image_number: any, max_image_number: any, min_amount: any, max_amount: any, min_date: any, max_date: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/schedules/schedule_a/{sub_id}/
@required {sub_id: any}
@optional {image_number: any, min_image_number: any, max_image_number: any, min_amount: any, max_amount: any, min_date: any, max_date: any, committee_id: any, contributor_id: any, contributor_name: any, contributor_city: any, contributor_state: any, contributor_zip: any, contributor_employer: any, contributor_occupation: any, last_contribution_receipt_date: any, last_contribution_receipt_amount: any, line_number: any, is_individual: any, contributor_type: any, two_year_transaction_period: any, recipient_committee_type: any, recipient_committee_org_type: any, recipient_committee_designation: any, min_load_date: any, max_load_date: any, per_page: any, last_index: any, sort: any, sort_hide_null: any, sort_null_only: any}

@endpoint GET /v1/schedules/schedule_a_form5/
@optional {image_number: any, min_image_number: any, max_image_number: any, min_amount: any, max_amount: any, min_date: any, max_date: any, contributor_name: any, contributor_city: any, contributor_state: any, contributor_zip: any, contributor_employer: any, contributor_occupation: any, last_contribution_receipt_date: any, last_contribution_amount: any, report_year: any, report_type: any, contributor_type: any, two_year_transaction_period: any, per_page: any, last_index: any, sort: any, sort_hide_null: any, sort_null_only: any}

@endpoint GET /v1/schedules/schedule_b/
@optional {image_number: any, min_image_number: any, max_image_number: any, min_amount: any, max_amount: any, min_date: any, max_date: any, committee_id: any, disbursement_description: any, disbursement_purpose_category: any, last_disbursement_amount: any, last_disbursement_date: any, line_number: any, recipient_city: any, recipient_committee_id: any, recipient_name: any, recipient_state: any, spender_committee_designation: any, spender_committee_org_type: any, spender_committee_type: any, two_year_transaction_period: any, per_page: any, last_index: any, sort: any, sort_hide_null: any, sort_null_only: any}

@endpoint GET /v1/schedules/schedule_b/by_purpose/
@optional {page: any, per_page: any, cycle: any, purpose: any, committee_id: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/schedules/schedule_b/by_recipient/
@optional {page: any, per_page: any, cycle: any, recipient_name: any, committee_id: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/schedules/schedule_b/by_recipient_id/
@optional {page: any, per_page: any, cycle: any, recipient_id: any, committee_id: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/schedules/schedule_b/efile/
@optional {page: any, per_page: any, committee_id: any, disbursement_description: any, image_number: any, recipient_city: any, recipient_state: any, max_date: any, min_date: any, min_amount: any, max_amount: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/schedules/schedule_b/{sub_id}/
@required {sub_id: any}
@optional {image_number: any, min_image_number: any, max_image_number: any, min_amount: any, max_amount: any, min_date: any, max_date: any, committee_id: any, disbursement_description: any, disbursement_purpose_category: any, last_disbursement_amount: any, last_disbursement_date: any, line_number: any, recipient_city: any, recipient_committee_id: any, recipient_name: any, recipient_state: any, spender_committee_designation: any, spender_committee_org_type: any, spender_committee_type: any, two_year_transaction_period: any, per_page: any, last_index: any, sort: any, sort_hide_null: any, sort_null_only: any}

@endpoint GET /v1/schedules/schedule_c/
@optional {image_number: any, min_image_number: any, max_image_number: any, min_amount: any, max_amount: any, committee_id: any, candidate_name: any, loan_source_name: any, min_payment_to_date: any, max_payment_to_date: any, min_incurred_date: any, max_incurred_date: any, form_line_number: any, page: any, per_page: any, last_index: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/schedules/schedule_c/{sub_id}/
@required {sub_id: any}
@optional {page: any, per_page: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/schedules/schedule_d/
@optional {image_number: any, min_image_number: any, max_image_number: any, min_payment_period: any, max_payment_period: any, min_amount_incurred: any, max_amount_incurred: any, min_amount_outstanding_beginning: any, max_amount_outstanding_beginning: any, min_amount_outstanding_close: any, max_amount_outstanding_close: any, creditor_debtor_name: any, nature_of_debt: any, committee_id: any, min_coverage_end_date: any, max_coverage_end_date: any, min_coverage_start_date: any, max_coverage_start_date: any, report_year: any, report_type: any, form_line_number: any, committee_type: any, filing_form: any, page: any, per_page: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/schedules/schedule_d/{sub_id}/
@required {sub_id: any}
@optional {page: any, per_page: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/schedules/schedule_e/
@optional {image_number: any, min_image_number: any, max_image_number: any, min_amount: any, max_amount: any, min_date: any, max_date: any, candidate_office: any, candidate_party: any, candidate_office_state: any, candidate_office_district: any, cycle: any, committee_id: any, candidate_id: any, filing_form: any, last_expenditure_date: any, last_expenditure_amount: any, last_office_total_ytd: any, payee_name: any, support_oppose_indicator: any, last_support_oppose_indicator: any, is_notice: any, min_dissemination_date: any, max_dissemination_date: any, min_filing_date: any, max_filing_date: any, most_recent: any, q_spender: any, form_line_number: any, per_page: any, last_index: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/schedules/schedule_e/by_candidate/
@optional {page: any, per_page: any, state: any, district: any, cycle: any, office: any, election_full: any, candidate_id: any, committee_id: any, support_oppose: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/schedules/schedule_e/efile/
@optional {page: any, per_page: any, candidate_search: any, committee_id: any, candidate_id: any, payee_name: any, image_number: any, support_oppose_indicator: any, min_expenditure_date: any, max_expenditure_date: any, min_dissemination_date: any, max_dissemination_date: any, min_expenditure_amount: any, max_expenditure_amount: any, spender_name: any, candidate_party: any, candidate_office: any, candidate_office_state: any, candidate_office_district: any, most_recent: any, min_filed_date: any, max_filed_date: any, filing_form: any, is_notice: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/schedules/schedule_e/totals/by_candidate/
@optional {page: any, per_page: any, cycle: any, candidate_id: any, election_full: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/schedules/schedule_f/
@optional {image_number: any, min_image_number: any, max_image_number: any, min_amount: any, max_amount: any, min_date: any, max_date: any, candidate_id: any, payee_name: any, committee_id: any, cycle: any, form_line_number: any, page: any, per_page: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/schedules/schedule_f/{sub_id}/
@required {sub_id: any}
@optional {page: any, per_page: any}

@endpoint GET /v1/schedules/schedule_h4/
@optional {image_number: any, min_image_number: any, max_image_number: any, min_amount: any, max_amount: any, min_date: any, max_date: any, report_year: any, report_type: any, activity_or_event: any, q_payee_name: any, payee_city: any, payee_zip: any, payee_state: any, q_disbursement_purpose: any, cycle: any, committee_id: any, last_payee_name: any, last_disbursement_purpose: any, last_event_purpose_date: any, last_spender_committee_name: any, last_disbursement_amount: any, administrative_voter_drive_activity_indicator: any, fundraising_activity_indicator: any, exempt_activity_indicator: any, direct_candidate_support_activity_indicator: any, administrative_activity_indicator: any, general_voter_drive_activity_indicator: any, public_comm_indicator: any, spender_committee_name: any, spender_committee_type: any, spender_committee_designation: any, form_line_number: any, per_page: any, last_index: any, sort: any, sort_hide_null: any, sort_null_only: any}

@endpoint GET /v1/schedules/schedule_h4/efile/
@optional {page: any, per_page: any, image_number: any, min_image_number: any, max_image_number: any, payee_city: any, payee_zip: any, payee_state: any, committee_id: any, last_disbursement_purpose: any, last_event_purpose_date: any, min_date: any, max_date: any, last_disbursement_amount: any, min_amount: any, max_amount: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endgroup

@group state-election-office
@endpoint GET /v1/state-election-office/
@required {state: any}
@optional {page: any, per_page: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endgroup

@group totals
@endpoint GET /v1/totals/by_entity/
@required {cycle: any}
@optional {page: any, per_page: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/totals/inaugural_committees/by_contributor/
@optional {page: any, per_page: any, committee_id: any, contributor_name: any, cycle: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endpoint GET /v1/totals/{entity_type}/
@required {entity_type: any}
@optional {page: any, per_page: any, cycle: any, committee_designation: any, committee_id: any, committee_type: any, committee_state: any, filing_frequency: any, treasurer_name: any, min_disbursements: any, max_disbursements: any, min_receipts: any, max_receipts: any, min_last_cash_on_hand_end_period: any, max_last_cash_on_hand_end_period: any, min_last_debts_owed_by_committee: any, max_last_debts_owed_by_committee: any, sponsor_candidate_id: any, organization_type: any, min_first_f1_date: any, max_first_f1_date: any, sort: any, sort_hide_null: any, sort_null_only: any, sort_nulls_last: any}

@endgroup

@end