Skip to Content
Hey Town Hall Data docs

Records

Search

One full-text search across agenda items, motions, transcripts, documents, bylaws and posts.

View as Markdown

Search finds where a subject has come up, newest first. Each hit names its family, its id, its jurisdiction and date, a snippet, and its source_url and read_at. Read the record itself from its family's endpoint.

Within a jurisdiction, a search covers every family. Without one, it covers transcripts, bylaws and posts for now; asking for agenda items, motions or documents without a jurisdiction answers 400 with param set to in. The query echo's in says which families were searched.

A search is billed on the search meter, not the records meter. See Billing.

Search the records

Search the records. One full-text search (English) across agenda items, motions, meeting transcripts, document and bylaw titles, and posts, newest first. Billed as one search request a page.

Reference and playground for search the records

Filters
ParameterWhat it takes
q (required)Words to find. Quotes keep a phrase; a leading minus leaves a word out (Postgres web search syntax).
inWhat to search, comma-separated: agenda_items, motions, transcripts, documents, bylaws, posts. Default all within a jurisdiction; without one, transcripts, bylaws, posts (agenda items, motions and documents need a jurisdiction for now).
jurisdictionA jurisdiction id.
regionA two-letter province or state code.
fromOn or after this date (YYYY-MM-DD).
toOn or before this date (YYYY-MM-DD).

Pages with limit and cursor (pagination).

Fields of each result, GET /v1/search
FieldTypeWhat it holds
familystring
idstring
jurisdiction_idstring
meeting_idstring or null
datestring or nullYYYY-MM-DD.
titlestring or null
snippetstring or null
source_urlstring or nullThe page, document, video or platform the record was read from.
read_atstring or nullWhen it was read.

On this page