Skip to main content
GET
/
v1
/
prediction
/
receipts
List receipts
curl --request GET \
  --url https://api.aries.com/v1/prediction/receipts \
  --header 'Authorization: Bearer <token>'
{
  "pagination": {
    "pages": 1,
    "perPage": 20,
    "count": 1,
    "isCountExact": true,
    "lastIndexes": {
      "lastIndex": "1704067200|123456",
      "sortNullOnly": false
    }
  },
  "results": [
    {
      "amendmentIndicator": "N",
      "amendmentIndicatorDesc": "New",
      "candidateId": "H0CA12034",
      "candidateName": "Jane Smith",
      "candidateOffice": "H",
      "committeeId": "C00694323",
      "committeeName": "Jane Smith for Congress",
      "contributionReceiptAmount": 2800,
      "contributionReceiptDate": "2024-03-15",
      "contributorName": "Jane Doe",
      "contributorCity": "San Francisco",
      "contributorEmployer": "Acme Corp",
      "contributorOccupation": "Engineer",
      "contributorState": "CA",
      "contributorZip": "94105",
      "filingForm": "F3",
      "imageNumber": "202403159612345678",
      "isIndividual": true,
      "lineNumber": "11AI",
      "loadDate": "2024-03-16T10:22:00Z",
      "memoedSubtotal": false,
      "pdfUrl": "https://example.com/receipt.pdf",
      "receiptType": "IND",
      "receiptTypeDesc": "Individual contribution",
      "reportYear": 2024,
      "scheduleType": "SA",
      "subId": "1234567890",
      "transactionId": "SA11AI.12345",
      "twoYearTransactionPeriod": 2024
    }
  ]
}

​
Parameter notes

  • The first request must include at least one of twoYearTransactionPeriod, committeeId, contributorId, contributorName, contributorCity, contributorZip, contributorEmployer, contributorOccupation, or imageNumber.
  • Use lineNumber in FORM-LINENUMBER format, such as F3-11AI.
  • Use contributorType values individual or committee.
  • Use one-letter values for recipientCommitteeType, recipientCommitteeOrgType, and recipientCommitteeDesignation.
  • When paginating sorted results, send lastIndex with the matching lastContributionReceiptDate or lastContributionReceiptAmount value from the previous response.

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

​
imageNumber
string[]

Unique image number for the filing page where the receipt item appears.

​
minImageNumber
string | null

Lowest image number to include when filtering filing pages.

​
maxImageNumber
string | null

Highest image number to include when filtering filing pages.

​
minAmount
number | null

Filter records with amount greater than or equal to this value.

​
maxAmount
number | null

Filter records with amount less than or equal to this value.

​
minDate
string | null

Earliest reporting date to include. Only records after this date are returned.

​
maxDate
string | null

Latest reporting date to include. Only records before this date are returned.

​
committeeId
string[]

Committee identifier for the recipient committee. Use values that begin with C followed by eight digits.

​
contributorId
string[]

Contributor identifier when the contributor is a registered filer or committee with an FEC-style ID.

​
contributorName
string[]

Contributor name as reported on the filing. Use this to match individuals, committees, or other named contributors.

​
contributorCity
string[]

Contributor city.

​
contributorState
string[]

Contributor state or territory. Use a two-letter postal abbreviation such as CA or NY.

​
contributorZip
string[]

Contributor ZIP code.

​
contributorEmployer
string[]

Contributor employer, when reported. Filers are expected to make a best effort to collect this information for individual contributors.

​
contributorOccupation
string[]

Contributor occupation, when reported. Filers are expected to make a best effort to collect this information for individual contributors.

​
lastContributionReceiptDate
string | null

When paging results sorted by contributionReceiptDate, send the contributionReceiptDate value from the last row of the previous page together with lastIndex.

​
lastContributionReceiptAmount
number | null

When paging results sorted by contributionReceiptAmount, send the contributionReceiptAmount value from the last row of the previous page together with lastIndex.

​
lineNumber
string | null

Filter by form and line number using FORM-LINENUMBER, for example F3-11AI or F3X-11AI.

​
isIndividual
boolean | null

Restrict results to non-earmarked individual contributions when true. This is useful when you want individual contribution records without double counting memoed entries.

​
contributorType
string[]

Filter receipts by contributor category. Use individual or committee.

​
twoYearTransactionPeriod
integer[]

Two-year transaction period for the receipt. The period is named for the ending even-numbered year, so 2024 covers the 2023-2024 cycle.

​
recipientCommitteeType
string[]

One-letter committee type code for the recipient committee. Common values include H (House), S (Senate), P (presidential), Q (qualified PAC), N (nonqualified PAC), O (independent expenditure-only), X (party, nonqualified), and Y (party, qualified).

​
recipientCommitteeOrgType
string[]

One-letter organization type code for the recipient committee. Common values include C (corporation), L (labor organization), M (membership organization), T (trade association), V (cooperative), W (corporation without capital stock), H (host committee), and I (inaugural committee).

​
recipientCommitteeDesignation
string[]

One-letter committee designation code. Common values include A (authorized), J (joint fundraising), P (principal campaign committee), U (unauthorized), B (lobbyist or registrant PAC), and D (leadership PAC).

​
minLoadDate
string | null

Earliest system load date to include. This can help isolate records that were processed recently.

​
maxLoadDate
string | null

Latest system load date to include. This can help isolate records that were processed recently.

​
perPage
integer | null

Number of results to return per page. Defaults to 20.

​
lastIndex
string | null

Continuation cursor from the previous page. When continuing sorted results, send this with the matching lastContributionReceiptDate or lastContributionReceiptAmount from the last row of the previous page.

​
sortBy
enum<string> | null

Field used for sorting and keyset pagination. Wrapper-supported values are contributionReceiptDate and contributionReceiptAmount.

Available options:
contributionReceiptDate,
contributionReceiptAmount
​
sortOrder
enum<string> | null

Sort direction. Use ascending or descending. If omitted, descending order is used.

Available options:
ascending,
descending
​
sortHideNull
boolean | null

When sorting, hide rows where the selected sort field is null.

​
sortNullOnly
boolean | null

When sorting, return only rows where the selected sort field is null.

​
sortNullsLast
boolean | null

When sorting, place null values after non-null values.

Response

Successful response

​
pagination
object
​
results
object[]