Skip to Content
Hey Town Hall Data docs

Records

Laws

Bylaws, the terms they define, and the documents governments publish: staff reports, plans and notices.

View as Markdown

The bylaws a government adopts, and the documents it publishes on its own site. A document says whether its text is held.

Bylaws

Filter by subject for a bylaw's core subject; subject fees_charges is a fees and charges bylaw.

GET /v1/bylaws

List bylaws. Bylaws by number, title, kind and adoption date. Billed as one records request a page. Filters: jurisdiction, region, country, kind, subject, from, to, since.

Reference and playground for list bylaws

Filters
ParameterWhat it takes
jurisdictionA jurisdiction id.
regionA two-letter province or state code.
countryCA or US.
kindbylaw, amendment, consolidated, repeal.
subjectA bylaw's core subject, as the bylaw-subject model read its text. fees_charges is a body's fees and charges bylaw.
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/bylaws
FieldTypeWhat it holds
idstring
jurisdiction_idstring
countrystring or null
regionstring or null
numberstring or null
titlestring or null
kindstring or null
adopted_onstring or nullYYYY-MM-DD.
text_availableboolean
subjectstring or nullThe core subject its text regulates: zoning, building, animal_control, fire_burning, noise, trees, business_licence, fees_charges or other. Null: not yet read, or nothing says.
first_seen_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.

GET /v1/bylaws/{id}

Retrieve a bylaw. One bylaw. Billed as one records request.

Reference and playground for retrieve a bylaw

Path: {id} such as 123456.

Defined terms

The terms a government's bylaws define, such as "accessory building", each with the start of its definition as printed. Read them to learn a place's own word for a thing before you search.

GET /v1/defined-terms

List defined terms. The terms a body's bylaws define (an 'accessory building', a 'protected tree'), each with the start of its definition, as printed. Billed as one records request a page. Filters: jurisdiction, region, country, term, since.

Reference and playground for list defined terms

Filters
ParameterWhat it takes
jurisdictionA jurisdiction id.
regionA two-letter province or state code.
countryCA or US.
termWords in the defined term.
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/defined-terms
FieldTypeWhat it holds
idstring
jurisdiction_idstring
countrystring or null
regionstring or null
termstringAs the bylaw prints it.
definitionstringThe definition's first words, at most 400 characters, as printed.
source_urlstring or nullThe page, document, video or platform the record was read from.
read_atstring or nullWhen it was read.

Documents

For a meeting's agenda package, minutes and attachments, see meeting documents.

GET /v1/documents

List documents. The documents a government publishes on its own site, by kind (staff reports, budgets, plans, bylaws, notices), and whether their text is held. Billed as one records request a page. Filters: jurisdiction, region, country, kind, from, to, since.

Reference and playground for list documents

Filters
ParameterWhat it takes
jurisdictionA jurisdiction id.
regionA two-letter province or state code.
countryCA or US.
kindstaff_report, budget, plan, bylaw, agenda, minutes, notice, map, form, other.
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/documents
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.

On this page