POST/shorts.v1alpha1.PoliticiansService/GetDonationsOverview

GetDonationsOverview

Party-group funding rollups for one financial year, plus the corpus counts and disclosure notes a funding surface must render.

Parameters

Connect-Protocol-VersionheaderRequired
number [1]

Define the version of the Connect protocol

Connect-Timeout-Msheader
number

Define the timeout, in ms

Request Body

application/json
object
financialYearstring

Verbatim FY label ('2024-25'). Empty selects the latest year held. (proto string)

limitinteger <int32>

Party groups returned, ordered by total_receipts_cents desc. Default 25, max 100. (proto int32)

Responses

200Success
application/json
object
asAtstring <date-time>

ingest snapshot (proto google.protobuf.Timestamp)

attributionstring

Crown copyright credit; required by the licence (proto string)

availableFinancialYearsarray

(proto shorts.v1alpha1.FinancialYearOption)

Array Items:
censoringNotestring

The mandatory notes, single-sourced HERE so every surface renders the same words and none can paraphrase them into a claim the data cannot support. right-censoring at the disclosure threshold (proto string)

corpusobject

(proto shorts.v1alpha1.DonationsCorpusCounts)

candidateDonationCountinteger <int32>

(proto int32)

candidateReturnCountinteger <int32>

(proto int32)

candidateReturnResolvedCountinteger <int32>

(proto int32)

donationMadeCountinteger <int32>

(proto int32)

firstFinancialYearEndinteger <int32>

(proto int32)

lastFinancialYearEndinteger <int32>

(proto int32)

matchableCompanyNameCountinteger <int32>

How many company names the match layer can match against at all. A property of the company metadata, kept as the denominator that makes the matched figures legible, and never to be rendered as a number of donors. (proto int32)

matchedPayerCodeCountinteger <int32>

(proto int32)

matchedPayerNameCountinteger <int32>

Donor/payer NAMES appearing in this corpus that resolve to an ASX listing, and the codes they resolve to (exact normalised name or curated alias, never fuzzy). These describe the corpus. They replace `listed_company_match_count`, which published the size of the matching SUBSTRATE — every listed company whose name COULD be matched — as though it were a count of companies found in the data. It read an order of magnitude high. (proto int32)

mpReturnCountinteger <int32>

The member layer, and why it is thin. A member with no row here has NOT been shown to have received nothing — most members never lodge this return. (proto int32)

mpReturnResolvedCountinteger <int32>

(proto int32)

nilCandidateReturnCountinteger <int32>

A lodged nil return is a publishable fact, not missing data. (proto int32)

partyReturnCountinteger <int32>

(proto int32)

receiptCountinteger <int32>

(proto int32)

coverageNotestring

what the member layer does and does not cover (proto string)

financialYearstring

the year actually served (proto string)

partiesarray

(proto shorts.v1alpha1.PartyFundingSummary)

Array Items:
reformNotestring

the 1 Jan 2027 scheme change / break annotation (proto string)

sourceLicencestring

'CC-BY-4.0' (proto string)

verbatimNotestring

figures are as lodged, amendments land continuously (proto string)

defaultError
application/json
object

Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation

codestring [canceled, unknown, invalid_argument, deadline_exceeded, not_found, already_exists, permission_denied, resource_exhausted, failed_precondition, aborted, out_of_range, unimplemented, internal, unavailable, data_loss, unauthenticated]

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

detailsarray

A list of messages that carry the error details. There is no limit on the number of messages.

Array Items:
messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

curl -X POST "https://api.shorted.com.au/shorts.v1alpha1.PoliticiansService/GetDonationsOverview" \
  -H "Content-Type: application/json" \
  -d '{
  "financialYear": "string",
  "limit": 0
}'