Skip to Content
Hey Town Hall Data docs

Records

Money

Budgets, audited financial statements and their lines, published fees, and open bids and tenders.

View as Markdown

Audited financial statements, read into lines. A statement is published only when its sums tie. Amounts are given as printed and in cents.

Budgets

Budget and financial statement documents as a government publishes them, with their links. They are documents, not budget data: the statement lines below are the audited numbers.

GET /v1/budgets

List budgets and financial statements. Budget and financial statement DOCUMENTS a government publishes (kind budget or financial_statement), with their links: documents, not budget data. The audited statements read into lines are GET /v1/financial-lines. Billed as one records request a page. Filters: jurisdiction, region, country, kind, from, to, since.

Reference and playground for list budgets and financial statements

Filters
ParameterWhat it takes
jurisdictionA jurisdiction id.
regionA two-letter province or state code.
countryCA or US.
kindbudget or financial_statement.
fromOn or after this date (YYYY-MM-DD).
toOn or before this date (YYYY-MM-DD).
sinceRecords read at or after this instant: what is new since your last read.

Pages with limit and cursor (pagination).

Fields of each result, GET /v1/budgets
FieldTypeWhat it holds
idstring
jurisdiction_idstring
countrystring or null
regionstring or null
kindstring or nullstaff_report, budget, plan, bylaw, agenda, minutes, notice, map, form, other.
titlestring or null
bylaw_numberstring or null
dated_onstring or nullYYYY-MM-DD.
text_availableboolean
last_changed_atstring or nullISO 8601 instant, UTC.
source_urlstring or nullThe page, document, video or platform the record was read from.
read_atstring or nullWhen it was read.

Financial statements

GET /v1/financial-reports

List financial statements. Audited financial statements read into lines, each statement published only when its sums tie. Billed as one records request a page. Filters: jurisdiction, region, country, since.

Reference and playground for list financial statements

Filters
ParameterWhat it takes
jurisdictionA jurisdiction id.
regionA two-letter province or state code.
countryCA or US.
sinceRecords read at or after this instant: what is new since your last read.

Pages with limit and cursor (pagination).

Fields of each result, GET /v1/financial-reports
FieldTypeWhat it holds
idstring
jurisdiction_idstring
countrystring or null
regionstring or null
fiscal_yearnumber
approved_onstring or nullYYYY-MM-DD.
auditorstring or null
page_countnumber or null
titlestring or null
source_urlstring or nullThe page, document, video or platform the record was read from.
read_atstring or nullWhen it was read.

Statement lines

Pass a statement's id as report to read its lines.

GET /v1/financial-lines

List financial statement lines. The lines of a statement, as printed and in cents. Never an employee by name. Billed as one records request a page. Filters: jurisdiction, kind, since, report.

Reference and playground for list financial statement lines

Filters
ParameterWhat it takes
jurisdictionA jurisdiction id.
kindThe statement, such as statement_of_operations.
sinceRecords read at or after this instant: what is new since your last read.
reportA financial report id.

Pages with limit and cursor (pagination).

Fields of each result, GET /v1/financial-lines
FieldTypeWhat it holds
idstring
report_idstring
jurisdiction_idstring
fiscal_yearnumber
statementstring
seqnumber
colnumber
partstring or null
sectionstring or null
labelstring or null
label_plainstring or null
detailstring or null
headingstring or null
rolestring or null
printedstring or nullThe figure as printed.
amount_centsnumber or null
page_printednumber or null
source_urlstring or nullThe page, document, video or platform the record was read from.
read_atstring or nullWhen it was read.

Fees

Each fee row a permit's fee page prints, the label and amount as printed, never parsed. A government's whole fees and charges schedule is a bylaw: see Laws.

GET /v1/fees

List published fees. Each fee row a permit's fee page prints, label and amount as printed. A body's full fees and charges schedule is a bylaw (GET /v1/bylaws?subject=fees_charges); its rows are in the bylaw's text, not here. Billed as one records request a page. Filters: jurisdiction, region, country, kind, since.

Reference and playground for list published fees

Filters
ParameterWhat it takes
jurisdictionA jurisdiction id.
regionA two-letter province or state code.
countryCA or US.
kindThe permit kind whose fee page prints the row, such as building.
sinceRecords read at or after this instant: what is new since your last read.

Pages with limit and cursor (pagination).

Fields of each result, GET /v1/fees
FieldTypeWhat it holds
idstring
jurisdiction_idstring
countrystring or null
regionstring or null
permit_kindstring
positionnumber
labelstring or nullThe row as the fee page prints it.
amount_printedstring or nullThe amount as printed, never parsed or summed.
fee_headingstring or null
fee_bylaw_numberstring or nullThe fees bylaw the page names, when it names one.
source_urlstring or nullThe page, document, video or platform the record was read from.
read_atstring or nullWhen it was read.

Bids and tenders

GET /v1/bids

List open bids and tenders. Open requests for proposals, tenders and quotes, with their closing time. Billed as one records request a page. Filters: jurisdiction, region, country, from, to, since.

Reference and playground for list open bids and tenders

Filters
ParameterWhat it takes
jurisdictionA jurisdiction id.
regionA two-letter province or state code.
countryCA or US.
fromOn or after this date (YYYY-MM-DD).
toOn or before this date (YYYY-MM-DD).
sinceRecords read at or after this instant: what is new since your last read.

Pages with limit and cursor (pagination).

Fields of each result, GET /v1/bids
FieldTypeWhat it holds
idstring
jurisdiction_idstring
countrystring or null
regionstring or null
titlestring
summarystring or null
published_atstring or nullISO 8601 instant, UTC.
closes_atstring or nullISO 8601 instant, UTC.
categoriesarray of string or null
first_seen_atstringISO 8601 instant, UTC.
source_urlstring or nullThe page, document, video or platform the record was read from.
read_atstring or nullWhen it was read.

On this page