List Candidate Totals - Aries API

List candidate totals

curl --request GET \
  --url https://api.aries.com/v1/prediction/candidates/totals \
  --header 'Authorization: Bearer <token>'

{
  "pagination": {
    "count": 1,
    "isCountExact": true,
    "page": 1,
    "pages": 1,
    "perPage": 20
  },
  "results": [
    {
      "activeThrough": 2024,
      "addressCity": "San Francisco",
      "addressState": "CA",
      "addressStreet1": "100 Market St",
      "addressZip": "94105",
      "candidateElectionYear": 2024,
      "candidateFirstName": "Jane",
      "candidateId": "H0CA12034",
      "candidateInactive": false,
      "candidateLastName": "Smith",
      "candidateStatus": "C",
      "cashOnHandEndPeriod": 2450000.12,
      "coverageEndDate": "2024-03-31",
      "coverageStartDate": "2024-01-01",
      "cycle": 2024,
      "cycles": [
        2024
      ],
      "debtsOwedByCommittee": 120000.5,
      "disbursements": 3150000.45,
      "district": "12",
      "districtNumber": 12,
      "electionDistricts": [
        "12"
      ],
      "electionYear": 2024,
      "electionYears": [
        2024
      ],
      "federalFundsFlag": false,
      "firstFileDate": "2023-02-14",
      "hasRaisedFunds": true,
      "incumbentChallenge": "I",
      "incumbentChallengeFull": "Incumbent",
      "individualItemizedContributions": 1900000.33,
      "isElection": true,
      "lastF2Date": "2024-03-01",
      "lastFileDate": "2024-04-10",
      "loadDate": "2024-04-10T12:30:00Z",
      "name": "Jane Smith",
      "office": "H",
      "officeFull": "House",
      "otherPoliticalCommitteeContributions": 210000,
      "party": "DEM",
      "partyFull": "Democratic Party",
      "receipts": 4200000.78,
      "state": "CA",
      "stateFull": "California",
      "transfersFromOtherAuthorizedCommittee": 50000,
      "twoYearPeriod": 2024
    }
  ]
}

GET

/

v1

/

prediction

/

candidates

/

totals

List candidate totals

curl --request GET \
  --url https://api.aries.com/v1/prediction/candidates/totals \
  --header 'Authorization: Bearer <token>'

{
  "pagination": {
    "count": 1,
    "isCountExact": true,
    "page": 1,
    "pages": 1,
    "perPage": 20
  },
  "results": [
    {
      "activeThrough": 2024,
      "addressCity": "San Francisco",
      "addressState": "CA",
      "addressStreet1": "100 Market St",
      "addressZip": "94105",
      "candidateElectionYear": 2024,
      "candidateFirstName": "Jane",
      "candidateId": "H0CA12034",
      "candidateInactive": false,
      "candidateLastName": "Smith",
      "candidateStatus": "C",
      "cashOnHandEndPeriod": 2450000.12,
      "coverageEndDate": "2024-03-31",
      "coverageStartDate": "2024-01-01",
      "cycle": 2024,
      "cycles": [
        2024
      ],
      "debtsOwedByCommittee": 120000.5,
      "disbursements": 3150000.45,
      "district": "12",
      "districtNumber": 12,
      "electionDistricts": [
        "12"
      ],
      "electionYear": 2024,
      "electionYears": [
        2024
      ],
      "federalFundsFlag": false,
      "firstFileDate": "2023-02-14",
      "hasRaisedFunds": true,
      "incumbentChallenge": "I",
      "incumbentChallengeFull": "Incumbent",
      "individualItemizedContributions": 1900000.33,
      "isElection": true,
      "lastF2Date": "2024-03-01",
      "lastFileDate": "2024-04-10",
      "loadDate": "2024-04-10T12:30:00Z",
      "name": "Jane Smith",
      "office": "H",
      "officeFull": "House",
      "otherPoliticalCommitteeContributions": 210000,
      "party": "DEM",
      "partyFull": "Democratic Party",
      "receipts": 4200000.78,
      "state": "CA",
      "stateFull": "California",
      "transfersFromOtherAuthorizedCommittee": 50000,
      "twoYearPeriod": 2024
    }
  ]
}

Authorizations

Authorization

string

header

required

OAuth2 Bearer token: obtain an access token from the token endpoint and send it in the Authorization header.

Query Parameters

page

integer | null

Page number for pagination.

perPage

integer | null

Number of results to return per page.

keywords

string[]

Full-text search keywords.

candidateId

string[]

Filter by one or more candidate IDs.

electionYear

integer[]

Filter by one or more election years.

cycle

integer[]

Filter by one or more filing cycles.

office

string[]

Filter by office code.

electionFull

boolean | null

When true, return the full election period instead of a single two-year cycle.

state

string[]

Filter by state or territory.

district

string[]

Filter by district.

party

string[]

Filter by party code.

minReceipts

number | null

Filter by minimum receipts.

maxReceipts

number | null

Filter by maximum receipts.

minDisbursements

number | null

Filter by minimum disbursements.

maxDisbursements

number | null

Filter by maximum disbursements.

minCashOnHandEndPeriod

number | null

Filter by minimum cash on hand at the end of the period.

maxCashOnHandEndPeriod

number | null

Filter by maximum cash on hand at the end of the period.

minDebtsOwedByCommittee

number | null

Filter by minimum debts owed by the committee.

maxDebtsOwedByCommittee

number | null

Filter by maximum debts owed by the committee.

federalFundsFlag

boolean | null

Filter by whether federal funds are involved.

hasRaisedFunds

boolean | null

Filter by whether the candidate has raised funds.

isActiveCandidate

boolean | null

Filter by whether the candidate is currently active.

sortBy

enum<string> | null

Field to sort by.

Available options:

electionYear

sortOrder

enum<string> | null

Sort direction.

Available options:

ascending

sortHideNull

boolean | null

Hide rows where the sorted field is null.

sortNullOnly

boolean | null

Return only rows where the sorted field is null.

sortNullsLast

boolean | null

Place null values after non-null values when sorting.

Response

Successful response

pagination

object

Show child attributes

results

object[]

Show child attributes

Search Candidates Get Candidate Totals