Skip to main content
GET
/
v1
/
prediction
/
disbursements
List disbursements
curl --request GET \
  --url https://api.aries.com/v1/prediction/disbursements \
  --header 'Authorization: Bearer <token>'
{ "pagination": { "pages": 1, "perPage": 20, "count": 1, "isCountExact": true, "lastIndexes": { "lastIndex": "1704067200|456789", "sortNullOnly": false } }, "results": [ { "amendmentIndicator": "N", "amendmentIndicatorDesc": "New", "candidateId": "H0CA12034", "candidateName": "Jane Smith", "committeeId": "C00694323", "disbursementAmount": 12500, "disbursementDate": "2024-03-20", "disbursementDescription": "Digital advertising buy", "disbursementPurposeCategory": "ADVERTISING", "disbursementType": "Operating expenditure", "filingForm": "F3", "imageNumber": "202403209612345679", "lineNumber": "17", "loadDate": "2024-03-21T09:10:00Z", "memoedSubtotal": false, "pdfUrl": "https://example.com/disbursement.pdf", "recipientCity": "Los Angeles", "recipientCommitteeId": "", "recipientName": "Acme Media", "recipientState": "CA", "reportYear": 2024, "scheduleType": "SB", "semiAnnualBundledRefund": 0, "subId": "2234567890", "transactionId": "SB17.67890", "twoYearTransactionPeriod": 2024 } ] }

​
Parameter notes

  • Use disbursementPurposeCategory values such as ADMINISTRATIVE, ADVERTISING, CONTRIBUTIONS, EVENTS, FUNDRAISING, LOAN-REPAYMENTS, MATERIALS, OTHER, POLLING, REFUNDS, TRANSFERS, and TRAVEL.
  • Use spenderCommitteeDesignation, spenderCommitteeOrgType, and spenderCommitteeType for one-letter committee classification filters.
  • When paginating sorted results, send lastIndex with the matching lastDisbursementDate or lastDisbursementAmount 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 page where the filing 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

Return only records with a disbursement amount greater than or equal to this value.

​
maxAmount
number | null

Return only records with a disbursement 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 or filer ID. These typically start with C followed by eight digits.

​
disbursementDescription
string[]

Text description of the disbursement.

​
disbursementPurposeCategory
string[]

Purpose category for the disbursement. Common values include ADMINISTRATIVE, ADVERTISING, CONTRIBUTIONS, EVENTS, FUNDRAISING, LOAN-REPAYMENTS, MATERIALS, OTHER, POLLING, REFUNDS, TRANSFERS, and TRAVEL.

​
lastDisbursementAmount
number | null

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

​
lastDisbursementDate
string | null

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

​
lineNumber
string | null

Filing line number to filter by, for example 17.

​
recipientCity
string[]

City of the recipient.

​
recipientCommitteeId
string[]

FEC ID for the recipient committee when the recipient is registered with the FEC.

​
recipientName
string[]

Name of the person or entity receiving the disbursement.

​
recipientState
string[]

Two-letter state or territory code for the recipient.

​
spenderCommitteeDesignation
string[]

One-letter designation code for the spending organization. Use A authorized by a candidate, J joint fundraising committee, P principal campaign committee, U unauthorized, B lobbyist or registrant PAC, or D leadership PAC.

​
spenderCommitteeOrgType
string[]

One-letter organization type code. Use C corporation, L labor organization, M membership organization, T trade association, V cooperative, W corporation without capital stock, H host committee, or I inaugural committee.

​
spenderCommitteeType
string[]

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

​
twoYearTransactionPeriod
integer[]

Two-year transaction period derived from the transaction date. Use the ending even year, for example 2024 for the 2023-2024 period. If omitted, results default to the current cycle.

​
perPage
integer | null

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

​
lastIndex
string | null

Keyset cursor from pagination.lastIndexes.lastIndex in the previous response.

​
sortBy
enum<string> | null

Field used for sorting and keyset pagination. Wrapper-supported values are disbursementDate, disbursementAmount, and loadDate.

Available options:
disbursementDate,
disbursementAmount,
loadDate
​
sortOrder
enum<string> | null

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

Available options:
ascending,
descending
​
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 rows with null sort values after non-null values.

Response

Successful response

​
pagination
object
​
results
object[]