Skip to Content
Hey Town Hall Data docs
Money

API reference · Money

List financial statement lines

View as Markdown
GET
/v1/financial-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.

Authorization

bearerAuth
headerAuthorizationBearer <token>

htd_test_ (sandbox, free, fictional towns) or htd_live_ (live, billed) key.

Query Parameters

jurisdiction?string

A jurisdiction id.

Match^[a-z0-9][a-z0-9-]{0,63}$
kind?string

The statement, such as statement_of_operations.

Match^[a-z][a-z0-9_]{0,60}$
since?string

Records read at or after this instant: what is new since your last read.

report?string

A financial report id.

Match^[0-9]{1,18}$
limit?integer

Results a page, 1 to 100. Default 25.

cursor?string

next_cursor from the previous page.

Response Body

A page.

application/json
  1. response
query*

The filters as the API read them, defaults included.

as_of*string

ISO 8601 instant, UTC.

results*array<>
next_cursor*|

Pass as cursor for the next page; null on the last.

environment*string

sandbox answers carry fictional towns.

Value in"sandbox""live"
Example Request
curl -X GET 'https://data.heytownhall.com/v1/financial-lines'
Example Response
{  "query": {    "property1": null,    "property2": null  },  "as_of": "string",  "results": [    {      "id": "string",      "report_id": "string",      "jurisdiction_id": "string",      "fiscal_year": 0,      "statement": "string",      "seq": 0,      "col": 0,      "part": "string",      "section": "string",      "label": "string",      "label_plain": "string",      "detail": "string",      "heading": "string",      "role": "string",      "printed": "string",      "amount_cents": 0,      "page_printed": 0,      "source_url": "string",      "read_at": "string"    }  ],  "next_cursor": "string",  "environment": "sandbox"}

List budgets and financial statements GET

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.

List financial statements GET

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.